- com
- pcbsys
- nirvana
- client
- nDataGroup
This class represents a individual data group object. More...
Public Member Functions | |
void | add (nDataStream stream) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Add a new stream to this data group. More... | |
void | add (nDataStream[] streams) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Add an array of new stream to this data group. More... | |
void | add (nDataGroup add) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Adds an existing data group to this data group, allowing groups to be cascaded. More... | |
void | addListener (nDataGroupListener listener) throws nDataGroupDeletedException |
Add a new listener to this group so that when Streams or Groups are added or deleted the listener is notified. More... | |
void | addPublisher (String subject) throws nBaseClientException |
Allow the specified subject to be allowed to publish to this group. More... | |
void | addSnoop (nDataStream stream) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Add a new snoop stream to this data group This stream will be hidden from the group, with no callbacks fired for it. More... | |
boolean | contains (nDataGroup group) throws nDataGroupDeletedException |
Checks if the input group exists within this data group. More... | |
boolean | contains (nDataStream stream) throws nDataGroupDeletedException |
Checks if the stream id exists in this group. More... | |
boolean | contains (String streamId) throws nDataGroupDeletedException |
Checks if the stream id exists in this group. More... | |
boolean | containsSnoop (nDataStream stream) throws nDataGroupDeletedException |
Checks if the snoop stream id exists in this group. More... | |
boolean | containsSnoop (String streamId) throws nDataGroupDeletedException |
Checks if the snoop stream id exists in this group. More... | |
nRegisteredEvent | createRegisteredEvent () throws nIllegalStateException |
Registers a new nRegisteredEvent with the data stream allowing updates only to be sent through to the clients. More... | |
nConflationAttributes | getConflationAttributes () |
Get the conflation attributes for this data group if they exist. More... | |
nDataGroup | getGroup (String groupName) throws nDataGroupDeletedException |
Returns the DataGroup specified, if it is contained within this group. More... | |
int | getGroupCount () throws nDataGroupDeletedException |
Returns the size of the DataGroups (if any) contained within this group. More... | |
Iterator< nDataGroup > | getGroups () throws nDataGroupDeletedException |
Returns the DataGroups (if any) contained within this group. More... | |
nDataGroup[] | getGroupsContaining () |
Locate the groups that currently contain this group. More... | |
Enumeration< nDataGroup > | getGroupsEnumeration () throws nDataGroupDeletedException |
Returns the DataGroups (if any) contained within this group. More... | |
long | getID () |
Return the id of this nDataGroup object. More... | |
String | getName () |
Return the name of the group. More... | |
int | getPriority () |
Returns the level of priority assigned to this Data Group. More... | |
Iterator< String > | getPublishers () throws nDataGroupDeletedException |
Obtain an iterator of publisher ids. More... | |
Enumeration< String > | getPublishersEnumeration () throws nDataGroupDeletedException |
Obtain an Enumeration of publisher ids. More... | |
nSession | getSession () |
Returns the session associated with this data group instance. | |
nDataStream | getSnoopStream (String name) throws nDataGroupDeletedException |
Get the nDataStream snoop object corresponding to the name. More... | |
nDataStream | getStream (String name) throws nDataGroupDeletedException |
Get the nDataStream object corresponding to the name. More... | |
Iterator< nDataStream > | getStreams () throws nDataGroupDeletedException |
Obtain an iterator of the nDataStream objects contained within this group. More... | |
Enumeration< nDataStream > | getStreamsEnumeration () throws nDataGroupDeletedException |
Obtain an Enumeration of the nDataStream objects contained within this group. More... | |
boolean | isClosed () |
Returns true if this group has been deleted. More... | |
boolean | isMulticastEnabled () |
Flag to indicate whether this Data Group is multicast enabled. More... | |
boolean | isNested () |
Flag indicating whether this group is nested within one of more other groups. More... | |
boolean | isReadOnly () |
Flag to indicate whether this group is read only. More... | |
void | remove (nDataStream stream) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Remove the stream Id from this data group. More... | |
void | remove (nDataGroup group) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Remove the specified data group from this one. More... | |
void | removePublisher (String subject) throws Exception |
Remove the specified subject from the list of authorised publishers for this group. More... | |
void | removeSnoop (nDataStream stream) throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Remove the snoop stream Id from this data group. More... | |
int | size () throws nDataGroupDeletedException |
Return the total number of streams contained in this group. More... | |
Public Member Functions inherited from com.pcbsys.nirvana.client.nDataStream | |
String | getName () |
Get the name of the stream. More... | |
String | getSubject () |
Get the subject associated with the stream. More... | |
This class represents a individual data group object.
void com.pcbsys.nirvana.client.nDataGroup.add | ( | nDataStream | stream | ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Add a new stream to this data group.
stream | - the stream to add |
void com.pcbsys.nirvana.client.nDataGroup.add | ( | nDataStream[] | streams | ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Add an array of new stream to this data group.
streams | - the array of streams to add |
void com.pcbsys.nirvana.client.nDataGroup.add | ( | nDataGroup | add | ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Adds an existing data group to this data group, allowing groups to be cascaded.
add | - group to be added |
void com.pcbsys.nirvana.client.nDataGroup.addListener | ( | nDataGroupListener | listener | ) | throws nDataGroupDeletedException |
Add a new listener to this group so that when Streams or Groups are added or deleted the listener is notified.
listener | the listener to receive callbacks on this data group |
nDataGroupDeletedException | if the group is deleted |
void com.pcbsys.nirvana.client.nDataGroup.addPublisher | ( | String | subject | ) | throws nBaseClientException |
Allow the specified subject to be allowed to publish to this group.
subject | the subject to give permissions to |
nDataGroupIsReadOnlyException | if the data group is read only |
nDataGroupDeletedException | if the group is deleted |
nBaseClientException | if there are problems when adding the publisher |
void com.pcbsys.nirvana.client.nDataGroup.addSnoop | ( | nDataStream | stream | ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Add a new snoop stream to this data group This stream will be hidden from the group, with no callbacks fired for it.
stream | - the stream to add |
boolean com.pcbsys.nirvana.client.nDataGroup.contains | ( | nDataGroup | group | ) | throws nDataGroupDeletedException |
Checks if the input group exists within this data group.
group | to test to see if is contained within this data group |
boolean com.pcbsys.nirvana.client.nDataGroup.contains | ( | nDataStream | stream | ) | throws nDataGroupDeletedException |
Checks if the stream id exists in this group.
stream | the stream to test for |
nDataGroupDeletedException | if this nDataGroup is now closed |
boolean com.pcbsys.nirvana.client.nDataGroup.contains | ( | String | streamId | ) | throws nDataGroupDeletedException |
Checks if the stream id exists in this group.
streamId | the name of the stream or group to test for |
nDataGroupDeletedException | if the group is deleted |
boolean com.pcbsys.nirvana.client.nDataGroup.containsSnoop | ( | nDataStream | stream | ) | throws nDataGroupDeletedException |
Checks if the snoop stream id exists in this group.
stream | the stream to test for |
nDataGroupDeletedException | if this nDataGroup is now closed |
boolean com.pcbsys.nirvana.client.nDataGroup.containsSnoop | ( | String | streamId | ) | throws nDataGroupDeletedException |
Checks if the snoop stream id exists in this group.
streamId | the name of the snoop stream to test for |
nDataGroupDeletedException | if the group is deleted |
nRegisteredEvent com.pcbsys.nirvana.client.nDataGroup.createRegisteredEvent | ( | ) | throws nIllegalStateException |
Registers a new nRegisteredEvent with the data stream allowing updates only to be sent through to the clients.
nIllegalStateException | If the conflation attributes are mis-configured |
nConflationAttributes com.pcbsys.nirvana.client.nDataGroup.getConflationAttributes | ( | ) |
Get the conflation attributes for this data group if they exist.
nDataGroup com.pcbsys.nirvana.client.nDataGroup.getGroup | ( | String | groupName | ) | throws nDataGroupDeletedException |
Returns the DataGroup specified, if it is contained within this group.
groupName | to find |
nDataGroupDeletedException | if the group is deleted |
int com.pcbsys.nirvana.client.nDataGroup.getGroupCount | ( | ) | throws nDataGroupDeletedException |
Returns the size of the DataGroups (if any) contained within this group.
nDataGroupDeletedException | if the group is deleted |
Iterator<nDataGroup> com.pcbsys.nirvana.client.nDataGroup.getGroups | ( | ) | throws nDataGroupDeletedException |
Returns the DataGroups (if any) contained within this group.
nDataGroupDeletedException | if the group is deleted |
nDataGroup [] com.pcbsys.nirvana.client.nDataGroup.getGroupsContaining | ( | ) |
Locate the groups that currently contain this group.
Enumeration<nDataGroup> com.pcbsys.nirvana.client.nDataGroup.getGroupsEnumeration | ( | ) | throws nDataGroupDeletedException |
Returns the DataGroups (if any) contained within this group.
nDataGroupDeletedException | if the group is deleted |
long com.pcbsys.nirvana.client.nDataGroup.getID | ( | ) |
Return the id of this nDataGroup object.
String com.pcbsys.nirvana.client.nDataGroup.getName | ( | ) |
Return the name of the group.
int com.pcbsys.nirvana.client.nDataGroup.getPriority | ( | ) |
Returns the level of priority assigned to this Data Group.
Iterator<String> com.pcbsys.nirvana.client.nDataGroup.getPublishers | ( | ) | throws nDataGroupDeletedException |
Obtain an iterator of publisher ids.
nDataGroupDeletedException | if this nDataGroup is now closed |
Enumeration<String> com.pcbsys.nirvana.client.nDataGroup.getPublishersEnumeration | ( | ) | throws nDataGroupDeletedException |
Obtain an Enumeration of publisher ids.
nDataGroupDeletedException | if this nDataGroup is now closed |
nDataStream com.pcbsys.nirvana.client.nDataGroup.getSnoopStream | ( | String | name | ) | throws nDataGroupDeletedException |
Get the nDataStream snoop object corresponding to the name.
name | of the snoop stream |
nDataGroupDeletedException | if the group is deleted |
nDataStream com.pcbsys.nirvana.client.nDataGroup.getStream | ( | String | name | ) | throws nDataGroupDeletedException |
Get the nDataStream object corresponding to the name.
name | of the stream |
nDataGroupDeletedException | if the group is deleted |
Iterator<nDataStream> com.pcbsys.nirvana.client.nDataGroup.getStreams | ( | ) | throws nDataGroupDeletedException |
Obtain an iterator of the nDataStream objects contained within this group.
nDataGroupDeletedException | if this nDataGroup is now closed |
Enumeration<nDataStream> com.pcbsys.nirvana.client.nDataGroup.getStreamsEnumeration | ( | ) | throws nDataGroupDeletedException |
Obtain an Enumeration of the nDataStream objects contained within this group.
nDataGroupDeletedException | if this nDataGroup is now closed |
boolean com.pcbsys.nirvana.client.nDataGroup.isClosed | ( | ) |
Returns true if this group has been deleted.
boolean com.pcbsys.nirvana.client.nDataGroup.isMulticastEnabled | ( | ) |
Flag to indicate whether this Data Group is multicast enabled.
boolean com.pcbsys.nirvana.client.nDataGroup.isNested | ( | ) |
Flag indicating whether this group is nested within one of more other groups.
boolean com.pcbsys.nirvana.client.nDataGroup.isReadOnly | ( | ) |
Flag to indicate whether this group is read only.
If it is, it will be the default Data Group object
void com.pcbsys.nirvana.client.nDataGroup.remove | ( | nDataStream | stream | ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Remove the stream Id from this data group.
stream | - the stream to remove from this data group |
void com.pcbsys.nirvana.client.nDataGroup.remove | ( | nDataGroup | group | ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Remove the specified data group from this one.
group | the group to remove |
void com.pcbsys.nirvana.client.nDataGroup.removePublisher | ( | String | subject | ) | throws Exception |
Remove the specified subject from the list of authorised publishers for this group.
subject | the subject to remove permissions from |
nDataGroupIsReadOnlyException | if the data group is read only |
nDataGroupDeletedException | if the group is deleted |
void com.pcbsys.nirvana.client.nDataGroup.removeSnoop | ( | nDataStream | stream | ) | throws nSecurityException, nRequestTimedOutException, nSessionPausedException, nSessionNotConnectedException, nDataGroupDeletedException, nDataGroupIsReadOnlyException, nUnexpectedResponseException |
Remove the snoop stream Id from this data group.
stream | - the stream to remove from this data group |
int com.pcbsys.nirvana.client.nDataGroup.size | ( | ) | throws nDataGroupDeletedException |
Return the total number of streams contained in this group.
nDataGroupDeletedException | if the group is deleted |