com.pcbsys.nirvana.nAdminAPI.nJoinDetails Class Reference

This class contains information about a join between two channels. More...

Inherits java::util::Observable.


Public Member Functions

boolean allowPurgeRequests ()
 Return whether purge requests are permitted in this join.
boolean equals (Object o)
 Returns true if the object passed in matches this nJoinDetails object.
int getHopCount ()
 Returns the number of times an event will be passed over a join.
long getLastEID ()
 Returns the last Event ID sent to the remote join.
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.
String getSelector ()
 Returns the selector used for the join.
boolean isArchival ()
 Returns true if this join is an archival join.
boolean isSource ()
 Returns a boolean flag representive of whether the channel is the source side of the join.
String toString ()
 Returns a string representation of the nJoinDetails object.

Detailed Description

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.

Member Function Documentation

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.

Returns:
whether purge requests are honoured

boolean com.pcbsys.nirvana.nAdminAPI.nJoinDetails.equals ( Object  o  ) 

Returns true if the object passed in matches this nJoinDetails object.

Parameters:
o the object to compare the nJoinDetails object to
Returns:
true of the object matches this nJoinDetails

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.

Returns:
int hop count

long com.pcbsys.nirvana.nAdminAPI.nJoinDetails.getLastEID (  ) 

Returns the last Event ID sent to the remote join.

Returns:
long eid

nLeafNode com.pcbsys.nirvana.nAdminAPI.nJoinDetails.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.

Returns:
nLeafNode remote channel / queue

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

Returns:
String selector

boolean com.pcbsys.nirvana.nAdminAPI.nJoinDetails.isArchival (  ) 

Returns true if this join is an archival join.

Returns:
boolean is archival

boolean com.pcbsys.nirvana.nAdminAPI.nJoinDetails.isSource (  ) 

Returns a boolean flag representive of whether the channel is the source side of the join.

Returns:
boolean flag indicating if the channel to which the join details belongs is the source channel for the join

String com.pcbsys.nirvana.nAdminAPI.nJoinDetails.toString (  ) 

Returns a string representation of the nJoinDetails object.

Returns:
a string representation of the nJoinDetails object