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. More...
 
String getBuildDate ()
 Returns the date that the client version was built. More...
 
String getBuildNumber ()
 The Nirvana build number that the client is using to connect. More...
 
long getEventsReceived ()
 Returns the number of events that this connection has received from the remote client. More...
 
long getEventsTransmitted ()
 Returns the number of events sent to the remote client. More...
 
String getId ()
 Returns the unique connection ID used to identify this connection. More...
 
String getLanguageVersion ()
 Returns the language that the client application is using e.g. More...
 
String getLastReceivedEvent ()
 Returns a protocol description of the last event received from the connection. More...
 
String getLastTransmittedEvent ()
 Returns a protocol description of the last event transmitted from the connection. More...
 
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. More...
 
String getOSName ()
 Returns the name of the operating system that the client application is running on. More...
 
String getOSVersion ()
 Returns the version of the operating system the client application is running on. More...
 
String getProtocol ()
 This method returns the protocol string, currently one of NSP, NHP, NSPS or NHPS. More...
 
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. More...
 
String getRealmName ()
 Returns the name of the realm. More...
 
long getReceivedByteCount ()
 Returns the number of bytes that this connection has received from the remote client. More...
 
String getSelector (nLeafNode leafNode) throws nAdminIllegalArgumentException
 Returns the Selector that the connection used to bind to a channel/queue. More...
 
String getSessionName ()
 Returns the name of this session as set by the client API. More...
 
String[] getSubject ()
 Returns an array of strings that the connection used to authenticate with the server. More...
 
long getTimeOfLastReceive ()
 Returns the timestamp since the last received event. More...
 
long getTimeOfLastTransmitt ()
 Returns the number of milliseconds since the last event was sent. More...
 
long getTransmittedByteCount ()
 Returns the number of bytes that this connection has transmitted to the remote client. More...
 
long getUpTime ()
 Returns the number of milliseconds that the connection has been active for. More...
 
boolean isMulticastEnabled ()
 Returns if multicast is enabled. More...
 
boolean requirePriorityConnection ()
 Queries if this connection requires a priority connection. More...
 
boolean wasClosedByClient ()
 This method will show that after this connection has received a delete callback, whether the close was initiated by the client. More...
 

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.
String com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getBuildDate ( )

Returns the date that the client version was built.

Returns
the date as a
String com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getBuildNumber ( )

The Nirvana build number that the client is using to connect.

Returns
The Nirvana client build number
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.getLanguageVersion ( )

Returns the language that the client application is using e.g.

Java 1.6.0_26

Returns
The language used by the connected application
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.getOSName ( )

Returns the name of the operating system that the client application is running on.

Returns
The name of the operating system used by this client
String com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getOSVersion ( )

Returns the version of the operating system the client application is running on.

Returns
The operating system version.
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
leafNodeThe node being queried
Returns
the selector used for event filtering as a String
Exceptions
nAdminIllegalArgumentExceptionis thrown if leafNode is null
String com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getSessionName ( )

Returns the name of this session as set by the client API.

Returns
the name of this session
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.getTransmittedByteCount ( )

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.isMulticastEnabled ( )

Returns if multicast is enabled.

Returns
true if multicast is enabled, false otherwise.
boolean com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.requirePriorityConnection ( )

Queries if this connection requires a priority connection.

Returns
true if this requires a priority connection, false otherwise.
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