This class represents the standard Channel or Topic access to the UM server. More...

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

Public Member Functions
void	addConnectionListener (nChannelConnectionListener listener) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException
	Adds a nChannelConnectionListener to this channel so that when new connections are made to this channel the listener is notified. More...

void	addConnectionListener (nChannelConnectionListener listener, boolean isSync) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException
	Adds a nChannelConnectionListener to this channel so that when new connections are made to this channel the listener is notified. More...

void	addSubscriber (nEventListener nel) throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException
	Registers the specified nEventListener as a subscriber to this channel. More...

void	addSubscriber (nEventListener nel, long eid) throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException
	Registers the specified nEventListener as a subscriber to this channel. More...

void	addSubscriber (nEventListener nel, String selector) throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nIllegalArgumentException
	Registers the specified nEventListener as a subscriber to this channel. More...

void	addSubscriber (nEventListener nel, String selector, long eid) throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nIllegalArgumentException
	Registers the specified nEventListener as a subscriber to this channel. More...

void	addSubscriber (nEventListener nel, nDurable durable) throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nSelectorParserException, nIllegalArgumentException, nNameAlreadyBoundException
	Registers the specified nEventListener as a durable subscriber to this channel. More...

void	addSubscriber (nEventListener nel, nDurable durable, String selector, boolean AutoAck) throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nSelectorParserException, nIllegalArgumentException, nNameAlreadyBoundException
	Registers the specified nEventListener as a durable subscriber to this channel. More...

void	addSubscriber (nEventListener nel, nDurable durable, String selector, int windowSize) throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nSelectorParserException, nIllegalArgumentException, nNameAlreadyBoundException
	Registers the specified nEventListener as a durable subscriber to this channel. More...

nChannelIterator	createIterator () throws nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException
	Create a default channel iterator starting at the beginning of the channel. More...

nChannelIterator	createIterator (String selector) throws nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nSelectorParserException
	Create a default channel iterator starting at the beginning of the channel with the events which match the selector being returned. More...

nChannelIterator	createIterator (long startEID) throws nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException
	Create a default channel iterator starting at the EID specified. More...

nChannelIterator	createIterator (long startEID, boolean autoAck) throws nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException
	Create a default channel iterator starting at the EID specified. More...

nChannelIterator	createIterator (String selector, long startEID) throws nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nSelectorParserException
	Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned. More...

nChannelIterator	createIterator (String selector, long startEID, boolean autoAck) throws nUnexpectedResponseException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nSelectorParserException
	Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned. More...

nChannelIterator	createIterator (nDurable name) throws nIllegalArgumentException, nNameAlreadyBoundException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException
	Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned. More...

nChannelIterator	createIterator (nDurable name, String selector) throws nIllegalArgumentException, nNameAlreadyBoundException, nSelectorParserException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException
	Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned. More...

nChannelIterator	createIterator (nDurable name, String selector, int windowSize) throws nIllegalArgumentException, nNameAlreadyBoundException, nSelectorParserException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException
	create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned More...

nChannelIterator	createIterator (nDurable name, String selector, int windowSize, boolean autoAck) throws nIllegalArgumentException, nNameAlreadyBoundException, nSelectorParserException, nUnexpectedResponseException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException
	create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned More...

nChannelIterator	createIterator (nDurable name, String selector, boolean autoAck) throws nIllegalArgumentException, nNameAlreadyBoundException, nSelectorParserException, nUnexpectedResponseException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException
	create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned More...

nRegisteredEvent	createRegisteredEvent (Object keyValue) throws nIllegalArgumentException
	Creates a new nRegisteredEvent bound to this channel using the keyValue as its unique id. More...

nRegisteredEvent	createRegisteredEvent (Object keyValue, boolean isTransactional) throws nIllegalArgumentException
	Creates a new nRegisteredEvent bound to this channel using the keyValue as its unique id. More...

void	deleteJoin (nChannel destination) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Deletes a join between this channel and the channel referenced in the destination parameter. More...

void	deleteJoin (nQueue destination) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Deletes a join between this channel and the queue referenced in the destination parameter. More...

nChannelAttributes	getChannelAttributes ()
	Gets the channels local attributes. More...

nDurableManager	getDurableManager ()
	Gets durable manager. More...

long	getEventCount () throws nChannelNotFoundException, nSecurityException, nSessionNotConnectedException, nRequestTimedOutException, nSessionPausedException, nUnexpectedResponseException
	Gets the number of events on this channel. More...

long	getLastEID () throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException
	Gets the last event id of this channel. More...

long	getLastStoredEID () throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException
	Gets the last event id of this channel. More...

String	getName ()
	Gets the name of this channel. More...

int	getType ()
	Gets the type of this channel Currently supported types are: More...

boolean	isSubscribed ()
	Determines whether the underlying channel is currently being subscribed to. More...

boolean	isSubscriberPaused (nEventListener eventListener) throws nIllegalArgumentException
	Returns true if the subscription of the specified nEventListener object is paused. More...

void	joinChannel (nChannel dest, String selector) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRealmNotFoundException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nDuplicateJoinException, nIllegalArgumentException
	Sets a server based link between this channel and the channel defined within the provided nChannel. More...

void	joinChannel (nChannel dest) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRealmNotFoundException, nRequestTimedOutException, nUnexpectedResponseException, nDuplicateJoinException, nIllegalArgumentException
	Sets a server based link between this channel and the channel defined within the provided nChannel. More...

void	joinChannel (nChannel dest, boolean isRouted, int hopCount, String selector) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRealmNotFoundException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nDuplicateJoinException, nIllegalArgumentException
	Sets a server based link between this channel and the channel defined within the provided nChannel. More...

void	joinChannel (nChannel dest, boolean isRouted, int hopCount, String selector, boolean allowPurge) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRealmNotFoundException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nDuplicateJoinException, nIllegalArgumentException
	Sets a server based link between this channel and the channel defined within the provided nChannel. More...

void	joinChannel (nQueue dest, String selector) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nDuplicateJoinException, nIllegalArgumentException
	Sets a server based link between this channel and the queue defined by the dest parameter. More...

void	joinChannel (nQueue dest) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nDuplicateJoinException, nIllegalArgumentException
	Sets a server based link between this channel and the queue defined within the provided nQueue. More...

void	joinChannel (nQueue dest, boolean isRouted, int hopCount, String selector) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRealmNotFoundException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nDuplicateJoinException, nIllegalArgumentException
	Sets a server based link between this channel and the queue defined within the provided nQueue. More...

void	joinChannelToArchive (nQueue dest) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nDuplicateJoinException, nIllegalArgumentException
	Sets a server based link between this channel and the queue defined within the provided nQueue. More...

void	joinChannelToArchive (nQueue dest, String selector) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nDuplicateJoinException, nIllegalArgumentException
	Sets a server based link between this channel and the queue defined within the provided nQueue. More...

void	pauseSubscriber (nEventListener eventListener) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nChannelNotFoundException
	Pause the subscription of the specified nEventListener. More...

void	publish (nConsumeEvent e) throws nSessionNotConnectedException, nSessionPausedException, nIllegalArgumentException, nSecurityException, nMaxBufferSizeExceededException
	Publishes the specified nConsumeEvent to this channel. More...

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

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

void	purgeEvents (long startEID, long endEID, boolean purgeJoins) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Purges a range of events (first to last, all inclusive) from this channel. More...

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

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

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

void	removeConnectionListener () throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException
	Removes the connection listener to this channel. More...

void	removeConnectionListener (nChannelConnectionListener listener) throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException
	Removes the connection listener to this channel. More...

void	removeSubscriber (nEventListener nel) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException
	Unregisters the specified nEventListener as a subscriber from this channel. More...

void	removeSubscriber (nEventListener nel, boolean wait) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException
	Unregisters the specified nEventListener as a subscriber from this channel. More...

void	reSubscribe (String selector) throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException
	Removes the current subscriber and re-registers the nEventListener as a subscriber to this channel. More...

void	reSubscribe (long eid) throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nIllegalArgumentException
	Removes the current subscriber and registers the specified nEventListener as a subscriber to this channel. More...

void	reSubscribe (String selector, long eid) throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nIllegalArgumentException
	Removes the current subscriber and re-registers the nEventListener as a subscriber to this channel. More...

void	reSubscribe (nDurable durable, String selector) throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nSelectorParserException, nIllegalArgumentException, nNameAlreadyBoundException
	Removes the current subscriber and registers the specified nEventListener as a named subscriber to this channel. More...

void	resumeSubscriber (nEventListener eventListener) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nChannelNotFoundException
	Resumes the subscription of the specified nEventListener. More...

Public Member Functions inherited from com.pcbsys.nirvana.client.nAbstractChannel
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...

Protected Member Functions
nClientChannelList	getChannelList ()
	Gets channel list. More...

	nChannel (nChannel channel)
	Specifically for AdminApi wrappers. More...

Detailed Description

This class represents the standard Channel or Topic access to the UM server.

Constructor & Destructor Documentation

com.pcbsys.nirvana.client.nChannel.nChannel ( nChannel channel )

protected

Specifically for AdminApi wrappers.

Parameters

channel the channel to wrap

Member Function Documentation

void com.pcbsys.nirvana.client.nChannel.addConnectionListener ( nChannelConnectionListener listener ) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException

Adds a nChannelConnectionListener to this channel so that when new connections are made to this channel the listener is notified.

Parameters

listener to add

Exceptions

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., or has already been set.
nSessionPausedException	The session is currently paused, please resume
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

void com.pcbsys.nirvana.client.nChannel.addConnectionListener	(	nChannelConnectionListener	listener,
		boolean	isSync
	)		throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException

Adds a nChannelConnectionListener to this channel so that when new connections are made to this channel the listener is notified.

Parameters

listener	to add
isSync	the call is synchronous

Exceptions

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., or has already been set.
nSessionPausedException	The session is currently paused, please resume
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

void com.pcbsys.nirvana.client.nChannel.addSubscriber ( nEventListener nel ) throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException

Registers the specified nEventListener as a subscriber to this channel.

The subscriber will receive all events contained in this channel.

Parameters

nel	the nEventListener object to be registered as a subscriber

Exceptions

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.
nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
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

void com.pcbsys.nirvana.client.nChannel.addSubscriber	(	nEventListener	nel,
		long	eid
	)		throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException

Registers the specified nEventListener as a subscriber to this channel.

The subscriber will receive all events with event id greater than or equal to the one specified.

Parameters

nel	the nEventListener object to be registered as a subscriber
eid	a long specifying the subscription's start eid

Exceptions

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.
nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
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

void com.pcbsys.nirvana.client.nChannel.addSubscriber	(	nEventListener	nel,
		String	selector
	)		throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nIllegalArgumentException

Registers the specified nEventListener as a subscriber to this channel.

The subscriber will receive all events contained in this channel, apart from the ones restricted by the specified filter.

Parameters

nel	the nEventListener object to be registered as a subscriber
selector	a string specifying a filter to this subscription request

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
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
nSelectorParserException	The selector has syntax errors
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.nChannel.addSubscriber	(	nEventListener	nel,
		String	selector,
		long	eid
	)		throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nIllegalArgumentException

Registers the specified nEventListener as a subscriber to this channel.

The subscriber will receive all events with event id greater than or equeal to the one specified, apart from the ones restricted by the specified filter.

Parameters

nel	the nEventListener object to be registered as a subscriber
selector	a string specifying a filter to this subscription request
eid	a long specifying the subscription's start eid

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
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
nSelectorParserException	The selector has syntax errors
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.nChannel.addSubscriber	(	nEventListener	nel,
		nDurable	durable
	)		throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nSelectorParserException, nIllegalArgumentException, nNameAlreadyBoundException

Registers the specified nEventListener as a durable subscriber to this channel.

The subscriber will receive the events from the last acknowledged event for the durable. The auto-acknowledgment is set to false by default. See nChannel#addSubscriber(nEventListener, nDurable, String, boolean)

Parameters

nel	the nEventListener object to be registered as a subscriber
durable	nDurable specified for this subscription

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
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
nNameDoesNotExistException	if the server does not know about the durable object
nSelectorParserException	The selector has syntax errors
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.
nNameAlreadyBoundException	The name is already bound and used by another client

Since: 9.12

void com.pcbsys.nirvana.client.nChannel.addSubscriber	(	nEventListener	nel,
		nDurable	durable,
		String	selector,
		boolean	AutoAck
	)		throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nSelectorParserException, nIllegalArgumentException, nNameAlreadyBoundException

Registers the specified nEventListener as a durable subscriber to this channel.

The subscriber will receive events from the last acknowledged event for the durable

Parameters

nel	the nEventListener object to be registered as a subscriber
durable	nDurable specified for this subscription
selector	a string specifying a filter to this subscription request
AutoAck	a boolean used to control whether the nirvana client will automatically ack events

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
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
nNameDoesNotExistException	if the server does not know about the durable object
nSelectorParserException	The selector has syntax errors
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.
nNameAlreadyBoundException	The name is already bound and used by another client

Since: 9.12

void com.pcbsys.nirvana.client.nChannel.addSubscriber	(	nEventListener	nel,
		nDurable	durable,
		String	selector,
		int	windowSize
	)		throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nSelectorParserException, nIllegalArgumentException, nNameAlreadyBoundException

Registers the specified nEventListener as a durable subscriber to this channel.

The subscriber will receive the events from the last acknowledged event for the durable. The auto-acknowledgment is set to false by default.

Parameters

nel	the nEventListener object to be registered as a subscriber
durable	nDurable specified for this subscription
selector	a string specifying a filter to this subscription request
windowSize	the amount of events that the user is allowed to receive before a commit or rollback is required, this property is only valid for shared/Serial durable type

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
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
nNameDoesNotExistException	if the server does not know about the durable object
nSelectorParserException	The selector has syntax errors
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.
nNameAlreadyBoundException	The name is already bound and used by another client

Since: 9.12

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator ( ) throws nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException

Create a default channel iterator starting at the beginning of the channel.

Returns: nChannelIterator for the current channel

Exceptions

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.

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator ( String selector ) throws nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nSelectorParserException

Create a default channel iterator starting at the beginning of the channel with the events which match the selector being returned.

Parameters

selector Used to specify a sub set of the current channel events

Returns: nChannelIterator for the current channel

Exceptions

nSessionPausedException	The session is currently paused
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nSelectorParserException	The selector has syntax errors
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information.

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator ( long startEID ) throws nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException

Create a default channel iterator starting at the EID specified.

Parameters

startEID The event to start iterating the channel from

Returns: nChannelIterator for the current channel

Exceptions

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.

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator	(	long	startEID,
		boolean	autoAck
	)		throws nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException

Create a default channel iterator starting at the EID specified.

Parameters

startEID	The event to start iterating the channel from
autoAck	Specifies whether the channel iterator requires acknowledgment - default is auto ack true

Returns: nChannelIterator for the current channel

Exceptions

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.

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator	(	String	selector,
		long	startEID
	)		throws nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException, nSelectorParserException

Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned.

Parameters

selector	Used to specify a sub set of the current channel events
startEID	The event to start iterating the channel from

Returns: nChannelIterator for the current channel

Exceptions

nSessionPausedException	The session is currently paused
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nSelectorParserException	The selector has syntax errors
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information.

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator	(	String	selector,
		long	startEID,
		boolean	autoAck
	)		throws nUnexpectedResponseException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nSelectorParserException

Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned.

Parameters

selector	Used to specify a sub set of the current channel events
startEID	The event to start iterating the channel from
autoAck	Specifies whether the channel iterator requires acknowledgment - default is auto ack true

Returns: nChannelIterator for the current channel

Exceptions

nSessionPausedException	The session is currently paused
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nSelectorParserException	The selector has syntax errors
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information.

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator ( nDurable name ) throws nIllegalArgumentException, nNameAlreadyBoundException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException

Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned.

Parameters

name	Named Object reference to use for this iterator

Returns: nChannelIterator for the current channel

Exceptions

nIllegalArgumentException	nIllegalArgumentException.
nSessionPausedException	The session is currently
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nNameAlreadyBoundException	The name is already bound and used by another client
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information.

Since: 9.12

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator	(	nDurable	name,
		String	selector
	)		throws nIllegalArgumentException, nNameAlreadyBoundException, nSelectorParserException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException

Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned.

Parameters

name	Named Object reference to use for this iterator
selector	Used to specify a sub set of the current channel events

Returns: nChannelIterator for the current channel

Exceptions

nIllegalArgumentException	the nIllegalArgumentException
nSessionPausedException	The session is currently paused
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nNameAlreadyBoundException	The name is already bound and used by another client
nSelectorParserException	The selector has syntax errors
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information.

Since: 9.12

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator	(	nDurable	name,
		String	selector,
		int	windowSize
	)		throws nIllegalArgumentException, nNameAlreadyBoundException, nSelectorParserException, nSessionPausedException, nSessionNotConnectedException, nUnexpectedResponseException, nRequestTimedOutException

create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned

Parameters

name	named object reference to use for this iterator
selector	used to specify a sub set of the current channel events
windowSize	specifies the amount of events that the user is allowed to receive before a commit or rollback is required this property is only valid for shared/Serial durable type named objects. Infinite window size can be specified using nChannelIterator.infinite_window.

Returns: nChannelIterator for the current channel

Exceptions

nIllegalArgumentException	thrown in case an illegal argument is passed- when window size is specified for not shared named objects or 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
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nNameAlreadyBoundException	The name is already bound and used by another client
nSelectorParserException	The selector has syntax errors
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information.

Since: 9.12

Deprecated:: As of 10.7 this has been deprecated, since window size is no longer relevant to synchronous consumers. Therefore, the provided windowSize parameter will be ignored.

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator	(	nDurable	name,
		String	selector,
		int	windowSize,
		boolean	autoAck
	)		throws nIllegalArgumentException, nNameAlreadyBoundException, nSelectorParserException, nUnexpectedResponseException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException

create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned

Parameters

name	named object reference to use for this iterator
selector	used to specify a sub set of the current channel events
windowSize	specifies the amount of events that the user is allowed to receive before a commit or rollback is required. This property is only valid for Shared/Serial durable type durable objects. infinite window size can be specified using nChannelIterator.infinite_window.
autoAck	If true then the server and client will assume any event delivered is acked, else the client will manually need to ack the events

Returns: nChannelIterator for the current channel

Exceptions

nIllegalArgumentException	thrown in case an illegal argument is passed- when window size is specified for not shared named objects or 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
nSessionNotConnectedException	The session is not currently connected to the server
nRequestTimedOutException	if the request exceeded the timeout value
nNameAlreadyBoundException	The name is already bound and used by another client
nSelectorParserException	The selector has syntax errors
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information.

Since: 9.12

Deprecated:: As of 10.7 this has been deprecated, since window size is no longer relevant to synchronous consumers. Therefore, the provided windowSize parameter will be ignored.

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator	(	nDurable	name,
		String	selector,
		boolean	autoAck
	)		throws nIllegalArgumentException, nNameAlreadyBoundException, nSelectorParserException, nUnexpectedResponseException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException

create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned

Parameters

name	named object reference to use for this iterator
selector	used to specify a sub set of the current channel events
autoAck	If true then the server and client will assume any event delivered is acked, else the client will manually need to ack the events

Returns: nChannelIterator for the current channel

Exceptions

nIllegalArgumentException thrown in case an illegal argument is passed- when 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.

Since: 10.7

nRegisteredEvent com.pcbsys.nirvana.client.nChannel.createRegisteredEvent ( Object keyValue ) throws nIllegalArgumentException

Creates a new nRegisteredEvent bound to this channel using the keyValue as its unique id.

Parameters

keyValue Unique Id to use for the nRegisteredEvent

Returns: nRegisteredEvent nRegisteredEvent

Exceptions

nIllegalArgumentException if unable to create the nRegisteredEvent object, 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

nRegisteredEvent com.pcbsys.nirvana.client.nChannel.createRegisteredEvent	(	Object	keyValue,
		boolean	isTransactional
	)		throws nIllegalArgumentException

Creates a new nRegisteredEvent bound to this channel using the keyValue as its unique id.

Parameters

keyValue	Unique Id to use for the nRegisteredEvent
isTransactional	Indicates that all commits on the nRegisteredEvent should use transactional semantics

Returns: nRegisteredEvent nRegisteredEvent

Exceptions

nIllegalArgumentException if unable to create the nRegisteredEvent object, 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.nChannel.deleteJoin ( nChannel destination ) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

Deletes a join between this channel and the channel referenced in the destination parameter.

Parameters

destination This is an nChannel object referencing the destination channel

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nSessionNotConnectedException	The session is not currently connected to the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused
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.nChannel.deleteJoin ( nQueue destination ) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

Deletes a join between this channel and the queue referenced in the destination parameter.

Parameters

destination This is an nQueue object referencing the destination queue

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the queue no longer exists
nSessionNotConnectedException	The session is not currently connected to the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused
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.

nChannelAttributes com.pcbsys.nirvana.client.nChannel.getChannelAttributes ( )

Gets the channels local attributes.

Returns: The associated nChannelAttributes object specifying the channel attributes

nClientChannelList com.pcbsys.nirvana.client.nChannel.getChannelList ( )

protected

Gets channel list.

Returns: the channel list

nDurableManager com.pcbsys.nirvana.client.nChannel.getDurableManager ( )

Gets durable manager.

Returns: the durable manager for channel.

long com.pcbsys.nirvana.client.nChannel.getEventCount ( ) throws nChannelNotFoundException, nSecurityException, nSessionNotConnectedException, nRequestTimedOutException, nSessionPausedException, nUnexpectedResponseException

Gets the number of events on this channel.

Returns: a long specifying the number of events on this channel

Exceptions

nChannelNotFoundException	the n channel not found exception
nSecurityException	the n security exception
nSessionNotConnectedException	the n session not connected exception
nRequestTimedOutException	the n request timed out exception
nSessionPausedException	the n session paused exception
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.

long com.pcbsys.nirvana.client.nChannel.getLastEID ( ) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException

Gets the last event id of this channel.

Returns: a long specifying the last event id of this channel

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nSessionNotConnectedException	The session is not currently connected to the server
nSessionPausedException	The session is currently paused
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.

long com.pcbsys.nirvana.client.nChannel.getLastStoredEID ( ) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException

Gets the last event id of this channel.

Returns: a long specifying the last event id stored on this channel

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nSessionNotConnectedException	The session is not currently connected to the server
nSessionPausedException	The session is currently paused
nRequestTimedOutException	if the request exceeded the timeout value

String com.pcbsys.nirvana.client.nChannel.getName ( )

Gets the name of this channel.

Returns: a string specifying the name of this channel

int com.pcbsys.nirvana.client.nChannel.getType ( )

Gets the type of this channel Currently supported types are:

nChanneAttributes.MIXED_TYPE
nChanneAttributes.PERSISTENT_TYPE
nChanneAttributes.RELIABLE_TYPE

Returns: an int specifying the channel's type, which will be equal to one of : nChanneAttributes.MIXED_TYPE, nChanneAttributes.PERSISTENT_TYPE, nChanneAttributes.RELIABLE_TYPE

See Also: nChannelAttributes

boolean com.pcbsys.nirvana.client.nChannel.isSubscribed ( )

Determines whether the underlying channel is currently being subscribed to.

Returns: true if the channel object is currently subscribed to

boolean com.pcbsys.nirvana.client.nChannel.isSubscriberPaused ( nEventListener eventListener ) throws nIllegalArgumentException

Returns true if the subscription of the specified nEventListener object is paused.

Parameters

eventListener the nEventListener object registered as a subscriber

Exceptions

nIllegalArgumentException if the provided nEventListener is null or does not belong to the channel

void com.pcbsys.nirvana.client.nChannel.joinChannel	(	nChannel	dest,
		String	selector
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRealmNotFoundException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nDuplicateJoinException, nIllegalArgumentException

Sets a server based link between this channel and the channel defined within the provided nChannel.

The link has a filter applied to it, defined by the provided selector string

Parameters

dest	a nChannel object defining the channel to be joined (linked) to this channel
selector	A string defining a filter that will be applied in the join (link) of these 2 channels

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
nSelectorParserException	The selector has syntax errors
nDuplicateJoinException	The join already exists on the server
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.nChannel.joinChannel ( nChannel dest ) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRealmNotFoundException, nRequestTimedOutException, nUnexpectedResponseException, nDuplicateJoinException, nIllegalArgumentException

Sets a server based link between this channel and the channel defined within the provided nChannel.

Parameters

dest	a nChannel object defining the channel to be joined (linked) to this channel

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
nDuplicateJoinException	The join already exists on the server
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.nChannel.joinChannel	(	nChannel	dest,
		boolean	isRouted,
		int	hopCount,
		String	selector
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRealmNotFoundException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nDuplicateJoinException, nIllegalArgumentException

Sets a server based link between this channel and the channel defined within the provided nChannel.

Additional parameters specify whether the event is routable or not, the maximum number of hops the event can pass through and the filter applied to the join (link).

Parameters

dest	a nChannel object defining the channel to be joined (linked) to this channel
isRouted	a boolean flag specifying whether the event will be routed or not
hopCount	an int specifying the maximum number of hops the event can pass through
selector	A string defining a filter that will be applied in the join (link) of these 2 channels

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
nSelectorParserException	The selector has syntax errors
nDuplicateJoinException	The join already exists on the server
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.nChannel.joinChannel	(	nChannel	dest,
		boolean	isRouted,
		int	hopCount,
		String	selector,
		boolean	allowPurge
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRealmNotFoundException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nDuplicateJoinException, nIllegalArgumentException

Sets a server based link between this channel and the channel defined within the provided nChannel.

Additional parameters specify whether the event is routable or not, the maximum number of hops the event can pass through and the filter applied to the join (link).

Parameters

dest	a nChannel object defining the channel to be joined (linked) to this channel
isRouted	a boolean flag specifying whether the event will be routed or not
hopCount	an int specifying the maximum number of hops the event can pass through
selector	A string defining a filter that will be applied in the join (link) of these 2 channels
allowPurge	if allow purge is true then when the source channel is purged events source from it will also be purged

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
nSelectorParserException	The selector has syntax errors
nDuplicateJoinException	The join already exists on the server
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.nChannel.joinChannel	(	nQueue	dest,
		String	selector
	)		throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nDuplicateJoinException, nIllegalArgumentException

Sets a server based link between this channel and the queue defined by the dest parameter.

Additional parameter specifies the filter applied to the join (link).

Parameters

dest	a nQueue object defining the queue to be joined (linked) to this channel
selector	A string defining a filter that will be applied in the join (link) from the source channel

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nSessionNotConnectedException	The session is not currently connected to the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused
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
nSelectorParserException	The selector has syntax errors
nDuplicateJoinException	The join already exists on the server
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.nChannel.joinChannel ( nQueue dest ) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nDuplicateJoinException, nIllegalArgumentException

Sets a server based link between this channel and the queue defined within the provided nQueue.

The link has a filter applied to it, defined by the provided selector string

Parameters

dest	a nQueue object defining the queue to be joined (linked) to this channel

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nSessionNotConnectedException	The session is not currently connected to the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused
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
nDuplicateJoinException	The join already exists on the server
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.nChannel.joinChannel	(	nQueue	dest,
		boolean	isRouted,
		int	hopCount,
		String	selector
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRealmNotFoundException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nDuplicateJoinException, nIllegalArgumentException

Sets a server based link between this channel and the queue defined within the provided nQueue.

Additional parameters specify whether the event is routable or not, the maximum number of hops the event can pass through and the filter applied to the join (link).

Parameters

dest	a nQueue object defining the queue to be joined (linked) to this channel
isRouted	a boolean flag specifying whether the event will be routed or not
hopCount	an int specifying the maximum number of hops the event can pass through
selector	A string defining a filter that will be applied in the join (link) from the source channel

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
nSelectorParserException	The selector has syntax errors
nDuplicateJoinException	The join already exists on the server
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.nChannel.joinChannelToArchive ( nQueue dest ) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nDuplicateJoinException, nIllegalArgumentException

Sets a server based link between this channel and the queue defined within the provided nQueue.

Events will NOT be checked for duplicates since this is an archive join, any events that are published to the source will appear in the destination queue. This may result in duplicate events in the queue if the queue has multiple sources. This is by design.

Parameters

dest	a nQueue object defining the queue to be joined (linked) to this channel

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nSessionNotConnectedException	The session is not currently connected to the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused
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
nDuplicateJoinException	The join already exists on the server
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.nChannel.joinChannelToArchive	(	nQueue	dest,
		String	selector
	)		throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nDuplicateJoinException, nIllegalArgumentException

Sets a server based link between this channel and the queue defined within the provided nQueue.

The link has a filter applied to it, defined by the provided selector string.Events will NOT be checked for duplicates since this is an archive join, any events that are published to the source will appear in the destination queue. This may result in duplicate events in the queue if the queue has multiple sources. This is by design.

Parameters

dest	a nQueue object defining the queue to be joined (linked) to this channel
selector	A string defining a filter that will be applied in the join (link) from the source channel

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nSessionNotConnectedException	The session is not currently connected to the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused
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
nDuplicateJoinException	The join already exists on the server
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.nChannel.pauseSubscriber ( nEventListener eventListener ) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nChannelNotFoundException

Pause the subscription of the specified nEventListener.

This means that no new events will be received from the server until the subscription is resumed. All events that have already been received will be processed normally.

Parameters

eventListener the nEventListener object registered as a subscriber

Exceptions

nIllegalArgumentException	if the provided nEventListener is null or does not belong to the channel
nSessionPausedException	The session is currently paused, please resume
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 which we can not deal with, see the message for further information
nNameDoesNotExistException	if the server does not know about the named object
nChannelNotFoundException	The specified channel could not be found

Since: 10.7

void com.pcbsys.nirvana.client.nChannel.publish ( nConsumeEvent e ) throws nSessionNotConnectedException, nSessionPausedException, nIllegalArgumentException, nSecurityException, nMaxBufferSizeExceededException

Publishes the specified nConsumeEvent to this channel.

Parameters

e	the nConsumeEvent object to be published to this channel

Exceptions

nSessionNotConnectedException	The session is not currently connected to the server
nSessionPausedException	The session is currently paused
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.
nSecurityException	is thrown if the caller has insufficient permissions
nMaxBufferSizeExceededException	is thrown when elements of the event being sent exceed the connection's max buffer size

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

Purges a single event from this channel.

Parameters

eidval	a long specifying the event id of the event to be purged from the channel
purgeJoins	a boolean specifying if the event will be removed from all subsequent joins

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
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.nChannel.purgeEventAsync	(	long	eidval,
		boolean	purgeJoins
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

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

Parameters

eidval	a long specifying the event id of the event to be purged from the channel
purgeJoins	a boolean specifying if the event will be removed from all subsequent joins

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
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.nChannel.purgeEvents	(	long	startEID,
		long	endEID,
		boolean	purgeJoins
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

Purges a range of events (first to last, all inclusive) from this channel.

Parameters

startEID	a long specifying the event id of the first event to be purged from the channel
endEID	a long specifying the event id of the last event to be purged from the channel
purgeJoins	a boolean specifying if the events will be removed from all subsequent joins

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
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.nChannel.purgeEvents	(	long	startEID,
		long	endEID,
		String	selector,
		boolean	purgeJoins
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

Purges a range of events from this channel.

Parameters

startEID	a long specifying the start event id of the range of events to be purged from the channel
endEID	a long specifying the end event id of the range of events to be purged from the channel
selector	A messages selector which will be used to filter out only the events which match this criteria
purgeJoins	a boolean specifying if the events will be removed from all subsequent joins

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
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.nChannel.purgeEventsAsync	(	long	startEID,
		long	endEID,
		boolean	purgeJoins
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

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

Parameters

startEID	a long specifying the start event id of the range of events to be purged from the channel
endEID	a long specifying the end event id of the range of events to be purged from the channel
purgeJoins	a boolean specifying if the events will be removed from all subsequent joins

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
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.nChannel.purgeEventsAsync	(	long	startEID,
		long	endEID,
		String	selector,
		boolean	purgeJoins
	)		throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

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

Parameters

startEID	a long specifying the start event id of the range of events to be purged from the channel
endEID	a long specifying the end event id of the range of events to be purged from the channel
selector	A messages selector which will be used to filter out only the events which match this criteria
purgeJoins	a boolean specifying if the event will be removed from all subsequent joins

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
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.nChannel.removeConnectionListener ( ) throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException

Removes the connection listener to this channel.

Exceptions

nSessionNotConnectedException	The session is not currently connected to the server
nSessionPausedException	The session is currently paused, please resume
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

void com.pcbsys.nirvana.client.nChannel.removeConnectionListener ( nChannelConnectionListener listener ) throws nSessionNotConnectedException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException

Removes the connection listener to this channel.

Parameters

listener remove the listener

Exceptions

nSessionNotConnectedException	The session is not currently connected to the server
nSessionPausedException	The session is currently paused, please resume
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

void com.pcbsys.nirvana.client.nChannel.removeSubscriber ( nEventListener nel ) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException

Unregisters the specified nEventListener as a subscriber from this channel.

The subscriber will not receive any more events.

Parameters

nel	the nEventListener object to be registered as a subscriber

Exceptions

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.
nSessionPausedException	The session is currently paused, please resume
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

void com.pcbsys.nirvana.client.nChannel.removeSubscriber	(	nEventListener	nel,
		boolean	wait
	)		throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException

Unregisters the specified nEventListener as a subscriber from this channel.

The subscriber will not receive any more events.

Parameters

nel	the nEventListener object to be registered as a subscriber
wait	whether to perform the remove synchronously

Exceptions

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.
nSessionPausedException	The session is currently paused, please resume
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

void com.pcbsys.nirvana.client.nChannel.reSubscribe ( String selector ) throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException

Removes the current subscriber and re-registers the nEventListener as a subscriber to this channel.

The subscriber will receive all events on the channel apart from the ones restricted by the specified filter.

Parameters

selector a string specifying a filter to this subscription request

Exceptions

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.
nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
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

void com.pcbsys.nirvana.client.nChannel.reSubscribe ( long eid ) throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nIllegalArgumentException

Removes the current subscriber and registers the specified nEventListener as a subscriber to this channel.

The subscriber will receive all events with event id greater than or equal to the one specified

Parameters

eid	a long specifying the subscription's start eid

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
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
nSelectorParserException	The selector has syntax errors
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.nChannel.reSubscribe	(	String	selector,
		long	eid
	)		throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nSelectorParserException, nIllegalArgumentException

Removes the current subscriber and re-registers the nEventListener as a subscriber to this channel.

The subscriber will receive all events with event id greater than or equal to the one specified, apart from the ones restricted by the specified filter.

Parameters

selector	a string specifying a filter to this subscription request
eid	a long specifying the subscription's start eid

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
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
nSelectorParserException	The selector has syntax errors
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.nChannel.reSubscribe	(	nDurable	durable,
		String	selector
	)		throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nSelectorParserException, nIllegalArgumentException, nNameAlreadyBoundException

Removes the current subscriber and registers the specified nEventListener as a named subscriber to this channel.

The subscriber will receive all events from the last acknowledged event for the name supplied If the name is new it will start from the END of the channel.

Parameters

durable	a named object for this subscription
selector	a string specifying a filter to this subscription request

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
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
nNameDoesNotExistException	if the server does not know about the named object
nSelectorParserException	The selector has syntax errors
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.
nNameAlreadyBoundException	The name is already bound and used by another client

Since: 9.12

void com.pcbsys.nirvana.client.nChannel.resumeSubscriber ( nEventListener eventListener ) throws nIllegalArgumentException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nChannelNotFoundException

Resumes the subscription of the specified nEventListener.

See Also: nChannel#pauseSubscriber(nEventListener)

Parameters

eventListener the nEventListener object registered as a subscriber

Exceptions

nIllegalArgumentException	if the provided nEventListener is null or does not belong to the channel
nSessionPausedException	The session is currently paused, please resume
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 which we can not deal with, see the message for further information
nNameDoesNotExistException	if the server does not know about the named object
nChannelNotFoundException	The specified channel could not be found

Since: 10.7

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation