SessionProperties (arjtk 3.11.4 API)

All Known Implementing Classes:

SessionManagerPropertiesImpl
```
public interface SessionProperties
```
Configure the behaviour and authentication sources of a Session.

Method Summary

All Methods Instance Methods Abstract Methods
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.
`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.
`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).
`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.
`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.

- Method Detail
  - getHostname
```
java.lang.String getHostname()
```
    The hostname of the EPP server.
  - getPort
```
int getPort()
```
    The port on which the EPP server listens (standard port is 700).
  - getClientID
```
java.lang.String getClientID()
```
    The client's username (clID in EPP terminology) as used in the EPP login command.
  - setClientID
```
void setClientID(java.lang.String id)
```
    Set the client's username (clID in EPP terminology) to be returned by further calls to getClientID.
  - getClientPW
```
java.lang.String getClientPW()
```
    The client's password (pw in EPP terminology) as used in the EPP login command.
  - setClientPW
```
void setClientPW(java.lang.String password)
```
    Set the password to be returned by further calls to getClientPW.
  - getVersion
```
java.lang.String getVersion()
```
    The protocol version of EPP to be used to communicate with the EPP server.
  - getLanguage
```
java.lang.String getLanguage()
```
    Request that the EPP server send any language-configurable messages in this language.
  - getObjURIs
```
java.lang.String[] getObjURIs()
```
    Request that the objects specified by these URIs be managable during the Session configured from these properties.
  - getExtURIs
```
java.lang.String[] getExtURIs()
```
    Request that the extensions specified by these URIs be available during the Session configured from these properties.
  - getKeyStoreFilename
```
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.
  - getKeyStorePassphrase
```
java.lang.String getKeyStorePassphrase()
```
    The passphrase used to protect the KeyStore identified by getKeyStoreFilename.
  - getKeyStoreType
```
java.lang.String getKeyStoreType()
```
    The type of the KeyStore. The two most common types are JKS (default) and PKCS12.
  - getTrustStoreFilename
```
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.
  - getTrustStorePassphrase
```
java.lang.String getTrustStorePassphrase()
```
    The passphrase used to protect the KeyStore identified by getTrustStoreFilename.
  - getSSLVersion
```
java.lang.String getSSLVersion()
```
    The SSL version to use. The default version is TLSv1.
  - getSSLAlgorithm
```
java.lang.String getSSLAlgorithm()
```
    The SSL key manager algorithm to use. The default algorithm for the Sun JRE is SunX509.
  - getCommandLimit
```
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).
  - getCommandLimit
```
int getCommandLimit()
```
    The maximum number of commands of any type to process in a single session over a short period of time (default: infinity ).
  - getCommandLimitInterval
```
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).
  - getAcquireTimeout
```
long getAcquireTimeout()
```
    The maximum duration of time (specified in milliseconds) to wait when acquiring a session.
  - getSocketTimeout
```
int getSocketTimeout()
```
    The maximum length of time (specified in milliseconds) to wait for data to become available on the underlying socket when reading.
  - enforceStrictValidation
```
boolean enforceStrictValidation()
```
    Enforce strict validation of incoming and outgoing service elements. The purpose of strict validation is to detect service element errors prior to transmission.
  - needOutputNamespacePrefixInXml
```
boolean needOutputNamespacePrefixInXml()
```
    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.
    Returns:
    
    a boolean flag where true means XML output will have namespace prefix

Interface SessionProperties

Method Summary

Method Detail

getHostname

getPort

getClientID

setClientID

getClientPW

setClientPW

getVersion

getLanguage

getObjURIs

getExtURIs

getKeyStoreFilename

getKeyStorePassphrase

getKeyStoreType

getTrustStoreFilename

getTrustStorePassphrase

getSSLVersion

getSSLAlgorithm

getCommandLimit

getCommandLimit

getCommandLimitInterval

getAcquireTimeout

getSocketTimeout

enforceStrictValidation

needOutputNamespacePrefixInXml