Class EPPSystemSessionPool


  • public class EPPSystemSessionPool
    extends java.lang.Object
    EPP session pool for a specific system name that will handle creating sessions dynamically, expiring session after an absolute timeout, keeping sessions alive based on an idle timeout, and dynamically grows and shrinks the pool based on configurable settings. One of the init methods must be called before useing the pool. The init() method uses configuration settings defined in the Environment class. The Environment settings include the following based on the system name defined by <system>:

    • EPP.SessionPool.&lt;system&gt;.poolableClassName - (required) EPPSessionPoolableFactory class used by the pool.
    • EPP.SessionPool.&lt;system&gt;.clientId - (required) Login name
    • EPP.SessionPool.&lt;system&gt;.password - (required) password
    • EPP.SessionPool.&lt;system&gt;.serverName - Name or IP address of TCP server or URL of HTTP server
    • EPP.SessionPool.&lt;system&gt;.serverPort - (optional) TCP server port number. This is not used for a HTTP server connection
    • EPP.SessionPool.&lt;system&gt;.absoluteTimeout - (optional) Session absolute timeout. Default is 24 hours.
    • EPP.SessionPool.&lt;system&gt;.minAbsoluteTimeout - Session minimum absolute timeout. If both minAbsoluteTimeout and maxAbsoluteTimeout is set, it will override absoluteTimeout and randomize the session absolute timeout between the minAbsoluteTimeout and maxAbsoluteTimeout.
    • EPP.SessionPool.&lt;system&gt;.maxAbsoluteTimeout - Session maximum absolute timeout. If both minAbsoluteTimeout and maxAbsoluteTimeout is set, it will override absoluteTimeout and randomize the session absolute timeout between the minAbsoluteTimeout and maxAbsoluteTimeout.
    • EPP.SessionPool.&lt;system&gt;.idleTimeout - (optional) Session idle timeout used to determine when keep alive messages are sent. Default is 10 minutes.
    • EPP.SessionPool.&lt;system&gt;.maxIdle - (optional) Maximum number of idle sessions in pool. Default is 10.
    • EPP.SessionPool.&lt;system&gt;.initMaxTotal - (optional) Boolean value indicating if the maxTotal sessions should be pre-initialized at initialization in the init() method. Default is false.
    • EPP.SessionPool.&lt;system&gt;.maxTotal - (optional) Maximum number of active sessions in pool. Default is 10.
    • EPP.SessionPool.&lt;system&gt;.maxWait - (optional) Maximum time in milliseconds for a client to block waiting for a pooled session. Default is 60 seconds.
    • EPP.SessionPool.&lt;system&gt;.minIdle - (optional) Minimum number of idle sessions in the pool. Default is 0.
    • EPP.SessionPool.&lt;system&gt;.timeBetweenEvictionRunsMillis - (optional) Frequency in milliseconds of scanning the pool for idle and absolute timeout sessions. Default is 60 seconds.
    • EPP.SessionPool.&lt;system&gt;.borrowRetries - (optional) Number of retries to get/create a session when calling borrowObject(). Default is 0.
    • EPP.SessionPool.&lt;system&gt;.SSLProtocol - (optional) SSL protocol to use. If defined the pool will have its own SSL configuration. The required SSL properties include SSLKeyStore, SSLKeyFileName, and SSLKeyPassPhrase
    • EPP.SessionPool.&lt;system&gt;.SSLKeyStore - (optional) Type of identity KeyStore. Required if SSLProtocol is defined for pool.
    • EPP.SessionPool.&lt;system&gt;.SSLKeyFileName - (optional) Name of the identity KeyStore file. Required if SSLProtocol is defined for pool.
    • EPP.SessionPool.&lt;system&gt;.SSLPassPhrase - (optional) The passphrase/password to access the identity KeyStore file defined by SSLKeyFileName. Required if SSLProtocol is defined for pool.
    • EPP.SessionPool.&lt;system&gt;.SSLKeyPassPhrase - (optional) the passphrase/password for the private key stored in the identity KeyStore.
    • EPP.SessionPool.&lt;system&gt;.SSLTrustStore - (optional) KeyStore type of the Trust Store
    • EPP.SessionPool.&lt;system&gt;.SSLTrustStoreFileName - (optional) The name of the Trust Store file. If not defined for the pool, the default JDK Trust Store will be used that is located at the path $JAVA_HOME/lib/security/cacerts.
    • EPP.SessionPool.&lt;system&gt;.SSLTrustStorePassPhrase - (optional) The passphrase/password to access the Trust Store file defined by the pool SSLTrustStoreFileName property.
    • EPP.SessionPool.&lt;system&gt;.SSLEnabledProtocols - (optional) The space delimited list of enabled SSL protocols.
    • EPP.SessionPool.&lt;system&gt;.SSLEnabledCipherSuites - (optional) The space delimited list of SSL cipher suites.
    • EPP.SessionPool.&lt;system&gt;.SSLDebug - (optional) Defines the SSL debug Java system property javax.net.debug value.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      EPPSession borrowObject()
      Borrows a session from the pool.
      void close()
      Closes the session pool contained in EPPSystemSessionPool cleanly.
      long getAbsoluteTimeout()
      Gets the session absolute timeout.
      java.lang.String getClientHost()
      Gets the TCP server IP address or host name to connect from.
      java.lang.String getClientId()
      Gets the client identifier used to authenticate.
      org.apache.commons.pool2.impl.GenericObjectPoolConfig<EPPPooledGenericSession> getConfig()
      Gets the configuration for the GenericObjectPool<EPPPooledGenericSession>.
      EPPSessionPoolableFactory getFactory()
      Gets the factory associated with the pool.
      org.apache.commons.pool2.impl.GenericObjectPool<EPPPooledGenericSession> getGenericObjectPool()
      Gets the contained GenericObjectPool<EPPPooledGenericSession>.
      long getIdleTimeout()
      Gets the session idle timeout.
      java.lang.String getPassword()
      Gets the password used for authentication.
      java.lang.String getServerName()
      Gets the TCP server IP address or host name, or the URL of the HTTP server.
      java.lang.Integer getServerPort()
      Gets the TCP server port number.
      java.lang.String getSystem()
      Gets the system name associated with this pool.
      void init()
      Initialize the pool using configuration values defined by Environment class.
      void init​(EPPSessionPoolableFactory aFactory, org.apache.commons.pool2.impl.GenericObjectPoolConfig<EPPPooledGenericSession> aConfig)
      Initialize the pool with a specific EPPSessionPoolableFactory and GenericObjectPoolConfig<EPPPooledGenericSession> setting.
      void invalidateObject​(EPPSession aSession)
      Remove a borrowed session from the pool based on a known issue with it.
      void returnObject​(EPPSession aSession)
      Returned a borrowed session to the pool.
      void setClientHost​(java.lang.String aClientHost)
      Sets the TCP server IP address or host name to connect from.
      void setServerName​(java.lang.String aServerName)
      Sets the TCP server IP address or host name or the URL of the HTTP server.
      void setServerPort​(java.lang.Integer aServerPort)
      Sets the TCP server port number.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • DEFAULT_ABSOLUTE_TIMEOUT

        public static final long DEFAULT_ABSOLUTE_TIMEOUT
        The default session absolute timeout.
        See Also:
        Constant Field Values
      • DEFAULT_IDLE_TIMEOUT

        public static final long DEFAULT_IDLE_TIMEOUT
        The default session absolute timeout.
        See Also:
        Constant Field Values
      • DEFAULT_MAX_WAIT

        public static final long DEFAULT_MAX_WAIT
        The default maximum amount of time (in millis) the borrowObject() method should block before throwing an exception.
        See Also:
        Constant Field Values
      • DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS

        public static final long DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS
        The default "time between eviction runs" value.
        See Also:
        Constant Field Values
      • DEFAULT_MAX_IDLE

        public static final int DEFAULT_MAX_IDLE
        The default cap on the number of "sleeping" instances in the pool.
        See Also:
        Constant Field Values
      • DEFAULT_MAX_TOTAL

        public static final int DEFAULT_MAX_TOTAL
        The default cap on the total number of instances for the pool.
        See Also:
        Constant Field Values
      • DEFAULT_MIN_IDLE

        public static final int DEFAULT_MIN_IDLE
        The default minimum number of "sleeping" instances in the pool before before the evictor thread (if active) spawns new objects.
        See Also:
        Constant Field Values
    • Method Detail

      • init

        public void init​(EPPSessionPoolableFactory aFactory,
                         org.apache.commons.pool2.impl.GenericObjectPoolConfig<EPPPooledGenericSession> aConfig)
        Initialize the pool with a specific EPPSessionPoolableFactory and GenericObjectPoolConfig<EPPPooledGenericSession> setting.
        Parameters:
        aFactory - EPP session poolable object factory
        aConfig - Configuration attributes for pool
      • close

        public void close()
        Closes the session pool contained in EPPSystemSessionPool cleanly. Cleanly closing the pool means clearing the pool that will execute an EPP logout for each of the idle sessions and close the pool.
      • invalidateObject

        public void invalidateObject​(EPPSession aSession)
                              throws EPPSessionPoolException
        Remove a borrowed session from the pool based on a known issue with it. The should be done if an unexpected exception occurs with the session which might be due to the server being down or the session being expired. ;
        Parameters:
        aSession - Session that is invalid
        Throws:
        EPPSessionPoolException - On error
      • getGenericObjectPool

        public org.apache.commons.pool2.impl.GenericObjectPool<EPPPooledGenericSession> getGenericObjectPool()
        Gets the contained GenericObjectPool<EPPPooledGenericSession>.
        Returns:
        Contained GenericObjectPool<EPPPooledGenericSession>
      • getAbsoluteTimeout

        public long getAbsoluteTimeout()
        Gets the session absolute timeout.
        Returns:
        Returns the absolute timeout in milliseconds.
      • getClientId

        public java.lang.String getClientId()
        Gets the client identifier used to authenticate.
        Returns:
        Returns the client identifier.
      • getConfig

        public org.apache.commons.pool2.impl.GenericObjectPoolConfig<EPPPooledGenericSession> getConfig()
        Gets the configuration for the GenericObjectPool<EPPPooledGenericSession>.
        Returns:
        Returns the config.
      • getFactory

        public EPPSessionPoolableFactory getFactory()
        Gets the factory associated with the pool.
        Returns:
        Returns the factory.
      • getIdleTimeout

        public long getIdleTimeout()
        Gets the session idle timeout.
        Returns:
        Returns the idle timeout in milliseconds.
      • getPassword

        public java.lang.String getPassword()
        Gets the password used for authentication.
        Returns:
        Returns the password.
      • getSystem

        public java.lang.String getSystem()
        Gets the system name associated with this pool.
        Returns:
        Pool system name
      • getServerName

        public java.lang.String getServerName()
        Gets the TCP server IP address or host name, or the URL of the HTTP server.
        Returns:
        Server host name, IP address, or URL
      • setServerName

        public void setServerName​(java.lang.String aServerName)
        Sets the TCP server IP address or host name or the URL of the HTTP server.
        Parameters:
        aServerName - Server host name, IP address, or URL
      • getServerPort

        public java.lang.Integer getServerPort()
        Gets the TCP server port number. This will be null if connecting to a HTTP server.
        Returns:
        TCP server port number if defined; null otherwise.
      • setServerPort

        public void setServerPort​(java.lang.Integer aServerPort)
        Sets the TCP server port number.
        Parameters:
        aServerPort - TCP server port number
      • getClientHost

        public java.lang.String getClientHost()
        Gets the TCP server IP address or host name to connect from. A null value will use the loop back.
        Returns:
        Client host name or IP address if defined;null otherwise.
      • setClientHost

        public void setClientHost​(java.lang.String aClientHost)
        Sets the TCP server IP address or host name to connect from. A null value will use the loop back.
        Parameters:
        aClientHost - Client host name or IP address