com.ausregistry.jtoolkit2.session

Class SessionPoolImpl

java.lang.Object

com.ausregistry.jtoolkit2.session.SessionPoolImpl

All Implemented Interfaces:

SessionPool, StatsViewer

public class SessionPoolImpl
extends java.lang.Object
implements SessionPool, StatsViewer

This defines the operations or actions for managing a SessionPool and a StatsViewer. Uses the debug, support and user level loggers.

Method Summary

Modifier and Type	Method and Description
void	clean() Close all open sessions, then open the same number of sessions that were closed.
void	empty() Close all sessions in the pool, then remove references to those sessions.
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	getLastGreeting() Pull a greeting from the pool, forcing initialisation of the pool if a greeting has not yet been received.
long	getMruInterval() Get the time interval since the most recent use of a Session associated with this StatsViewer.
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.
Session	getSession() Get the most suitable session from the pool.
Session	getSession(CommandType commandType) Get the most suitable session from the pool based on the type of the command to be sent over that session.
StatsViewer	getStatsViewer() Get the StatsViewer responsible for reporting operating statistics about the sessions in the pool.
long	keepAlive() Keep a single session in the pool open by polling the EPP server at regular intervals.
void	releaseSession(Session session) Release back to the pool a session acquired using getSession.
void	setMaxSize(int size) Set the maximum number of sessions allowed in the pool to the specified value.

Methods inherited from class java.lang.Object

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

Method Detail

setMaxSize

public void setMaxSize(int size)

Description copied from interface: SessionPool

Set the maximum number of sessions allowed in the pool to the specified value.

Specified by:

setMaxSize in interface SessionPool

getLastGreeting

public Greeting getLastGreeting()
                         throws SessionConfigurationException,
                                SessionOpenException,
                                java.lang.InterruptedException

Pull a greeting from the pool, forcing initialisation of the pool if a greeting has not yet been received.

Specified by:

getLastGreeting in interface SessionPool

Throws:

SessionConfigurationException

SessionOpenException

java.lang.InterruptedException

keepAlive

public long keepAlive()
               throws java.io.IOException

Description copied from interface: SessionPool

Keep a single session in the pool open by polling the EPP server at regular intervals.

Specified by:

keepAlive in interface SessionPool

Throws:

java.io.IOException - See Session.keepAlive.

empty

public void empty()

Description copied from interface: SessionPool

Close all sessions in the pool, then remove references to those sessions.

Specified by:

empty in interface SessionPool

clean

public void clean()
           throws SessionConfigurationException,
                  SessionOpenException

Description copied from interface: SessionPool

Close all open sessions, then open the same number of sessions that were closed.

Specified by:

clean in interface SessionPool

Throws:

SessionConfigurationException

SessionOpenException

getSession

public Session getSession()
                   throws SessionConfigurationException,
                          SessionOpenException,
                          java.lang.InterruptedException

Description copied from interface: SessionPool

Get the most suitable session from the pool. The session provided MUST NOT be eligible for further acquisition using getSession until it has been released using releaseSession. Use of getSession should not be mixed with direct use of Session.acquire on sessions managed by the pool. Implementations are not required to guarantee that this will not cause further invocations of getSession to block.

Specified by:

getSession in interface SessionPool

Throws:

SessionConfigurationException - The pool had no available sessions, so a new session was created but configuration of that session failed due to invalid session properties.

SessionOpenException - The pool had no available sessions, and so tried to open a new session which was successfully configured, but failed to open. It should be expected that further requests to get a session will fail.

java.lang.InterruptedException

getSession

public Session getSession(CommandType commandType)
                   throws SessionConfigurationException,
                          SessionOpenException,
                          java.lang.InterruptedException

Description copied from interface: SessionPool

Get the most suitable session from the pool based on the type of the command to be sent over that session. See getSession for further details.

Specified by:

getSession in interface SessionPool

Throws:

SessionConfigurationException

SessionOpenException

java.lang.InterruptedException

releaseSession

public void releaseSession(Session session)

Description copied from interface: SessionPool

Release back to the pool a session acquired using getSession.

Specified by:

releaseSession in interface SessionPool

getStatsViewer

public StatsViewer getStatsViewer()

Description copied from interface: SessionPool

Get the StatsViewer responsible for reporting operating statistics about the sessions in the pool.

Specified by:

getStatsViewer in interface SessionPool

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

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

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

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

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

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

getMruInterval

public long getMruInterval()

Description copied from interface: StatsViewer

Get the time interval since the most recent use of a Session associated with this StatsViewer.

Specified by:

getMruInterval 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