This is the base class for all nirvana channel types, including queues and normal pub/sub channels and as such has no public methods. More...

Inheritance diagram for com.pcbsys.nirvana.client.nAbstractChannel:

Public Member Functions
nJoinInformation[]	getJoinInformation () throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRealmNotFoundException, nRequestTimedOutException, nUnexpectedResponseException
	Returns an array of nJoinInformation objects which describe the links this channel has configured for it. More...

int	getQueueSize ()
	Returns the size of the underlying event queue waiting for delivery via the go method. More...

nSession	getSession ()
	Returns the nSession used to create/find this channel. More...

com.pcbsys.nirvana.client.nChannelAttributes	getStoreAttributes ()
	The attributes about this channel and how it is configured. More...

StoreLogger	getTraceLogger ()
	Internal logger for UM Client API. More...

boolean	isStoreObjectInvalid ()
	When a store is removed (or modified which entails a remove and create) then these logical representations can become invalid Once they are invalid you must perform a findChannel again on the nSession to acquire the latest object. More...

void	purge () throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException
	Deletes all undelivered events from the store. More...

void	purge (String selector) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException
	Deletes all undelivered events from the store that match {. More...

void	purgeEvent (long eidval) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Purges a single event from this store. More...

void	purgeEventAsync (long eidval) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Purges a single event from this store and does not wait for the response from the server. More...

void	purgeEvents (long startEID, long endEID) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Purges a range of events from this store. More...

void	purgeEvents (long startEID, long endEID, String selector) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Purges a range of events from this store that match {. More...

void	purgeEventsAsync (long startEID, long endEID) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Purges a range of events from this store and does not wait for the response from the server. More...

void	purgeEventsAsync (long startEID, long endEID, String selector) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Purges a range of events from this store that match {. More...

void	purgeEventsAsync () throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException
	Deletes all undelivered events from the store and does not wait for the response from the server. More...

void	purgeEventsAsync (String selector) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException
	Deletes all undelivered events matching the selector from the store and does not wait for the response from the server. More...

void	updateProtobufDefinitions (List< ProtobufDescriptor > descriptorsList) throws nIllegalArgumentException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException
	Update the Protocol Buffer definitions for the store. More...

void	updateProtobufDefinitions (byte[][] descriptors) throws nIllegalArgumentException, nRequestTimedOutException, nSessionNotConnectedException, nSessionPausedException
	Update the Protocol Buffer definitions just with byte[], without names. More...

Detailed Description

This is the base class for all nirvana channel types, including queues and normal pub/sub channels and as such has no public methods.

See Also: nChannel; nQueue

Member Function Documentation

nJoinInformation [] com.pcbsys.nirvana.client.nAbstractChannel.getJoinInformation ( ) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRealmNotFoundException, nRequestTimedOutException, nUnexpectedResponseException

Returns an array of nJoinInformation objects which describe the links this channel has configured for it.

Returns: array of nJoinInformation objects

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nSessionPausedException	The session is currently paused
nSessionNotConnectedException	The session is not currently connected to the server
nRealmNotFoundException	The remote realm could not be found
nRequestTimedOutException	if the request exceeded the timeout value
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information. One condition of this is if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server.

int com.pcbsys.nirvana.client.nAbstractChannel.getQueueSize ( )

Returns the size of the underlying event queue waiting for delivery via the go method.

Returns: number of events to be delivered

nSession com.pcbsys.nirvana.client.nAbstractChannel.getSession ( )

Returns the nSession used to create/find this channel.

Returns: the nSession associated with this channel

com.pcbsys.nirvana.client.nChannelAttributes com.pcbsys.nirvana.client.nAbstractChannel.getStoreAttributes ( )

The attributes about this channel and how it is configured.

Returns: nChannelAttributes of this store

StoreLogger com.pcbsys.nirvana.client.nAbstractChannel.getTraceLogger ( )

Internal logger for UM Client API.

Used to log the lifecycle of events which are for a specific store. It is NOT expected this logger to be used by any users. Client logger configurations: com.pcbsys.nirvana.client.nConstants#setTraceStores(String traceStores). com.pcbsys.nirvana.client.nConstants#setTraceLoggerPath(String logPath). com.pcbsys.nirvana.client.nConstants#setTraceStoreLogLevel(StoreLogConfigLevel logLevel). com.pcbsys.nirvana.client.nConstants#setTraceStoreLogSize(int size). size).

Returns: the client StoreLogger

boolean com.pcbsys.nirvana.client.nAbstractChannel.isStoreObjectInvalid ( )

When a store is removed (or modified which entails a remove and create) then these logical representations can become invalid Once they are invalid you must perform a findChannel again on the nSession to acquire the latest object.

Returns: true if this store is no longer valid

void com.pcbsys.nirvana.client.nAbstractChannel.purge ( ) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException

Deletes all undelivered events from the store.

For channels this functionality is available since version 10.5

Exceptions

nSecurityException	The client is not authorized to perform this task
nChannelNotFoundException	The store could not be found
nSessionNotConnectedException	Client is not currently connected to the server
nRequestTimedOutException	The server did not respond within the timeout
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information. One condition of this is if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server.
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nAbstractChannel.purge ( String selector ) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException

Deletes all undelivered events from the store that match {.

Parameters

selector}

For channels this functionality is available since version 10.5

Parameters

selector Purges all events which match this filter

Exceptions

nSecurityException	The client is not authorized to perform this task
nChannelNotFoundException	The Queue could not be found
nSessionNotConnectedException	Client is not currently connected to the server
nRequestTimedOutException	The server did not respond within the timeout
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information. One condition of this is if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server.
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nAbstractChannel.purgeEvent ( long eidval ) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

Purges a single event from this store.

For queues this functionality is available since version 10.5

Parameters

eidval a long specifying the event id of the event to be purged from the store

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the store no longer exists
nSessionPausedException	The session is currently paused
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	This exception is raised if there is any issues with any of the arguments used by this method. One condition of this is if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server.

void com.pcbsys.nirvana.client.nAbstractChannel.purgeEventAsync ( long eidval ) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

Purges a single event from this store and does not wait for the response from the server.

For queues this functionality is available since version 10.5

Parameters

eidval a long specifying the event id of the event to be purged from the store

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the store no longer exists
nSessionPausedException	The session is currently paused
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	This exception is raised if there is any issues with any of the arguments used by this method. One condition of this is if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server.

void com.pcbsys.nirvana.client.nAbstractChannel.purgeEvents	(	long	startEID,
		long	endEID
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

Purges a range of events from this store.

For queues this functionality is available since version 10.5

Parameters

startEID	a long specifying the start event id of the range of events to be purged from the store
endEID	a long specifying the end event id of the range of events to be purged from the store

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the store no longer exists
nSessionPausedException	The session is currently paused
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	This exception is raised if there is any issues with any of the arguments used by this method. One condition of this is if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server.

void com.pcbsys.nirvana.client.nAbstractChannel.purgeEvents	(	long	startEID,
		long	endEID,
		String	selector
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

Purges a range of events from this store that match {.

Parameters

selector}

For queues this functionality is available since version 10.5

Parameters

startEID	a long specifying the start event id of the range of events to be purged from the store
endEID	a long specifying the end event id of the range of events to be purged from the store
selector	A messages selector which will be used to filter out only the events which match this criteria

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the store no longer exists
nSessionPausedException	The session is currently paused
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	This exception is raised if there is any issues with any of the arguments used by this method. One condition of this is if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server.

void com.pcbsys.nirvana.client.nAbstractChannel.purgeEventsAsync	(	long	startEID,
		long	endEID
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

Purges a range of events from this store and does not wait for the response from the server.

For queues this functionality is available since version 10.5

Parameters

startEID	a long specifying the start event id of the range of events to be purged from the store
endEID	a long specifying the end event id of the range of events to be purged from the store

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the store no longer exists
nSessionPausedException	The session is currently paused
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	This exception is raised if there is any issues with any of the arguments used by this method. One condition of this is if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server.

void com.pcbsys.nirvana.client.nAbstractChannel.purgeEventsAsync	(	long	startEID,
		long	endEID,
		String	selector
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

Purges a range of events from this store that match {.

Parameters

selector} and does not wait for the response from the server

For queues this functionality is available since version 10.5

Parameters

startEID	a long specifying the start event id of the range of events to be purged from the store
endEID	a long specifying the end event id of the range of events to be purged from the store
selector	A messages selector which will be used to filter out only the events which match this criteria

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the store no longer exists
nSessionPausedException	The session is currently paused
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	This exception is raised if there is any issues with any of the arguments used by this method. One condition of this is if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server.

void com.pcbsys.nirvana.client.nAbstractChannel.purgeEventsAsync ( ) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException

Deletes all undelivered events from the store and does not wait for the response from the server.

For channels this functionality is available since version 10.5

Exceptions

nSecurityException	The client is not authorized to perform this task
nChannelNotFoundException	The store could not be found
nSessionNotConnectedException	Client is not currently connected to the server
nRequestTimedOutException	The server did not respond within the timeout
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information. One condition of this is if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server.
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nAbstractChannel.purgeEventsAsync ( String selector ) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException

Deletes all undelivered events matching the selector from the store and does not wait for the response from the server.

For channels this functionality is available since version 10.5

Parameters

selector Purges all events which match this filter

Exceptions

nSecurityException	The client is not authorized to perform this task
nChannelNotFoundException	The store could not be found
nSessionNotConnectedException	Client is not currently connected to the server
nRequestTimedOutException	The server did not respond within the timeout
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information. One condition of this is if this object has been invalidated and no longer can be utilised, this can occur if a delete request has been issued to the connected server.
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nAbstractChannel.updateProtobufDefinitions ( List< ProtobufDescriptor > descriptorsList ) throws nIllegalArgumentException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException

Update the Protocol Buffer definitions for the store.

Parameters

descriptorsList an List of ProtobufDescriptor objects. ProtobufDescriptor object contains descriptor's name and descriptor's byte[]

Exceptions

nIllegalArgumentException	descriptors cannot be sent to the realm
nSessionNotConnectedException	if the session for this store is currently not connected
nSessionPausedException	if the session for the store is currently pauser
nRequestTimedOutException	if there is no response to the request to set the store's descriptors within the timeout period.

void com.pcbsys.nirvana.client.nAbstractChannel.updateProtobufDefinitions ( byte descriptors[][] ) throws nIllegalArgumentException, nRequestTimedOutException, nSessionNotConnectedException, nSessionPausedException

Update the Protocol Buffer definitions just with byte[], without names.

Parameters

descriptors An array of descriptors as byte[] to set as the new channel's descriptors

Exceptions

nIllegalArgumentException	descriptors cannot be sent to the realm
nRequestTimedOutException	if there is no response to the request to set the store's descriptors withing the timeout period
nSessionNotConnectedException	if the session for this store is not currently connected
nSessionPausedException	if the session for this store is currently paused

Deprecated:: Please use updateProtobufDefinitions(List) (List)} instead

Public Member Functions

Detailed Description

Member Function Documentation