This class is a Nirvana channel, offering the Nirvana channel related services. 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, nNamedObject name, String selector, boolean AutoAck) throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nSelectorParserException, nIllegalArgumentException, nNameAlreadyBoundException
	Registers the specified nEventListener as a named subscriber to this channel. More...

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

void	addSubscriber (nSignedEventListener nel, nNamedObject name, String selector, nMessageValidator validator, boolean AutoAck) throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameAlreadyBoundException
	Registers the specified nSignedEventListener as a named subscriber to this channel. More...

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

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

void	addSubscriber (nSignedEventListener nel, nNamedObject name, String selector, nMessageValidator validator, boolean AutoAck, nNamedPriorityListener listener) throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameAlreadyBoundException
	Registers the specified nSignedEventListener as a named subscriber to this channel. More...

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

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

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

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

nChannelIterator	createIterator ()
	Create a default channel iterator starting at the beginning of the channel. More...

nChannelIterator	createIterator (String selector)
	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)
	Create a default channel iterator starting at the EID specified. More...

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

nChannelIterator	createIterator (String selector, long startEID)
	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)
	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 (nNamedObject name)
	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 (nNamedObject name, String selector)
	Create a default channel iterator starting at the eid specified in the channel with the events which match the selector being returned. More...

nNamedObject	createNamedObject (String name) throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException
	Creates a named object on the channel with the given name. More...

nNamedObject	createNamedObject (String name, long startEID) throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException
	Creates a named object on the channel with the given name. More...

nNamedObject	createNamedObject (String name, long startEID, boolean persistent) throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException
	Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not. More...

nNamedObject	createNamedObject (String name, boolean persistent) throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException
	Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not. More...

nNamedObject	createNamedObject (String name, boolean persistent, boolean clusterWide) throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException
	Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not. More...

nNamedObject	createNamedObject (String name, long startEID, boolean persistent, boolean clusterWide) throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException
	Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not. More...

nNamedObject	createNamedObject (String name, long startEID, boolean persistent, boolean clusterWide, boolean enablePriority) throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException
	Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not. 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...

nNamedObject	createSharedNamedObject (String name, boolean persistent, boolean clusterWide, long startEID) throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException
	Creates a named object on the channel with the given name. More...

void	deleteJoin (String destinationChannel) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Deletes a link between this channel and the supplied destination channel. 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...

void	delNamedObject (nNamedObject name) throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nNameDoesNotExistException, nRequestTimedOutException, nUnexpectedResponseException
	Removes all references for this name on the realm Server. More...

void	delNamedObject (String name) throws nIllegalArgumentException, nSecurityException, nSessionPausedException, nChannelNotFoundException, nSessionNotConnectedException, nNameDoesNotExistException, nRequestTimedOutException, nUnexpectedResponseException
	Removes all references for this name on the realm Server. More...

com.pcbsys.nirvana.client.nChannelAttributes	getChannelAttributes ()
	Gets the channels local attributes. More...

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...

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...

nNamedObject	getNamedObject (String name) throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameDoesNotExistException, nRequestTimedOutException, nUnexpectedResponseException
	Returns an instance of the nNamedObject refernced by the parameter. More...

nNamedObject[]	getNamedObjects () throws nSecurityException, nSessionPausedException, nChannelNotFoundException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException
	Returns an array of all known nNamedObjects registered with 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...

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	publish (String tag, Document adom) throws nSessionNotConnectedException, nSessionPausedException, nIllegalArgumentException, nSecurityException
	Publishes the specified XML DOM document to this channel with the specified tag. More...

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

void	publish (String tag, Document adom, nMessageSigner signer) throws nSessionNotConnectedException, nSessionPausedException, nIllegalArgumentException, nSecurityException
	Publishes the specified XML DOM document to this channel with the specified tag. More...

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

void	purgeEvent (long eidval) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Purges a single event from 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) 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	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) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Purges a range of events from this channel. More...

void	purgeEvents (long startEID, long endEID, String selector) throws nSecurityException, nChannelNotFoundException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException
	Purges a range of events 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) 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, 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) 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 (nNamedObject name, 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	unbindNamedObject (nNamedObject name) throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nNameDoesNotExistException, nRequestTimedOutException, nUnexpectedResponseException
	Unbinds the named object from the current connection. More...

void	unbindNamedObject (String name) throws nIllegalArgumentException, nSecurityException, nSessionPausedException, nChannelNotFoundException, nSessionNotConnectedException, nNameDoesNotExistException, nRequestTimedOutException, nUnexpectedResponseException
	Unbinds the named object from the current connection. More...

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

void	updateProtobufDefinitions (byte[][] descriptors) throws nIllegalArgumentException, nSessionNotConnectedException, nRequestTimedOutException, nSessionPausedException
	Update the Protocol Buffer definition for the store. More...

Detailed Description

This class is a Nirvana channel, offering the Nirvana channel related services.

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

nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits, or has already been set.
nSessionPausedException	The session is currently paused, please resume

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

nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits, or has already been set.
nSessionPausedException	The session is currently paused, please resume

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

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session

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 equeal 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

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nSessionPausedException	The session is currently paused

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

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

nel	the nEventListener object to be registered as a subscriber
name	an nNamedObject specifying a name 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 or if the user will ack events later

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nNameAlreadyBoundException	The name is already bound and used by another client
nSessionPausedException	The session is currently paused
nNameDoesNotExistException	if the server does not know about the named object

void com.pcbsys.nirvana.client.nChannel.addSubscriber	(	nEventListener	nel,
		nNamedObject	name
	)		throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nSelectorParserException, nIllegalArgumentException, nNameAlreadyBoundException

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

nel	the nEventListener object to be registered as a subscriber
name	a nNamedObject specifying a name for this subscription

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nNameAlreadyBoundException	The name is already bound and used by another client
nSessionPausedException	The session is currently paused
nNameDoesNotExistException	if the server does not know about the named object

void com.pcbsys.nirvana.client.nChannel.addSubscriber	(	nSignedEventListener	nel,
		nNamedObject	name,
		String	selector,
		nMessageValidator	validator,
		boolean	AutoAck
	)		throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameAlreadyBoundException

Registers the specified nSignedEventListener 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

nel	the nSignedEventListener object to be registered as a subscriber
name	an nNamedObject specifying a name for this subscription
selector	a string specifying a filter to this subscription request
validator	used to check the validity of the event being delivered
AutoAck	a boolean used to control whether the nirvana client will automatically ack events or if the user will ack events later

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nNameAlreadyBoundException	The name is already bound and used by another client
nSessionPausedException	The session is currently paused

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

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

nel	the nEventListener object to be registered as a subscriber
name	an nNamedObject specifying a name 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 or if the user will ack events later
listener	a nNamedPriorityListener which is called back when this subscription reaches the top of the queue and is now the top priority to receive events

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nNameAlreadyBoundException	The name is already bound and used by another client
nSessionPausedException	The session is currently paused
nNameDoesNotExistException	if the server does not know about the named object

void com.pcbsys.nirvana.client.nChannel.addSubscriber	(	nEventListener	nel,
		nNamedObject	name,
		nNamedPriorityListener	listener
	)		throws nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameDoesNotExistException, nSelectorParserException, nIllegalArgumentException, nNameAlreadyBoundException

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

nel	the nEventListener object to be registered as a subscriber
name	a nNamedObject specifying a name for this subscription
listener	a nNamedPriorityListener which is called back when this subscription reaches the top of the queue and is now the top priority to receive events

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nNameAlreadyBoundException	The name is already bound and used by another client
nSessionPausedException	The session is currently paused
nNameDoesNotExistException	if the server does not know about the named object

void com.pcbsys.nirvana.client.nChannel.addSubscriber	(	nSignedEventListener	nel,
		nNamedObject	name,
		String	selector,
		nMessageValidator	validator,
		boolean	AutoAck,
		nNamedPriorityListener	listener
	)		throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nChannelAlreadySubscribedException, nSessionPausedException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException, nNameAlreadyBoundException

Registers the specified nSignedEventListener 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

nel	the nSignedEventListener object to be registered as a subscriber
name	an nNamedObject specifying a name for this subscription
selector	a string specifying a filter to this subscription request
validator	used to check the validity of the event being delivered
AutoAck	a boolean used to control whether the nirvana client will automatically ack events or if the user will ack events later
listener	a nNamedPriorityListener which is called back when this subscription reaches the top of the queue and is now the top priority to receive events

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nNameAlreadyBoundException	The name is already bound and used by another client
nSessionPausedException	The session is currently paused

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

Registers the specified nSignedEventListener as a subscriber to this channel.

The subscriber will receive all events contained in this channel.

Parameters

nel	the nSignedEventListener object to be registered as a subscriber
validator	Message Validator object used to check the events signature

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nSessionPausedException	The session is currently paused, please resume

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

Registers the specified nSignedEventListener as a subscriber to this channel.

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

Parameters

nel	the nSignedEventListener object to be registered as a subscriber
eid	a long specifying the subscription's start eid
validator	Message Validator object used to check the events signature

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nSessionPausedException	The session is currently paused, please resume

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

Registers the specified nSignedEventListener 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 nSignedEventListener object to be registered as a subscriber
selector	a string specifying a filter to this subscription request
validator	Message Validator object used to check the events signature

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nSessionPausedException	The session is currently paused, please resume

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

Registers the specified nSignedEventListener 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 nSignedEventListener 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
validator	Message Validator object used to check the events signature

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nSessionPausedException	The session is currently paused, please resume

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator ( )

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

Returns: nChannelIterator for the current channel

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator ( String selector )

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

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator ( long startEID )

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

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator	(	long	startEID,
		boolean	autoAck
	)

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

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator	(	String	selector,
		long	startEID
	)

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

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator	(	String	selector,
		long	startEID,
		boolean	autoAck
	)

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

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator ( nNamedObject name )

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

nChannelIterator com.pcbsys.nirvana.client.nChannel.createIterator	(	nNamedObject	name,
		String	selector
	)

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
name	Named Object reference to use for this iterator

Returns: nChannelIterator for the current channel

nNamedObject com.pcbsys.nirvana.client.nChannel.createNamedObject ( String name ) throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException

Creates a named object on the channel with the given name.

Parameters

name to create

Returns: the nNamedObject created

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nNameAlreadyBoundException	If the name is already in use
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused, please resume

nNamedObject com.pcbsys.nirvana.client.nChannel.createNamedObject	(	String	name,
		long	startEID
	)		throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException

Creates a named object on the channel with the given name.

Parameters

name	to create
startEID	event EID to start the named object from

Returns: the nNamedObject created

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nNameAlreadyBoundException	If the name is already in use
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused, please resume

nNamedObject com.pcbsys.nirvana.client.nChannel.createNamedObject	(	String	name,
		long	startEID,
		boolean	persistent
	)		throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException

Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.

Parameters

name	to create
startEID	event EID to start the named object from
persistent	flag to indicate to the server where to store it

Returns: the nNamedObject created

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nNameAlreadyBoundException	If the name is already in use
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused, please resume

nNamedObject com.pcbsys.nirvana.client.nChannel.createNamedObject	(	String	name,
		boolean	persistent
	)		throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException

Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.

Parameters

name	to create
persistent	flag to indicate to the server where to store it

Returns: the nNamedObject created

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nNameAlreadyBoundException	If the name is already in use
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused, please resume

nNamedObject com.pcbsys.nirvana.client.nChannel.createNamedObject	(	String	name,
		boolean	persistent,
		boolean	clusterWide
	)		throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException

Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.

Parameters

name	to create
persistent	flag to indicate to the server where to store it
clusterWide	flag to indicate if this named object is valid in the entire cluster

Returns: the nNamedObject created

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nNameAlreadyBoundException	If the name is already in use
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused, please resume

nNamedObject com.pcbsys.nirvana.client.nChannel.createNamedObject	(	String	name,
		long	startEID,
		boolean	persistent,
		boolean	clusterWide
	)		throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException

Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.

Parameters

name	to create
startEID	event EID to start the named object from
persistent	flag to indicate to the server where to store it
clusterWide	flag to indicate if this named object is valid in the entire cluster

Returns: the nNamedObject created

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nNameAlreadyBoundException	If the name is already in use
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused, please resume

nNamedObject com.pcbsys.nirvana.client.nChannel.createNamedObject	(	String	name,
		long	startEID,
		boolean	persistent,
		boolean	clusterWide,
		boolean	enablePriority
	)		throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException

Creates a named object on the channel with the given name and depending on the persistent flag informs the server to store the name and value to disk or not.

Parameters

name	to create
startEID	event EID to start the named object from
persistent	flag to indicate to the server where to store it
clusterWide	flag to indicate if this named object is valid in the entire cluster
enablePriority	flag to indicate if multiple subscriptions will be prioritized on this object

Returns: the nNamedObject created

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nNameAlreadyBoundException	If the name is already in use
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused, please resume

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 Unquie Id to use for the nRegisteredEvent

Returns: nRegistedEvent

Exceptions

nIllegalArgumentException if unable to create the nRegisteredEvent object

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	Unquie Id to use for the nRegisteredEvent
isTransactional	Indicates that all commits on the nRegistedEvent should use transactional symantics

Returns: nRegistedEvent

Exceptions

nIllegalArgumentException if unable to create the nRegisteredEvent object

nNamedObject com.pcbsys.nirvana.client.nChannel.createSharedNamedObject	(	String	name,
		boolean	persistent,
		boolean	clusterWide,
		long	startEID
	)		throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameAlreadyBoundException, nRequestTimedOutException, nUnexpectedResponseException

Creates a named object on the channel with the given name.

Parameters

name	to create
persistent	if true then the named object will be backed up on disk
clusterWide	flag to indicate if this named object is valid in the entire cluster
startEID	event EID to start the named object from

Returns: the nNamedObject created

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nNameAlreadyBoundException	If the name is already in use
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused, please resume

void com.pcbsys.nirvana.client.nChannel.deleteJoin ( String destinationChannel ) throws nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nRealmNotFoundException, nSessionPausedException, nRequestTimedOutException, nUnexpectedResponseException, nIllegalArgumentException

Deletes a link between this channel and the supplied destination channel.

Parameters

destinationChannel a nChannelAttributes 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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

Deprecated:: As of version 2.0. This function can not remove joins where the destination is higher in the namespace. The prefered method is deleteJoin(nChannel dest) where this channel is the source

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nChannel.delNamedObject ( nNamedObject name ) throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nNameDoesNotExistException, nRequestTimedOutException, nUnexpectedResponseException

Removes all references for this name on the realm Server.

Parameters

name	the name to be removed from the server

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nNameDoesNotExistException	The name specified does not exist on the server
nSessionPausedException	The session is currently paused, please resume

void com.pcbsys.nirvana.client.nChannel.delNamedObject ( String name ) throws nIllegalArgumentException, nSecurityException, nSessionPausedException, nChannelNotFoundException, nSessionNotConnectedException, nNameDoesNotExistException, nRequestTimedOutException, nUnexpectedResponseException

Removes all references for this name on the realm Server.

Parameters

name	the name to be removed from the server

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nNameDoesNotExistException	The name specified does not exist on the server
nSessionPausedException	The session is currently paused, please resume

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

Gets the channels local attributes.

Returns: The associated nChannelAttributes object specifying the channel attributes

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

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

Returns: array of nJoinInformation objects

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nSessionPausedException	The session is currently paused

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

Gets the name of this channel.

Returns: a string specifying the name of this channel

nNamedObject com.pcbsys.nirvana.client.nChannel.getNamedObject ( String name ) throws nIllegalArgumentException, nSessionPausedException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nNameDoesNotExistException, nRequestTimedOutException, nUnexpectedResponseException

Returns an instance of the nNamedObject refernced by the parameter.

Parameters

name	of the nNamedObject

Returns: nNamedObject

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nNameDoesNotExistException	The name specified does not exist on the server
nSessionPausedException	The session is currently paused, please resume

nNamedObject [] com.pcbsys.nirvana.client.nChannel.getNamedObjects ( ) throws nSecurityException, nSessionPausedException, nChannelNotFoundException, nSessionNotConnectedException, nRequestTimedOutException, nUnexpectedResponseException

Returns an array of all known nNamedObjects registered with this channel.

Returns: nNamedObject[] named objects

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nSessionPausedException	The session is currently paused, please resume

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

Gets the type of this channel Currently supported types are:

nChanneAttributes.MIXED_TYPE nChanneAttributes.SIMPLE_TYPE nChanneAttributes.PERSISTENT_TYPE nChanneAttributes.RELIABLE_TYPE nChanneAttributes.TRANSIENT_TYPE

Returns: an int specifying the channel's type, which will be equal to one of :

nChanneAttributes.MIXED_TYPE nChanneAttributes.SIMPLE_TYPE nChanneAttributes.PERSISTENT_TYPE nChanneAttributes.RELIABLE_TYPE nChanneAttributes.TRANSIENT_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

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nDuplicateJoinException	The join already exists on the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nDuplicateJoinException	The join already exists on the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nDuplicateJoinException	The join already exists on the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nDuplicateJoinException	The join already exists on the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nDuplicateJoinException	The join already exists on the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nDuplicateJoinException	The join already exists on the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nDuplicateJoinException	The join already exists on the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nDuplicateJoinException	The join already exists on the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nDuplicateJoinException	The join already exists on the server
nRealmNotFoundException	The remote realm could not be found
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nChannel.publish	(	String	tag,
		Document	adom
	)		throws nSessionNotConnectedException, nSessionPausedException, nIllegalArgumentException, nSecurityException

Publishes the specified XML DOM document to this channel with the specified tag.

Parameters

tag	a string specifying the event tag to be used
adom	an XML DOM document object specifying the XML document to be published to this channel

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nSessionNotConnectedException	The session is not currently connected to the server
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

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

Publishes the specified nConsumeEvent to this channel.

Parameters

e	the nConsumeEvent object to be published to this channel

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nSessionNotConnectedException	The session is not currently connected to the server
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nChannel.publish	(	String	tag,
		Document	adom,
		nMessageSigner	signer
	)		throws nSessionNotConnectedException, nSessionPausedException, nIllegalArgumentException, nSecurityException

Publishes the specified XML DOM document to this channel with the specified tag.

Parameters

tag	a string specifying the event tag to be used
adom	an XML DOM document object specifying the XML document to be published to this channel
signer	Event Signer class to use to sign the event

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nSessionNotConnectedException	The session is not currently connected to the server
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

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

Publishes the specified nConsumeEvent to this channel.

Parameters

e	the nConsumeEvent object to be published to this channel
signer	Event Signer class to use to sign the event

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nSessionNotConnectedException	The session is not currently connected to the server
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nChannel.purgeEvent ( long eidval ) 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

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nChannel.purgeEventAsync ( long eidval ) 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

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nChannel.purgeEvents	(	long	startEID,
		long	endEID
	)		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

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nChannel.purgeEvents	(	long	startEID,
		long	endEID,
		String	selector
	)		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

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nChannel.purgeEventsAsync	(	long	startEID,
		long	endEID
	)		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

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nChannel.purgeEventsAsync	(	long	startEID,
		long	endEID,
		String	selector
	)		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

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused

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

Removes the connection listener to this channel.

Exceptions

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

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

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

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

nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused, please resume

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

nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSessionPausedException	The session is currently paused, please resume

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

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session

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 equeal 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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nSessionPausedException	The session is currently paused

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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nSessionPausedException	The session is currently paused

void com.pcbsys.nirvana.client.nChannel.reSubscribe	(	nNamedObject	name,
		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

name	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
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nSelectorParserException	The selector has syntax errors
nChannelAlreadySubscribedException	A subscriber is already registered with this channel on this session
nNameAlreadyBoundException	The name is already bound and used by another client
nSessionPausedException	The session is currently paused
nNameDoesNotExistException	if the server does not know about the named object

void com.pcbsys.nirvana.client.nChannel.unbindNamedObject ( nNamedObject name ) throws nIllegalArgumentException, nSecurityException, nChannelNotFoundException, nSessionNotConnectedException, nSessionPausedException, nNameDoesNotExistException, nRequestTimedOutException, nUnexpectedResponseException

Unbinds the named object from the current connection.

Parameters

name	the named object to be unbound

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nNameDoesNotExistException	The name specified does not exist on the server
nSessionPausedException	The session is currently paused, please resume

void com.pcbsys.nirvana.client.nChannel.unbindNamedObject ( String name ) throws nIllegalArgumentException, nSecurityException, nSessionPausedException, nChannelNotFoundException, nSessionNotConnectedException, nNameDoesNotExistException, nRequestTimedOutException, nUnexpectedResponseException

Unbinds the named object from the current connection.

Parameters

name	the name to be unbound

Exceptions

nSecurityException	is thrown if the caller has insufficient permissions
nChannelNotFoundException	if the channel no longer exists
nRequestTimedOutException	if the request exceeded the timeout value
nSessionNotConnectedException	The session is not currently connected to the server
nUnexpectedResponseException	Received a response from the server for which we can not deal with, see the message for further information
nIllegalArgumentException	Passed am illegal argument. This means the value passed is outside expected limits
nNameDoesNotExistException	The name specified does not exist on the server
nSessionPausedException	The session is currently paused, please resume

Public Member Functions

Detailed Description

Member Function Documentation