- 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... | |
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 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... | |
Static Public Attributes | |
static final long | INITIAL_EID_END_OF_STORE = com.pcbsys.nirvana.base.nConstants.INITIAL_EID_END_OF_STORE |
Constant used to initialise the startEID of the durable using nDurableAttributes#setStartEID(long), so that durable is attached to end of the store and newly published events will be added to the durable. | |
Protected Member Functions | |
nDurableAttributes (nDurableType type, String name) throws nIllegalArgumentException | |
Instantiates durable attributes. More... | |
Protected Attributes | |
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 durable attributes.
StartEID by default is set to nDurableAttributes#INITIAL_EID_END_OF_STORE, attaching the durable to the end of store so that newly published events will be added to the durable
type | nDurableType |
name | Name of the durable |
|
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.
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 will bind to on the topic.
Setting the startEID to
nDurableAttributes#INITIAL_EID_END_OF_STORE, attaches the durable to end of topic allowing newly published events to be added to the durable
any value greater than nDurableAttributes#INITIAL_EID_END_OF_STORE, binds the durable on the topic
startEID | the start eid |