com.pcbsys.nirvana.client.nChannelAttributes Class Reference

This class is a container for the attributes necessary to create or locate a Nirvana channel or queue. More...


Public Member Functions

boolean equals (long aLong)
 For Internal Use Only (Supporting automatic sorting in supporting data structures.
boolean equals (Object obj)
 For Internal Use Only (Supporting automatic sorting in supporting data structures.
int getChannelMode ()
 Returns the either channel (CHANNEL_MODE) or queue (QUEUE_MODE).
String getFullName () throws nBaseClientException
 Gets the full name of a channel, including the realm path if set.
int getMaxEvents ()
 Gets the maximum number of events the channel can contain.
String getName ()
 Gets the channel name.
nChannelPublishKeys[] getPublishKeys ()
 Gets the channel keys for this channel.
com.pcbsys.nirvana.client.nRealm getRealm ()
 Gets the realm this channel exists within.
long getTTL ()
 Gets the Time To Live (TTL) value that will be applied to each event contained in the channel.
int getType ()
 Gets the channel type.
long getUniqueId ()
 Gets the Unique ID value for the channel.
boolean isAutoDelete ()
 Specifies whether this channel will be automatically deleted by the server when the client who constructed it disconnects.
boolean isClusterWide ()
 Is this channel cluster wide.
boolean isDurable ()
 Specifies if the channel is restored after a server restart.
boolean isExternal ()
 Gets the isExternal flag to find out if the channel is marked as external.
boolean isJMSEngine ()
 Specifies whether this channel will use the JMS Style fanout engine.
boolean isMergeEngine ()
 Specifies whether this channel will use the Merge and Update Style fanout engine.
boolean lessThan (long aLong)
 For Internal Use Only (Supporting automatic sorting in supporting data structures.
boolean lessThan (Object obj)
 For Internal Use Only (Supporting automatic sorting in supporting data structures.
 nChannelAttributes (String _name, int _maxEvents, long _ttl, int _type, nRealm _realm) throws nIllegalArgumentException
 Constructs a nChannelAttributes object with the values specified.
 nChannelAttributes (String _name, int _maxEvents, long _ttl, int _type) throws nIllegalArgumentException
 Constructs a nChannelAttributes object with the values specified.
 nChannelAttributes (String name) throws nIllegalArgumentException
 Constructs from the name of the channel, useful when finding existing channels.
 nChannelAttributes (com.pcbsys.nirvana.base.nChannelAttributes attr)
 Constructs from the base attribute class.
 nChannelAttributes ()
 Default constructor.
void setAutoDelete (boolean autoDelete)
 Sets whether the channel is automatically deleted.
void setChannelMode (int mode) throws nIllegalArgumentException
 Sets the channel mode as either a queue or a channel.
void setClusterWide (boolean flag)
 Specifies whether this channel is a cluster channel, where it will exist in all member nodes within the cluster.
void setDeadEventHandler (nAbstractChannel store)
 Set the dead event handler store for this channel / queue.
void setDurable (boolean durable)
 Set whether the channel will be recovered after a server restart or not.
void setMaxEvents (int value) throws nIllegalArgumentException
 Sets the maximum number of events the channel can contain.
void setName (String channelName) throws nIllegalArgumentException
 Set the channel name for this channel attribute object.
void setPublishKeys (nChannelPublishKeys[] keys)
 Sets the channel keys for this channel.
void setRealm (nRealm _realm)
 Sets the realm the channel exists within, marking the channel as external.
void setTTL (long value) throws nIllegalArgumentException
 Sets the Time To Live (TTL) value for each event contained in the channel.
void setType (int aType) throws nIllegalArgumentException
 Sets the type of channel.
void setUniqueId (long id)
 Sets the Unique ID value for the channel.
void useJMSEngine (boolean useJMSEngine)
 Sets whether to use the JMS style fanout engine.
void useMergeEngine (boolean useMergeEngine)
 Sets whether to use the Merge fanout engine.

Static Public Attributes

static final int CHANNEL_MODE = com.pcbsys.nirvana.base.nConstants.CHAN_MODE_NORMAL
 Specifies a channel (or topic) mode for the pub/sub model.
static final int MIXED_TYPE = com.pcbsys.nirvana.base.nConstants.CHAN_MIXED
 Specifies a mixed (persistence and ttl set on a per event basis) channel type.
static final int PERSISTENT_TYPE = com.pcbsys.nirvana.base.nConstants.CHAN_PERSISTENT
 Specifies a persistent (on disk) channel type.
static final int QUEUE_MODE = com.pcbsys.nirvana.base.nConstants.CHAN_MODE_QUEUE
 Specifies a queue (point 2 point) mode for the queue model.
static final int RELIABLE_TYPE = com.pcbsys.nirvana.base.nConstants.CHAN_RELIABLE
 Specifies a reliable (in memory but with EIDs retained) channel type.
static final long sAllowFullAccess = 8
 Allow everyone to do everything on the channel / queue (Use with extreme caution since it bypasses any security checks for this channel / queue ).
static final long sAllowLastEIDAccess = 512
 Get the last known Event ID on the channel / queue.
static final long sAllowManageACLAccess = 2+1
 Allow everyone to add / remove acl entries on the channel / queue.
static final long sAllowNamedAccess = 2048
 Allow everyone to create a named object on this channel.
static final long sAllowPublishAccess = 32
 Allow everyone to write events to the channel / queue.
static final long sAllowPurgeAccess = 128
 Allow everyone to purge events from the channel ( Only valid on channels ).
static final long sAllowQueuePopAccess = 1024
 Allow everyone to pop events from the queue, (Only valid on Queues).
static final long sAllowReadACLAccess = 4
 Allow everyone to read the ACL lists.
static final long sAllowSubscribeAccess = 64
 Allow everyone to subscribe to the channel ( Only valid on channels ).
static final int SIMPLE_TYPE = com.pcbsys.nirvana.base.nConstants.CHAN_SIMPLE
 Specifies a simple (in memory, no EIDs retained) channel type.
static final int TRANSIENT_TYPE = com.pcbsys.nirvana.base.nConstants.CHAN_TRANSIENT
 Specifies a simple (in memory, no EIDs retained) channel type.

Detailed Description

This class is a container for the attributes necessary to create or locate a Nirvana channel or queue.

Constructor & Destructor Documentation

com.pcbsys.nirvana.client.nChannelAttributes.nChannelAttributes ( com.pcbsys.nirvana.base.nChannelAttributes  attr  ) 

Constructs from the base attribute class.

Parameters:
attr Base class used to construct this class

com.pcbsys.nirvana.client.nChannelAttributes.nChannelAttributes ( String  name  )  throws nIllegalArgumentException

Constructs from the name of the channel, useful when finding existing channels.

Parameters:
name of the channel and uses defaults for the other paramaters
Exceptions:
nIllegalArgumentException thrown if an name is illegal

com.pcbsys.nirvana.client.nChannelAttributes.nChannelAttributes ( String  _name,
int  _maxEvents,
long  _ttl,
int  _type 
) throws nIllegalArgumentException

Constructs a nChannelAttributes object with the values specified.

Parameters:
_name A string specifying the channel name
_maxEvents An int specifying the maximum number of events this channel can contain (i.e. the capacity)
_ttl An int specifying the Time To Live (TTL) for events published in this channel (i.e. the age)
_type An int specifying the channel type. Valid values are nConstants.CHAN_RELIABLE or nConstants.CHAN_PERSISTENT
Exceptions:
nIllegalArgumentException is thrown if an incorrect parameter is passed to the constructor

com.pcbsys.nirvana.client.nChannelAttributes.nChannelAttributes ( String  _name,
int  _maxEvents,
long  _ttl,
int  _type,
nRealm  _realm 
) throws nIllegalArgumentException

Constructs a nChannelAttributes object with the values specified.

Parameters:
_name A string specifying the channel name
_maxEvents An int specifying the maximum number of events this channel can contain (i.e. the capacity)
_ttl An int specifying the Time To Live (TTL) for events published in this channel (i.e. the age)
_type An int specifying the channel type. Valid values are nConstants.CHAN_RELIABLE or nConstants.CHAN_PERSISTENT
_realm A nRealm object specifying the realm this channel exists within
Exceptions:
nIllegalArgumentException is thrown if an incorrect parameter is passed to the constructor

Member Function Documentation

boolean com.pcbsys.nirvana.client.nChannelAttributes.equals ( long  aLong  ) 

For Internal Use Only (Supporting automatic sorting in supporting data structures.

boolean com.pcbsys.nirvana.client.nChannelAttributes.equals ( Object  obj  ) 

For Internal Use Only (Supporting automatic sorting in supporting data structures.

int com.pcbsys.nirvana.client.nChannelAttributes.getChannelMode (  ) 

Returns the either channel (CHANNEL_MODE) or queue (QUEUE_MODE).

Returns:
the channel mode specified in this channel attributes

String com.pcbsys.nirvana.client.nChannelAttributes.getFullName (  )  throws nBaseClientException

Gets the full name of a channel, including the realm path if set.

Returns:
A string specifying the full name of a channel.
Exceptions:
nBaseClientException is thrown if the name value is not set

int com.pcbsys.nirvana.client.nChannelAttributes.getMaxEvents (  ) 

Gets the maximum number of events the channel can contain.

(i.e. the capacity)

Returns:
An int specifying the maximum number of events this channel can currently contain (i.e. the current capacity)

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

Gets the channel name.

Returns:
A string specifying the name value of the channel

nChannelPublishKeys [] com.pcbsys.nirvana.client.nChannelAttributes.getPublishKeys (  ) 

Gets the channel keys for this channel.

Returns:
nChannelPublishKeys[] The currently configured publish keys for this channel

com.pcbsys.nirvana.client.nRealm com.pcbsys.nirvana.client.nChannelAttributes.getRealm (  ) 

Gets the realm this channel exists within.

Returns:
an nRealm object specifying the realm this channel exists within within the realm you have a session to and use this object.

long com.pcbsys.nirvana.client.nChannelAttributes.getTTL (  ) 

Gets the Time To Live (TTL) value that will be applied to each event contained in the channel.

Returns:
A long specifying the current TTL value setting for the channel

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

Gets the channel 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

long com.pcbsys.nirvana.client.nChannelAttributes.getUniqueId (  ) 

Gets the Unique ID value for the channel.

Returns:
A long specifying the current Unique ID value for the channel

boolean com.pcbsys.nirvana.client.nChannelAttributes.isAutoDelete (  ) 

Specifies whether this channel will be automatically deleted by the server when the client who constructed it disconnects.

Returns:
if this channel will be automatically deleted when the client that constructed it disconnects
Since:
5.5

boolean com.pcbsys.nirvana.client.nChannelAttributes.isClusterWide (  ) 

Is this channel cluster wide.

Returns:
if this channel is cluster wide

boolean com.pcbsys.nirvana.client.nChannelAttributes.isDurable (  ) 

Specifies if the channel is restored after a server restart.

If not durable then the server will not recreate them after a reload

Returns:
flag indicating if this channel will be recovered after a restart or not
Since:
5.5

boolean com.pcbsys.nirvana.client.nChannelAttributes.isExternal (  ) 

Gets the isExternal flag to find out if the channel is marked as external.

Returns:
A boolean specifying whether this channel is external or not

boolean com.pcbsys.nirvana.client.nChannelAttributes.isJMSEngine (  ) 

Specifies whether this channel will use the JMS Style fanout engine.

For more information on this, please see the version 4.0 documentation.

Returns:
whether events are delivered via the JMS fanout engine.
Since:
4.0

boolean com.pcbsys.nirvana.client.nChannelAttributes.isMergeEngine (  ) 

Specifies whether this channel will use the Merge and Update Style fanout engine.

For more information on this, please see the version 5.0 documentation.

Returns:
whether events are delivered via the Merge and update fanout engine.
Since:
5.0

boolean com.pcbsys.nirvana.client.nChannelAttributes.lessThan ( long  aLong  ) 

For Internal Use Only (Supporting automatic sorting in supporting data structures.

boolean com.pcbsys.nirvana.client.nChannelAttributes.lessThan ( Object  obj  ) 

For Internal Use Only (Supporting automatic sorting in supporting data structures.

void com.pcbsys.nirvana.client.nChannelAttributes.setAutoDelete ( boolean  autoDelete  ) 

Sets whether the channel is automatically deleted.

Parameters:
autoDelete flag indicating what to do on client closure
Since:
5.5

void com.pcbsys.nirvana.client.nChannelAttributes.setChannelMode ( int  mode  )  throws nIllegalArgumentException

Sets the channel mode as either a queue or a channel.

These are specified as :

nChannelAttributes.QUEUE_MODE & nChannelAttributes.CHANNEL_MODE

Parameters:
mode - one of the supported modes, either queue or channel
Exceptions:
nIllegalArgumentException if the specified channel mode not one of the support modes

void com.pcbsys.nirvana.client.nChannelAttributes.setClusterWide ( boolean  flag  ) 

Specifies whether this channel is a cluster channel, where it will exist in all member nodes within the cluster.

Parameters:
flag is this channel to exist across all cluster realms

void com.pcbsys.nirvana.client.nChannelAttributes.setDeadEventHandler ( nAbstractChannel  store  ) 

Set the dead event handler store for this channel / queue.

When events reach there ttl or the channel hits its ttl, but have not been consumed, they can be placed in a dead event store.

Setting the dead event store to be another valid channel or queue will enable this functionality and allow you to keep track of events that have died in this manner.

Parameters:
store the channel or queue to be set as the dead event store

void com.pcbsys.nirvana.client.nChannelAttributes.setDurable ( boolean  durable  ) 

Set whether the channel will be recovered after a server restart or not.

Parameters:
durable flag indicating the current state
Since:
5.5

void com.pcbsys.nirvana.client.nChannelAttributes.setMaxEvents ( int  value  )  throws nIllegalArgumentException

Sets the maximum number of events the channel can contain.

(i.e. the capacity)

Parameters:
value An int specifying the max number of events
Exceptions:
nIllegalArgumentException is thrown if an incorrect value is passed

void com.pcbsys.nirvana.client.nChannelAttributes.setName ( String  channelName  )  throws nIllegalArgumentException

Set the channel name for this channel attribute object.

If the channel begins with '/', a realm path is also created and the channel is marked as external.

Parameters:
channelName A string specifying the name of the channel for this channel attribute object.
Exceptions:
nIllegalArgumentException is thrown if an incorrect value is passed

void com.pcbsys.nirvana.client.nChannelAttributes.setPublishKeys ( nChannelPublishKeys[]  keys  ) 

Sets the channel keys for this channel.

Parameters:
keys An array of nChannelPublishKeys to be assigned to this channel

void com.pcbsys.nirvana.client.nChannelAttributes.setRealm ( nRealm  _realm  ) 

Sets the realm the channel exists within, marking the channel as external.

If the realm is not set, it is implied that the channel exists within the realm you have a session to and use this object.

Parameters:
_realm An nRealm object specifying the realm the channel exists within

void com.pcbsys.nirvana.client.nChannelAttributes.setTTL ( long  value  )  throws nIllegalArgumentException

Sets the Time To Live (TTL) value for each event contained in the channel.

Parameters:
value A long specifying the new TTL value
Exceptions:
nIllegalArgumentException is thrown if an invalid TTL value is specified

void com.pcbsys.nirvana.client.nChannelAttributes.setType ( int  aType  )  throws nIllegalArgumentException

Sets the type of channel.

Parameters:
aType An int specifying the channel type.
Exceptions:
nIllegalArgumentException is thrown if an illegal channel type is specified

void com.pcbsys.nirvana.client.nChannelAttributes.setUniqueId ( long  id  ) 

Sets the Unique ID value for the channel.

Parameters:
id A long specifying the new unique id value

void com.pcbsys.nirvana.client.nChannelAttributes.useJMSEngine ( boolean  useJMSEngine  ) 

Sets whether to use the JMS style fanout engine.

Parameters:
useJMSEngine use the JMS fanout engine
Since:
4.0

void com.pcbsys.nirvana.client.nChannelAttributes.useMergeEngine ( boolean  useMergeEngine  ) 

Sets whether to use the Merge fanout engine.

Parameters:
useMergeEngine use the Update and Merge fanout engine
Since:
5.0

Field Documentation

final int com.pcbsys.nirvana.client.nChannelAttributes.TRANSIENT_TYPE = com.pcbsys.nirvana.base.nConstants.CHAN_TRANSIENT [static]

Specifies a simple (in memory, no EIDs retained) channel type.

Specifies a relay (no events are stored) channel type

Since:
4.0