com.adobe.livecycle.signatures.client.types
Class TransportOptionSpec

java.lang.Object
  com.adobe.livecycle.signatures.client.types.TransportOptionSpec

All Implemented Interfaces:

java.io.Serializable

public class TransportOptionSpec
extends java.lang.Object
implements java.io.Serializable

The TransportOptionSpec class specifies communication options that are required to interact with external servers.

See Also:

Serialized Form

Constructor Summary

TransportOptionSpec()
A constructor used to create a TransportOptionSpec object.

Method Summary

int	getConnectionTimeout() Returns the connection timeout value.
int	getMaxDownloadLimit() Gets the maximun number of downloads to allow.
java.lang.String	getProxyHost() Returns a proxy host.
java.lang.String	getProxyPassword() Returns the proxy password to use.
int	getProxyPort() Returns the port of the proxy server.
java.lang.String	getProxyUsername() Returns the user name for the proxy server.
int	getSocketTimeout() Returns the socket timeout value.
void	setConnectionTimeout(int connectionTimeout) Sets the period of time to wait before a connection timeout occurs.
void	setMaxDownloadLimit(int maxDownloadLimit) Sets the maximun number of downloads to allow.
void	setProxyHost(java.lang.String proxyHost) Sets the proxy host to use.
void	setProxyPassword(java.lang.String proxyPassword) Sets the proxy password to use.
void	setProxyPort(int proxyPort) Sets the port of the proxy server.
void	setProxyUsername(java.lang.String proxyUsername) Sets the user name for the proxy server.
void	setSocketTimeout(int socketTimeout) Sets the socket timeout value.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransportOptionSpec

public TransportOptionSpec()

A constructor used to create a TransportOptionSpec object.

Method Detail

getConnectionTimeout

public int getConnectionTimeout()

Returns the connection timeout value. The default time is 5 minutes.

Returns:

the connectionTimeout

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

Sets the period of time to wait before a connection timeout occurs.

Parameters:

connectionTimeout - The period of time to wait (in minutes) before a connection timeout occurs.

getMaxDownloadLimit

public int getMaxDownloadLimit()

Gets the maximun number of downloads to allow.

Returns:

The maximun number of downloads to allow.

setMaxDownloadLimit

public void setMaxDownloadLimit(int maxDownloadLimit)

Sets the maximun number of downloads to allow. The maximum download limit is 16.

Parameters:

maxDownloadLimit - The maximun number of downloads to allow.

getProxyHost

public java.lang.String getProxyHost()

Returns a proxy host.

Returns:

The proxy host that is used.

setProxyHost

public void setProxyHost(java.lang.String proxyHost)

Sets the proxy host to use.

Parameters:

proxyHost - The proxy host to use.

getProxyPassword

public java.lang.String getProxyPassword()

Returns the proxy password to use.

Returns:

The proxy password to use.

setProxyPassword

public void setProxyPassword(java.lang.String proxyPassword)

Sets the proxy password to use.

Parameters:

proxyPassword - The proxy password to use.

getProxyPort

public int getProxyPort()

Returns the port of the proxy server.

Returns:

The port of the proxy server.

setProxyPort

public void setProxyPort(int proxyPort)

Sets the port of the proxy server.

Parameters:

proxyPort - The port of the proxy server.

getProxyUsername

public java.lang.String getProxyUsername()

Returns the user name for the proxy server.

Returns:

The user name for the proxy server.

setProxyUsername

public void setProxyUsername(java.lang.String proxyUsername)

Sets the user name for the proxy server.

Parameters:

proxyUsername - The user name for the proxy server.

getSocketTimeout

public int getSocketTimeout()

Returns the socket timeout value.

Returns:

The socket timeout value.

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

Sets the socket timeout value. The default socket timeout value is 30.

Parameters:

socketTimeout - The socket timeout value to set.