Package org.identityconnectors.framework.api

Class RemoteFrameworkConnectionInfo

java.lang.Object
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 Details

    • 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;

    • RemoteFrameworkConnectionInfo

      public RemoteFrameworkConnectionInfo(String host, int port, GuardedString key, boolean useSSL, List<TrustManager> trustManagers, int timeout, long heartbeatInterval)
      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;
      heartbeatInterval - The connection check interval to use (in seconds). A value of 0 means the default 60 seconds.
      Since:
      1.5

  • Method Details

    • 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 if we are to use SSL to connect.
      Returns:
      true if 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.

    • getHeartbeatInterval

      public long getHeartbeatInterval()
      Returns the heartbeat interval (in seconds) to use for the connection. A value of zero means default 60 seconds timeout.
      Returns:
      the heartbeat interval (in seconds) 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