TLSSession (arjtk 3.11.4 API)

java.lang.Object
- com.ausregistry.jtoolkit2.session.TLSSession

All Implemented Interfaces:

Session, StatsManager, StatsViewer
```
public class TLSSession
extends java.lang.Object
implements Session, StatsManager
```
RFC5734 specifies a transport mapping for EPP over TCP; this class implements that mapping. That specification requires that the session is layered over TLS (Transport Layer Security). This class complies with RFC5734 in implementing the Session interface. It also implements its own StatsManager since it is tightly coupled with the Session implementation.

Uses the debug, support and user level loggers.

Constructor Summary

Constructors
Modifier Constructor and Description

protected TLSSession()

protected TLSSession(SessionProperties props)

Constructors
Modifier	Constructor and Description
`protected`	`TLSSession()`
`protected`	`TLSSession(SessionProperties props)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acquire()` Acquire the session for exclusive use.
`void`	`changePassword(java.lang.String newPassword)` Change the client password to the given value.
`void`	`close()` EPP sessions are closed cleanly by sending an EPP logout command, awaiting a response from the server, then acknowledging the close of the underlying transport mechanism initiated by the server upon completion of sending the logout response.
`void`	`configure(SessionProperties properties)` Configure the session as described in the Session interface.
`long`	`getAverageResponseTime()` Get the average response time (in milliseconds) of all transactions.
`long`	`getAverageResponseTime(CommandType type)` Get the average response time (in milliseconds) of transactions of the given command type.
`long`	`getCommandCount()` Get the number of commands of the given type that the Session(s) associated with this viewer has/have processed since creation.
`long`	`getCommandCount(CommandType type)` Get the total number of commands processed by Sessions associated with this StatsViewer.
`Greeting`	`getGreeting()` EPP service discovery is implemented by the greeting service element.
`long`	`getMruInterval()` Get the length of time (in milliseconds) since the most recent use (mru) of the session.
`int`	`getRecentCommandCount()` Get the number of commands of the given type that the Session(s) associated with this viewer has/have processed recently (default: 1 second).
`int`	`getRecentCommandCount(CommandType type)` Get the total number of commands recently processed by Sessions associated with this StatsViewer.
`long`	`getResultCodeCount(int resultCode)` Get the number of responses received having the given result code.
`StatsManager`	`getStatsManager()` Get the StatsManager as described in the class documentation.
`void`	`incCommandCounter(CommandType type)` Increment the command count for the given command type.
`void`	`incResultCounter(int resultCode)` Increment the result count for the given code.
`boolean`	`isAvailable()` Determine whether a call to `acquire` would block.
`boolean`	`isInvalid()` Determine whether a call to read or write would result in an IOException.
`boolean`	`isOpen()` Determine whether a call to open has previously succeeded.
`void`	`keepAlive()` Send a poll command to the EPP server in order to prevent the session timing out.
`void`	`open()` * An EPP session is opened by first establishing a connection using the server location information and authentication sources provided in `configure`, then issuing a login command with further authentication data and options provided in `configure`.
`java.lang.String`	`read()` Receive data from the peer.
`void`	`read(Response response)` Read a single EPP service element from the transport layer and assign values to the attributes of the given Response instance appropriately, according to the received XML document content.
`XMLDocument`	`readToDocument()` Read a single EPP service element from the transport layer, then construct an XMLDocument instance from the element read.
`void`	`recordResponseTime(CommandType type, long responseTime)` Record the time interval (in milliseconds) which elapsed between sending a command and receiving a response to that command - that is, the response time of a transaction.
`void`	`release()` Release the Session for use by another user.
`void`	`write(Command command)` Write an EPP service element to the transport layer service, with the intention of sending the command to the connected EPP server.
`void`	`write(java.lang.String xml)` Send data to peer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TLSSession
```
protected TLSSession()
```
  - TLSSession
```
protected TLSSession(SessionProperties props)
              throws SessionConfigurationException
```
    Throws:
    
    SessionConfigurationException
- Method Detail
  - configure
```
public void configure(SessionProperties properties)
               throws SessionConfigurationException
```
    Configure the session as described in the Session interface.
    Specified by:
    
    configure in interface Session
    
    Parameters:
    
    properties - Properties as defined in the SessionProperties interface, which govern the behaviour of a Session.
    
    Throws:
    SessionConfigurationException - Possible causes:
    
    KeyStoreNotFoundException
    
    KeyStoreTypeException
    
    NoSuchAlgorithmException
    
    UnrecoverableKeyException
    
    CertificateException
    
    KeyStoreReadException
    
    UnknownHostException
    
    FileNotFoundException
  - isInvalid
```
public boolean isInvalid()
```
    Description copied from interface: Session
    
    Determine whether a call to read or write would result in an IOException.
    
    Specified by:
    
    isInvalid in interface Session
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: Session
    
    Determine whether a call to open has previously succeeded.
    
    Specified by:
    
    isOpen in interface Session
  - open
```
public void open()
          throws SessionOpenException
```
    * An EPP session is opened by first establishing a connection using the server location information and authentication sources provided in configure, then issuing a login command with further authentication data and options provided in configure. Service information provided immediately upon connection establishment may affect options provided in the login command.
    
    Specified by:
    
    open in interface Session
    
    Throws:
    
    SessionOpenException - The getCause() method should be invoked on the exception thrown. The cause may be one of:
    
    SSLHandshakeException
    
    The SSL handshake failed. The reason is described in the exception message, and is also recorded in the user logs.
    
    IOException
    
    See the log record published to the user logs, or check the exception message.
    
    GreetingException
    
    The service element received from the server upon connection establishment was not a valid EPP greeting.
    
    LoginException
    
    The login command failed to establish an EPP session. The cause, available via getCause(), describes the specific reason for failure.
  - changePassword
```
public void changePassword(java.lang.String newPassword)
                    throws SessionOpenException
```
    Description copied from interface: Session
    
    Change the client password to the given value. This must be implemented in EPP by logging in with the newPW value set, then logging out.
    
    Specified by:
    
    changePassword in interface Session
    
    Parameters:
    
    newPassword - The new client password.
    
    Throws:
    
    SessionOpenException
  - getGreeting
```
public Greeting getGreeting()
```
    Description copied from interface: Session
    
    EPP service discovery is implemented by the greeting service element. Upon successfully negotiating a connection to a server, a greeting is sent to the client, describing the services offered by the EPP server. That information is encapsulated in a Greeting object, which may be retrieved using this method.
    
    Specified by:
    
    getGreeting in interface Session
  - close
```
public void close()
```
    Description copied from interface: Session
    
    EPP sessions are closed cleanly by sending an EPP logout command, awaiting a response from the server, then acknowledging the close of the underlying transport mechanism initiated by the server upon completion of sending the logout response. This method guarantees that the session is closed and the resources used to maintain the connection are freed. This may require forcing the underlying transport mechanism to close in the event that the logout fails (for any reason). Any errors which occur during the close operation are not presented to the caller, but may be logged.
    
    Specified by:
    
    close in interface Session
  - read
```
public java.lang.String read()
                      throws java.io.IOException
```
    Receive data from the peer. This method is unsynchronised; the caller MUST provide synchronisation against other calls to read.
    
    Specified by:
    
    read in interface Session
    
    Returns:
    
    the details from the socket
    
    Throws:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - read
```
public void read(Response response)
          throws java.io.IOException,
                 ParsingException
```
    Description copied from interface: Session
    
    Read a single EPP service element from the transport layer and assign values to the attributes of the given Response instance appropriately, according to the received XML document content. Typically, the latter can be achieved by invoking the given Response instance’s toXML method.
    
    Specified by:
    
    read in interface Session
    
    Throws:
    
    java.io.IOException - There was a failure in the transport layer in attempting to receive data from the server. The cause of the exception should be described in the exception message.
    
    ParsingException - The XML parser reported an error while trying to construct an XMLDocument instance from the data received from the server.
  - readToDocument
```
public XMLDocument readToDocument()
                           throws java.io.IOException,
                                  ParsingException
```
    Description copied from interface: Session
    
    Read a single EPP service element from the transport layer, then construct an XMLDocument instance from the element read.
    
    Specified by:
    
    readToDocument in interface Session
    
    Throws:
    
    java.io.IOException - There was a failure in the transport layer in attempting to receive data from the server. The cause of the exception should be described in the exception message.
    
    ParsingException - The XML parser reported an error while trying to construct an XMLDocument instance from the data received from the server.
  - write
```
public void write(java.lang.String xml)
           throws java.io.IOException
```
    Send data to peer. This method is unsynchronised; the caller MUST provide synchronisation against other calls to write(String).
    
    Specified by:
    
    write in interface Session
    
    Parameters:
    
    xml - the XML to be sent to the EPP Server
    
    Throws:
    
    java.io.IOException - Signals that an I/O exception has occurred.
  - write
```
public void write(Command command)
           throws java.io.IOException,
                  ParsingException
```
    Description copied from interface: Session
    
    Write an EPP service element to the transport layer service, with the intention of sending the command to the connected EPP server. The service element is modelled by the specified Command instance. The XML representation of the service element is obtained from the toXML method of the Command instance.
    
    Specified by:
    
    write in interface Session
    
    Throws:
    
    java.io.IOException - The transport layer was unable to send the data to the server. This condition is considered permanent and causes the session state to become invalid, as indicated by isInvalid.
    
    ParsingException - See the description of Command.toXML().
  - keepAlive
```
public void keepAlive()
               throws java.io.IOException
```
    Send a poll command to the EPP server in order to prevent the session timing out. This operation does not affect the most-recently-used statistic.
    
    Specified by:
    
    keepAlive in interface Session
    
    Throws:
    
    java.io.IOException
  - incCommandCounter
```
public void incCommandCounter(CommandType type)
```
    Description copied from interface: StatsManager
    
    Increment the command count for the given command type. This is reflected in the return value of StatsViewer.getCommandCount().
    
    Specified by:
    
    incCommandCounter in interface StatsManager
  - incResultCounter
```
public void incResultCounter(int resultCode)
```
    Description copied from interface: StatsManager
    
    Increment the result count for the given code. This is reflected in the return value of StatsViewer.getResultCodeCount(int).
    
    Specified by:
    
    incResultCounter in interface StatsManager
  - recordResponseTime
```
public void recordResponseTime(CommandType type,
                               long responseTime)
```
    Description copied from interface: StatsManager
    
    Record the time interval (in milliseconds) which elapsed between sending a command and receiving a response to that command - that is, the response time of a transaction.
    
    Specified by:
    
    recordResponseTime in interface StatsManager
  - getAverageResponseTime
```
public long getAverageResponseTime()
```
    Description copied from interface: StatsViewer
    
    Get the average response time (in milliseconds) of all transactions.
    
    Specified by:
    
    getAverageResponseTime in interface StatsViewer
  - getAverageResponseTime
```
public long getAverageResponseTime(CommandType type)
```
    Description copied from interface: StatsViewer
    
    Get the average response time (in milliseconds) of transactions of the given command type.
    
    Specified by:
    
    getAverageResponseTime in interface StatsViewer
  - getCommandCount
```
public long getCommandCount()
```
    Description copied from interface: StatsViewer
    
    Get the number of commands of the given type that the Session(s) associated with this viewer has/have processed since creation.
    
    Specified by:
    
    getCommandCount in interface StatsViewer
  - getCommandCount
```
public long getCommandCount(CommandType type)
```
    Description copied from interface: StatsViewer
    
    Get the total number of commands processed by Sessions associated with this StatsViewer.
    
    Specified by:
    
    getCommandCount in interface StatsViewer
  - getRecentCommandCount
```
public int getRecentCommandCount()
```
    Description copied from interface: StatsViewer
    
    Get the number of commands of the given type that the Session(s) associated with this viewer has/have processed recently (default: 1 second).
    
    Specified by:
    
    getRecentCommandCount in interface StatsViewer
  - getRecentCommandCount
```
public int getRecentCommandCount(CommandType type)
```
    Description copied from interface: StatsViewer
    
    Get the total number of commands recently processed by Sessions associated with this StatsViewer.
    
    Specified by:
    
    getRecentCommandCount in interface StatsViewer
  - getResultCodeCount
```
public long getResultCodeCount(int resultCode)
```
    Description copied from interface: StatsViewer
    
    Get the number of responses received having the given result code.
    
    Specified by:
    
    getResultCodeCount in interface StatsViewer
  - getMruInterval
```
public long getMruInterval()
```
    Get the length of time (in milliseconds) since the most recent use (mru) of the session. The session is considered to be used when the write method is invoked.
    
    Specified by:
    
    getMruInterval in interface StatsViewer
  - getStatsManager
```
public StatsManager getStatsManager()
```
    Description copied from interface: Session
    
    Get the StatsManager as described in the class documentation.
    
    Specified by:
    
    getStatsManager in interface Session
  - isAvailable
```
public boolean isAvailable()
```
    Description copied from interface: Session
    
    Determine whether a call to acquire would block.
    
    Specified by:
    
    isAvailable in interface Session
  - acquire
```
public void acquire()
             throws java.lang.InterruptedException,
                    TimeoutException
```
    Description copied from interface: Session
    
    Acquire the session for exclusive use. Further requests to acquire the session before it is released should block until release is called. The correct usage sequence if contention is expected is acquire, (write, read)+, release.
    
    Specified by:
    
    acquire in interface Session
    
    Throws:
    
    java.lang.InterruptedException - The thread was interrupted while waiting to acquire the lock on the session.
    
    TimeoutException - The acquire timeout period elapsed while waiting to acquire exclusive use of the session.
    
    See Also:
    
    SessionProperties.getAcquireTimeout()
  - release
```
public void release()
```
    Description copied from interface: Session
    
    Release the Session for use by another user. This should only be used after the session has been acquired.
    
    Specified by:
    
    release in interface Session

Class TLSSession

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TLSSession

TLSSession

Method Detail

configure

isInvalid

isOpen

open

changePassword

getGreeting

close

read

read

readToDocument

write

write

keepAlive

incCommandCounter

incResultCounter

recordResponseTime

getAverageResponseTime

getAverageResponseTime

getCommandCount

getCommandCount

getRecentCommandCount

getRecentCommandCount

getResultCodeCount

getMruInterval

getStatsManager

isAvailable

acquire

release