- com
- pcbsys
- nirvana
- nAdminAPI
- nJoinDetails
This class contains information about a join between two channels. More...
Inherits Observable.
Public Member Functions | |
boolean | allowPurgeRequests () |
Return whether purge requests are permitted in this join. More... | |
int | getHopCount () |
Returns the number of times an event will be passed over a join. More... | |
long | getLastEID () |
Returns the last Event ID sent to the remote join. More... | |
nLeafNode | getRemoteNode () |
Returns the nLeafNode of the remote end of the join, if this is a source join then this returns the destination else it returns the source. More... | |
String | getSelector () |
Returns the selector used for the join. More... | |
boolean | isArchival () |
Returns true if this join is an archival join. More... | |
boolean | isRemoved () |
Returns true if a particular join was removed. | |
boolean | isSource () |
Returns a boolean flag representive of whether the channel is the source side of the join. More... | |
Protected Member Functions | |
void | setRemoved (boolean removed) |
Used internally. More... | |
This class contains information about a join between two channels.
There is a nJoinDetails for both sides of a join. On a channel which sends the events this is known as a source channel and this class will return true to isSource() function. The source can also have a selector associated with it while the channel receiving the events, the destination, has no selector associated with it.
boolean com.pcbsys.nirvana.nAdminAPI.nJoinDetails.allowPurgeRequests | ( | ) |
Return whether purge requests are permitted in this join.
When you purge an event from a channel, you can specify whether to purge from any subsequent joined channels, like a cascade deletion. If this flag is set to true, any purge requests from the source channel to the destination channel / queue will be enforced. If false, purge requests will not be enforced on the destination channel / queue.
int com.pcbsys.nirvana.nAdminAPI.nJoinDetails.getHopCount | ( | ) |
Returns the number of times an event will be passed over a join.
Useful if you wish to limit the number of time an event is sent over the network.
long com.pcbsys.nirvana.nAdminAPI.nJoinDetails.getLastEID | ( | ) |
Returns the last Event ID sent to the remote join.
nLeafNode com.pcbsys.nirvana.nAdminAPI.nJoinDetails.getRemoteNode | ( | ) |
String com.pcbsys.nirvana.nAdminAPI.nJoinDetails.getSelector | ( | ) |
Returns the selector used for the join.
This is only applicable if the join is the source since the destination side of a join is not informed of the selector
boolean com.pcbsys.nirvana.nAdminAPI.nJoinDetails.isArchival | ( | ) |
Returns true if this join is an archival join.
boolean com.pcbsys.nirvana.nAdminAPI.nJoinDetails.isSource | ( | ) |
Returns a boolean flag representive of whether the channel is the source side of the join.
|
protected |
Used internally.
Determines whether a join was added or removed from the API.