com.ausregistry.jtoolkit2.session

Class SessionManagerPropertiesImpl

java.lang.Object

com.ausregistry.jtoolkit2.session.SessionManagerPropertiesImpl

All Implemented Interfaces:

SessionManagerProperties, SessionPoolProperties, SessionProperties

public class SessionManagerPropertiesImpl
extends java.lang.Object
implements SessionManagerProperties, SessionPoolProperties, SessionProperties

A SessionManager is configured based on a SessionManagerProperties instance. This class loads properties from a properties file and presents a guaranteed minimum set of properties to be available to the SessionManager and its SessionPool.

Constructor Summary

Constructors

Constructor and Description
SessionManagerPropertiesImpl() Instantiate a SessionManagerProperties implementation using the default properties file location.
SessionManagerPropertiesImpl(java.lang.String propertiesFile) Create a SessionManagerPropertiesImpl using the specified properties file.

Method Summary

Modifier and Type	Method and Description
boolean	enforceStrictValidation() Enforce strict validation of incoming and outgoing service elements.
long	getAcquireTimeout() The maximum duration of time (specified in milliseconds) to wait when acquiring a session.
java.lang.String	getClientID() The client's username (clID in EPP terminology) as used in the EPP login command.
java.lang.String	getClientPW() The client's password (pw in EPP terminology) as used in the EPP login command.
long	getClientTimeout() Get the session idle time (in milliseconds) after which the keep-alive feature will allow sessions in the pool to be dropped (will no longer poll).
int	getCommandLimit() The maximum number of commands of any type to process in a single session over a short period of time (default: infinity ).
int	getCommandLimit(CommandType type) The maximum number of commands of the given type to process in a single session over a short period of time (default: infinity).
long	getCommandLimitInterval() The time interval, in milliseconds, over which a command is considered recent for the purposes of session-specific command limiting (default: 1 second = 1000 ms).
java.lang.String[]	getExtURIs() Request that the extensions specified by these URIs be available during the Session configured from these properties.
java.lang.String	getHostname() The hostname of the EPP server.
java.lang.String	getKeyStoreFilename() The location of the KeyStore file from which private key and public certificate data will be read in order to establish a connection with the EPP server.
java.lang.String	getKeyStorePassphrase() The passphrase used to protect the KeyStore identified by getKeyStoreFilename.
java.lang.String	getKeyStoreType() The type of the KeyStore.
java.lang.String	getLanguage() Request that the EPP server send any language-configurable messages in this language.
int	getMaximumPoolSize() Get the maximum number of sessions allowed in the pool.
java.lang.String[]	getObjURIs() Request that the objects specified by these URIs be managable during the Session configured from these properties.
int	getPort() The port on which the EPP server listens (standard port is 700).
long	getServerTimeout() Get the configured time interval (in milliseconds) after which the EPP server will close idle connections.
SessionPoolProperties	getSessionPoolProperties()
SessionProperties	getSessionProperties()
int	getSocketTimeout() The maximum length of time (specified in milliseconds) to wait for data to become available on the underlying socket when reading.
java.lang.String	getSSLAlgorithm() The SSL key manager algorithm to use.
java.lang.String	getSSLVersion() The SSL version to use.
java.lang.String	getTrustStoreFilename() The location of the KeyStore file from which Certification Authority data will be read in order to verify the authenticity of the key in the accompanying user keystore.
java.lang.String	getTrustStorePassphrase() The passphrase used to protect the KeyStore identified by getTrustStoreFilename.
java.lang.String	getVersion() The protocol version of EPP to be used to communicate with the EPP server.
long	getWaitTimeout() The maximum time for configured objects to spend in wait() for any relevant condition, such as session acquisition or release.
boolean	needOutputNamespacePrefixInXml() Enforce XML output to include namespace prefix.
void	setClientID(java.lang.String id) Set the client's username (clID in EPP terminology) to be returned by further calls to getClientID.
void	setClientPW(java.lang.String password) Set the password to be returned by further calls to getClientPW.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionManagerPropertiesImpl

public SessionManagerPropertiesImpl()
                             throws java.io.IOException,
                                    java.io.FileNotFoundException

Instantiate a SessionManagerProperties implementation using the default properties file location.

Throws:

java.io.IOException

java.io.FileNotFoundException

SessionManagerPropertiesImpl

public SessionManagerPropertiesImpl(java.lang.String propertiesFile)
                             throws java.io.IOException,
                                    java.io.FileNotFoundException

Create a SessionManagerPropertiesImpl using the specified properties file.

Throws:

java.io.IOException

java.io.FileNotFoundException

Method Detail

getSessionPoolProperties

public SessionPoolProperties getSessionPoolProperties()

Specified by:

getSessionPoolProperties in interface SessionManagerProperties

getSessionProperties

public SessionProperties getSessionProperties()

Specified by:

getSessionProperties in interface SessionManagerProperties

getHostname

public java.lang.String getHostname()

Description copied from interface: SessionProperties

The hostname of the EPP server.

Specified by:

getHostname in interface SessionProperties

getPort

public int getPort()

Description copied from interface: SessionProperties

The port on which the EPP server listens (standard port is 700).

Specified by:

getPort in interface SessionProperties

getClientID

public java.lang.String getClientID()

Description copied from interface: SessionProperties

The client's username (clID in EPP terminology) as used in the EPP login command.

Specified by:

getClientID in interface SessionProperties

getClientPW

public java.lang.String getClientPW()

Description copied from interface: SessionProperties

The client's password (pw in EPP terminology) as used in the EPP login command.

Specified by:

getClientPW in interface SessionProperties

getVersion

public java.lang.String getVersion()

Description copied from interface: SessionProperties

The protocol version of EPP to be used to communicate with the EPP server.

Specified by:

getVersion in interface SessionProperties

getLanguage

public java.lang.String getLanguage()

Description copied from interface: SessionProperties

Request that the EPP server send any language-configurable messages in this language.

Specified by:

getLanguage in interface SessionProperties

getObjURIs

public java.lang.String[] getObjURIs()

Description copied from interface: SessionProperties

Request that the objects specified by these URIs be managable during the Session configured from these properties.

Specified by:

getObjURIs in interface SessionProperties

getExtURIs

public java.lang.String[] getExtURIs()

Description copied from interface: SessionProperties

Request that the extensions specified by these URIs be available during the Session configured from these properties.

Specified by:

getExtURIs in interface SessionProperties

getKeyStoreFilename

public java.lang.String getKeyStoreFilename()

Description copied from interface: SessionProperties

The location of the KeyStore file from which private key and public certificate data will be read in order to establish a connection with the EPP server.

Specified by:

getKeyStoreFilename in interface SessionProperties

getKeyStorePassphrase

public java.lang.String getKeyStorePassphrase()

Description copied from interface: SessionProperties

The passphrase used to protect the KeyStore identified by getKeyStoreFilename.

Specified by:

getKeyStorePassphrase in interface SessionProperties

getKeyStoreType

public java.lang.String getKeyStoreType()

Description copied from interface: SessionProperties

The type of the KeyStore. The two most common types are JKS (default) and PKCS12.

Specified by:

getKeyStoreType in interface SessionProperties

getTrustStoreFilename

public java.lang.String getTrustStoreFilename()

Description copied from interface: SessionProperties

The location of the KeyStore file from which Certification Authority data will be read in order to verify the authenticity of the key in the accompanying user keystore.

Specified by:

getTrustStoreFilename in interface SessionProperties

getTrustStorePassphrase

public java.lang.String getTrustStorePassphrase()

Description copied from interface: SessionProperties

The passphrase used to protect the KeyStore identified by getTrustStoreFilename.

Specified by:

getTrustStorePassphrase in interface SessionProperties

getSSLVersion

public java.lang.String getSSLVersion()

Description copied from interface: SessionProperties

The SSL version to use. The default version is TLSv1.

Specified by:

getSSLVersion in interface SessionProperties

getSSLAlgorithm

public java.lang.String getSSLAlgorithm()

Description copied from interface: SessionProperties

The SSL key manager algorithm to use. The default algorithm for the Sun JRE is SunX509.

Specified by:

getSSLAlgorithm in interface SessionProperties

getCommandLimit

public int getCommandLimit()

Description copied from interface: SessionProperties

The maximum number of commands of any type to process in a single session over a short period of time (default: infinity ).

Specified by:

getCommandLimit in interface SessionProperties

getCommandLimit

public int getCommandLimit(CommandType type)

Description copied from interface: SessionProperties

The maximum number of commands of the given type to process in a single session over a short period of time (default: infinity).

Specified by:

getCommandLimit in interface SessionProperties

getCommandLimitInterval

public long getCommandLimitInterval()

Description copied from interface: SessionProperties

The time interval, in milliseconds, over which a command is considered recent for the purposes of session-specific command limiting (default: 1 second = 1000 ms).

Specified by:

getCommandLimitInterval in interface SessionProperties

getMaximumPoolSize

public int getMaximumPoolSize()

Description copied from interface: SessionPoolProperties

Get the maximum number of sessions allowed in the pool.

Specified by:

getMaximumPoolSize in interface SessionPoolProperties

getWaitTimeout

public long getWaitTimeout()

Description copied from interface: SessionPoolProperties

The maximum time for configured objects to spend in wait() for any relevant condition, such as session acquisition or release.

Specified by:

getWaitTimeout in interface SessionPoolProperties

getServerTimeout

public long getServerTimeout()

Description copied from interface: SessionPoolProperties

Get the configured time interval (in milliseconds) after which the EPP server will close idle connections.

Specified by:

getServerTimeout in interface SessionPoolProperties

getClientTimeout

public long getClientTimeout()

Description copied from interface: SessionPoolProperties

Get the session idle time (in milliseconds) after which the keep-alive feature will allow sessions in the pool to be dropped (will no longer poll).

Specified by:

getClientTimeout in interface SessionPoolProperties

getAcquireTimeout

public long getAcquireTimeout()

Description copied from interface: SessionProperties

The maximum duration of time (specified in milliseconds) to wait when acquiring a session.

Specified by:

getAcquireTimeout in interface SessionProperties

getSocketTimeout

public int getSocketTimeout()

Description copied from interface: SessionProperties

The maximum length of time (specified in milliseconds) to wait for data to become available on the underlying socket when reading.

Specified by:

getSocketTimeout in interface SessionProperties

enforceStrictValidation

public boolean enforceStrictValidation()

Description copied from interface: SessionProperties

Enforce strict validation of incoming and outgoing service elements. The purpose of strict validation is to detect service element errors prior to transmission.

Specified by:

enforceStrictValidation in interface SessionProperties

needOutputNamespacePrefixInXml

public boolean needOutputNamespacePrefixInXml()

Description copied from interface: SessionProperties

Enforce XML output to include namespace prefix.

A namespace prefix is considered in-scope on the declaration element as well as on any of its descendant elements. Once declared, the prefix can be used in front of any element or attribute name separated by a colon (such as s:student).

This complete name including the prefix is the lexical form of a qualified name (QName):

     QName = <prefix>:<local name>
 

If not configured, the default value will be false.

Specified by:

needOutputNamespacePrefixInXml in interface SessionProperties

Returns:

a boolean flag where true means XML output will have namespace prefix

setClientPW

public void setClientPW(java.lang.String password)

Description copied from interface: SessionProperties

Set the password to be returned by further calls to getClientPW.

Specified by:

setClientPW in interface SessionProperties

setClientID

public void setClientID(java.lang.String id)

Description copied from interface: SessionProperties

Set the client's username (clID in EPP terminology) to be returned by further calls to getClientID.

Specified by:

setClientID in interface SessionProperties