- com
- pcbsys
- nirvana
- client
- nDurableAttributes
This class is a container for the attributes necessary to create or locate a Durable object on a channel. More...
Data Structures | |
enum | nDurableType |
Enumeration defining all Durable types. More... | |
Public Member Functions | |
String | getName () |
Returns the name of the durable store. More... | |
String | getSelector () |
Returns the current filter if supplied, used only by the Shared Durable objects. More... | |
long | getStartEID () |
Gets start eid. More... | |
nDurableType | getType () |
Returns the current type of the durable name. More... | |
boolean | isClustered () |
Indicates if the durable name is to be sent across the cluster or not. More... | |
boolean | isPersistent () |
Returns if the durable names state will be saved to disk on the server or not. More... | |
void | setClustered (boolean clustered) |
If true then this durable name will be initialied and updated across all cluster nodes. More... | |
void | setPersistent (boolean persistent) throws nIllegalArgumentException |
If true the server will save the state of the durable name when it changes. More... | |
void | setSelector (String filter) throws nIllegalArgumentException |
If the Durable is of type Shared or SharedQueue sets the filter string for the server to use. More... | |
void | setStartEID (long startEID) |
Sets the initial EID that the durable name will bind to on the topic. More... | |
Static Public Member Functions | |
static nDurableAttributes | create (nDurableType type, String name) throws nIllegalArgumentException |
A static factory method used for creating nDurableAttributes objects. More... | |
Protected Member Functions | |
nDurableAttributes (nDurableType type, String name) throws nIllegalArgumentException | |
Instantiates a new N durable attributes. More... | |
Protected Attributes | |
boolean | isPersistent |
The Is persistent. | |
String | mySelector |
The My selector. | |
This class is a container for the attributes necessary to create or locate a Durable object on a channel.
|
protected |
Instantiates a new N durable attributes.
type | the type |
name | the name |
|
static |
A static factory method used for creating nDurableAttributes objects.
Empty durable name or name consisting only of space characters is not allowed
type | The type of the durable |
name | The name of the durable |
nIllegalArgumentException | in case empty string or string consisting only of space characters is provided as name |
String com.pcbsys.nirvana.client.nDurableAttributes.getName | ( | ) |
Returns the name of the durable store.
String com.pcbsys.nirvana.client.nDurableAttributes.getSelector | ( | ) |
Returns the current filter if supplied, used only by the Shared Durable objects.
long com.pcbsys.nirvana.client.nDurableAttributes.getStartEID | ( | ) |
Gets start eid.
nDurableType com.pcbsys.nirvana.client.nDurableAttributes.getType | ( | ) |
Returns the current type of the durable name.
boolean com.pcbsys.nirvana.client.nDurableAttributes.isClustered | ( | ) |
Indicates if the durable name is to be sent across the cluster or not.
boolean com.pcbsys.nirvana.client.nDurableAttributes.isPersistent | ( | ) |
Returns if the durable names state will be saved to disk on the server or not.
void com.pcbsys.nirvana.client.nDurableAttributes.setClustered | ( | boolean | clustered | ) |
If true then this durable name will be initialied and updated across all cluster nodes.
clustered | the clustered |
void com.pcbsys.nirvana.client.nDurableAttributes.setPersistent | ( | boolean | persistent | ) | throws nIllegalArgumentException |
If true the server will save the state of the durable name when it changes.
persistent | the persistent |
nIllegalArgumentException | the n illegal argument exception |
void com.pcbsys.nirvana.client.nDurableAttributes.setSelector | ( | String | filter | ) | throws nIllegalArgumentException |
If the Durable is of type Shared or SharedQueue sets the filter string for the server to use.
filter | String for the server to use |
nIllegalArgumentException | the n illegal argument exception |
void com.pcbsys.nirvana.client.nDurableAttributes.setStartEID | ( | long | startEID | ) |
Sets the initial EID that the durable name will bind to on the topic.
The property is not applicable for SharedQueued durable type, since the start event id in the hidden internal queue remains the default value which is zero.
startEID | the start eid |