com.filenet.download.api

Class ServerConnectionData

java.lang.Object

com.filenet.download.api.ServerConnectionData

public class ServerConnectionData
extends java.lang.Object

Represents the metadata required to connect to the Client Download Servlet. Use the factory methods getHttpConnectionData() or getHttpsConnectionData() to create instances of this class. A ServerConnectionData object is used by methods that connect to the Client Download Servlet, such as ServerVersion.fetchInstance().

Method Summary

Modifier and Type	Method and Description
static ServerConnectionData	getHttpConnectionData(java.lang.String serverName, java.lang.String port) Factory method used to create an instance of this class to be used for connecting to the Client Download Servlet via the HTTP protocol.
static ServerConnectionData	getHttpsConnectionData(java.lang.String serverName, java.lang.String port, boolean validateServerCert) Factory method used to create an instance of this class to be used for connecting to the Client Download Servlet via the HTTPS protocol, that is, using SSL.
java.lang.String	getPort() Returns the port number used by an instance of ServerConnectionData.
Protocol	getProtocol() Returns the protocol used by an instance of ServerConnectionData.
java.lang.String	getServerName() Returns the server name used by an instance of ServerConnectionData.
boolean	getValidateCertificate() Returns a value that indicates whether this instance of ServerConnectionData will enforce server certificate validation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getHttpConnectionData

public static ServerConnectionData getHttpConnectionData(java.lang.String serverName,
                                                         java.lang.String port)

Factory method used to create an instance of this class to be used for connecting to the Client Download Servlet via the HTTP protocol.

Parameters:

serverName - A String that represents the name of the server on which the Client Download Servlet is installed.

port - A String that specifies the HTTP port number for connecting to the Client Download Servlet.

getHttpsConnectionData

public static ServerConnectionData getHttpsConnectionData(java.lang.String serverName,
                                                          java.lang.String port,
                                                          boolean validateServerCert)

Factory method used to create an instance of this class to be used for connecting to the Client Download Servlet via the HTTPS protocol, that is, using SSL.

Parameters:

serverName - A String that represents the name of the server on which the Client Download Servlet is installed.

port - A String that specifies the HTTPS port for connecting to the Client Download Servlet.

validateServerCert - A boolean argument that specifies whether or not the Client Download Java API will perform server certificate validation. Use true to enforce server certificate validation. Otherwise, use false to bypass server certificate validation.

If the server certificate is not stored in the client's JVM keystore database, then subsequent calls to the servlet will result in a Java runtime exception.

getProtocol

public Protocol getProtocol()

Returns the protocol used by an instance of ServerConnectionData.

Returns:

A Protocol enum representing either the HTTP or HTTPS protocol.

getPort

public java.lang.String getPort()

Returns the port number used by an instance of ServerConnectionData.

Returns:

A String representing the HTTP or HTTPS port number.

getServerName

public java.lang.String getServerName()

Returns the server name used by an instance of ServerConnectionData.

Returns:

A String with the server name.

getValidateCertificate

public boolean getValidateCertificate()

Returns a value that indicates whether this instance of ServerConnectionData will enforce server certificate validation. The value returned by this method is only applicable when using the HTTPS protocol.

Returns:

A boolean that, when true, indicates that server certificate validation will be enforced, and, when false, indicates that server certificate validation will not be performed.