org.identityconnectors.framework.api
Class RemoteFrameworkConnectionInfo

java.lang.Object
  extended by org.identityconnectors.framework.api.RemoteFrameworkConnectionInfo

public final class RemoteFrameworkConnectionInfo
extends Object

Encapsulates all the connection information used to connect to a remote instance of the connector framework.


Constructor Summary
RemoteFrameworkConnectionInfo(String host, int port, GuardedString key)
          Creates a new instance of RemoteFrameworkConnectionInfo, using a clear (non-ssl) connection and a 60-second timeout.
RemoteFrameworkConnectionInfo(String host, int port, GuardedString key, boolean useSSL, List<TrustManager> trustManagers, int timeout)
          Creates a new instance of RemoteFrameworkConnectionInfo.
 
Method Summary
 boolean equals(Object o)
          
 String getHost()
          Returns the host to connect to.
 GuardedString getKey()
          Returns the remote framework key
 int getPort()
          Returns the port to connect to
 int getTimeout()
          Returns the timeout (in milliseconds) to use for the connection.
 List<TrustManager> getTrustManagers()
          Returns the list of TrustManager's. to use when establishing the connection.
 boolean getUseSSL()
          Returns true iff we are to use SSL to connect.
 int hashCode()
          
 String toString()
          
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RemoteFrameworkConnectionInfo

public RemoteFrameworkConnectionInfo(String host,
                                     int port,
                                     GuardedString key)
Creates a new instance of RemoteFrameworkConnectionInfo, using a clear (non-ssl) connection and a 60-second timeout.

Parameters:
host - The host to connect to
port - The port to connect to
key - The remote framework key

RemoteFrameworkConnectionInfo

public RemoteFrameworkConnectionInfo(String host,
                                     int port,
                                     GuardedString key,
                                     boolean useSSL,
                                     List<TrustManager> trustManagers,
                                     int timeout)
Creates a new instance of RemoteFrameworkConnectionInfo.

Parameters:
host - The host to connect to
port - The port to connect to
key - The remote framework key
useSSL - Set to true if we are to connect via SSL.
trustManagers - List of TrustManager's to use for establising the SSL connection. May be null or empty, in which case the default installed providers for the JVM will be used. Ignored if 'useSSL' is false.
timeout - The timeout to use (in milliseconds). A value of 0 means infinite timeout;
Method Detail

getHost

public String getHost()
Returns the host to connect to.

Returns:
The host to connect to.

getPort

public int getPort()
Returns the port to connect to

Returns:
The port to connect to

getKey

public GuardedString getKey()
Returns the remote framework key

Returns:
the remote framework key

getUseSSL

public boolean getUseSSL()
Returns true iff we are to use SSL to connect.

Returns:
true iff we are to use SSL to connect.

getTrustManagers

public List<TrustManager> getTrustManagers()
Returns the list of TrustManager's. to use when establishing the connection.

Returns:
The list of TrustManager's.

getTimeout

public int getTimeout()
Returns the timeout (in milliseconds) to use for the connection. A value of zero means infinite timeout.

Returns:
the timeout (in milliseconds) to use for the connection.

equals

public boolean equals(Object o)

Overrides:
equals in class Object

hashCode

public int hashCode()

Overrides:
hashCode in class Object

toString

public String toString()

Overrides:
toString in class Object


Copyright © 2012. All Rights Reserved.