com.pcbsys.nirvana.nAdminAPI.nConnectionDetails Class Reference

This class contains the details about an individual connection. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nConnectionDetails:

com.pcbsys.nirvana.nAdminAPI.nChannelConnectionDetails

Public Member Functions

Enumeration getBoundNodes ()
 Returns an collection of nNodes that this connection is bound to.
long getEventsReceived ()
 Returns the number of events that this connection has received from the remote client.
long getEventsTransmitted ()
 Returns the number of events sent to the remote client.
String getId ()
 Returns the unique connection ID used to identify this connection.
String getLastReceivedEvent ()
 Returns a protocol description of the last event received from the connection.
String getLastTransmittedEvent ()
 Returns a protocol description of the last event transmitted from the connection.
int getLatency ()
 This field is updated by the client heartbeat and as such only changes when the server receives a heart beat from the client.
String getProtocol ()
 This method returns the protocol string, currently one of NSP, NHP, NSPS or NHPS.
int getQueueSize ()
 This queue size is the internal server buffer where all events are pushed awaiting delivery A large number here or a number that is not moving maybe indicative of a slow or problematic connection.
String getRealmName ()
 Returns the name of the realm.
long getReceivedByteCount ()
 Returns the number of bytes that this connection has received from the remote client.
String getSelector (nLeafNode leafNode) throws nAdminIllegalArgumentException
 Returns the Selector that the connection used to bind to a channel/queue.
String[] getSubject ()
 Returns an array of strings that the connection used to authenticate with the server.
long getTimeOfLastReceive ()
 Returns the timestamp since the last received event.
long getTimeOfLastTransmitt ()
 Returns the number of milliseconds since the last event was sent.
long getTransimittedByteCount ()
 Returns the number of bytes that this connection has transmitted to the remote client.
long getUpTime ()
 Returns the number of milliseconds that the connection has been active for.
boolean wasClosedByClient ()
 This method will show that after this connection has received a delete callback, whether the close was initiated by the client.

Detailed Description

This class contains the details about an individual connection.

It extends the java.util.Observable class to allow a user program to be informed about changes to the statistics of the connection.

Member Function Documentation

Enumeration com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getBoundNodes (  ) 

Returns an collection of nNodes that this connection is bound to.

Returns:
An Enumeration of nNode objects that this connection is bound to.

long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getEventsReceived (  ) 

Returns the number of events that this connection has received from the remote client.

Returns:
a long representing the number of events received by this connection

long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getEventsTransmitted (  ) 

Returns the number of events sent to the remote client.

Returns:
a long representing the number of events transmitted by this connection

String com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getId (  ) 

Returns the unique connection ID used to identify this connection.

Returns:
The connection ID as a String

String com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getLastReceivedEvent (  ) 

Returns a protocol description of the last event received from the connection.

Returns:
a String containing the protocol description of the last event received

String com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getLastTransmittedEvent (  ) 

Returns a protocol description of the last event transmitted from the connection.

Returns:
a String containing the protocol description of the last event transmitted

int com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getLatency (  ) 

This field is updated by the client heartbeat and as such only changes when the server receives a heart beat from the client.

Returns:
a int in milliseconds of the last request/response

String com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getProtocol (  ) 

This method returns the protocol string, currently one of NSP, NHP, NSPS or NHPS.

Returns:
A String indicating the protocol used by this connection

int com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getQueueSize (  ) 

This queue size is the internal server buffer where all events are pushed awaiting delivery A large number here or a number that is not moving maybe indicative of a slow or problematic connection.

Returns:
a long representing the queue size

String com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getRealmName (  ) 

Returns the name of the realm.

Returns:
the name of the realm

long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getReceivedByteCount (  ) 

Returns the number of bytes that this connection has received from the remote client.

Returns:
Long count

String com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getSelector ( nLeafNode  leafNode  )  throws nAdminIllegalArgumentException

Returns the Selector that the connection used to bind to a channel/queue.

Parameters:
leafNode The node being queried
Returns:
the selector used for event filtering as a String
Exceptions:
nAdminIllegalArgumentException is thrown if leafNode is null

String [] com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getSubject (  ) 

Returns an array of strings that the connection used to authenticate with the server.

The first entry is the primary principal and is the only one used in the ACL validation. The array will only contain more than one entry in a Client certificate validated SSL session which will use CN as the primary principal followed by the user supplied principal.

Returns:
A list of subjects as a String[]

long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getTimeOfLastReceive (  ) 

Returns the timestamp since the last received event.

Returns:
a long representing the timestamp since the last received event

long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getTimeOfLastTransmitt (  ) 

Returns the number of milliseconds since the last event was sent.

Returns:
a long representing the timestamp since the last transmitted event

long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getTransimittedByteCount (  ) 

Returns the number of bytes that this connection has transmitted to the remote client.

Returns:
the number of bytes transmitted by this connection as a long

long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getUpTime (  ) 

Returns the number of milliseconds that the connection has been active for.

Returns:
a long representing the number of ms the server has been up

boolean com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.wasClosedByClient (  ) 

This method will show that after this connection has received a delete callback, whether the close was initiated by the client.

The client close is generated from the nSessionFactory.close(nSession) method. Other closes or disconnections will return false, since the client did not send a session close event.

Returns:
true if the client initiated the session close