- com
- pcbsys
- nirvana
- client
- nConsumeEvent
This class represents a Nirvana event, which consists of either a tag and some data or an event dictionary and some data. More...
Public Member Functions | |
| void | ack () throws Exception |
| Sends an ack for this event to the server. More... | |
| nEventAttributes | getAttributes () |
| Method that returns the nEventAttributes for this event. More... | |
| String | getChannelName () |
| This function will return the name of the channel / queue that the event was delivered from. More... | |
| String | getDataGroupName () |
| Get the name of the nDataGroup that this event was published to. | |
| String | getFullChannelName () throws nBaseClientException |
| This function will return the fully qualified name of the channel / queue that the event was delivered from. More... | |
| String | getPublishHost () |
| Return the hostname from which the event was published. More... | |
| String | getPublishUser () |
| Return the id of the user that published this event. More... | |
| long | getTimestamp () |
| Return the timestamp of this event. More... | |
| boolean | hasAttributes () |
| Method indicating whether there is an nEventAttributes associated with this event. More... | |
| nConsumeEvent (byte[] tag, byte[] data) | |
| Constructs a new nConsumeEvent with the specified event tag and data. More... | |
| nConsumeEvent (String tag, byte[] data) | |
| Constructs a new nConsumeEvent with the specified event tag and data. More... | |
| nConsumeEvent (String tag, byte[] data, boolean dom) | |
| Constructs a new nConsumeEvent with the specified event tag and data. More... | |
| nConsumeEvent (nEventProperties properties, byte[] data) | |
| Constructs a new nConsumeEvent with the specified event properties and data. More... | |
| nConsumeEvent (String tag, nEventProperties properties, byte[] data) | |
| Constructs a new nConsumeEvent with the specified event properties and data. More... | |
| nConsumeEvent (String tag, Document adom) | |
| Constructs a new nConsumeEvent with the specified event tag and XML data. More... | |
| nConsumeEvent (nEventProperties properties, Document adom) | |
| Constructs a new nConsumeEvent with the specified event tag and XML data. More... | |
| void | rollback () throws Exception |
| Tells the server that it does not ack this event. More... | |
| void | setAttributes (nEventAttributes attributes) |
| Method that sets the nEventAttributes for this event. More... | |
| void | setSubscriberHost (byte[] host) |
| Sets the host name or ip address representing the consumers of this event. More... | |
| void | setSubscriberName (byte[] subName) |
| Sets the session name that will be the only consumer of this event. More... | |
| void | setSubscriberName (String subName) throws Exception |
| Sets the session name that will be the only consumer of this event. More... | |
| void | setSubscriberNames (String[] subName) throws nIllegalArgumentException |
| Sets the session names that will be the only consumers of this event. More... | |
| byte[] | sign (nMessageSigner signer) throws Exception |
| This function will return a byte[] representing a signature of the nConsumeEvent. More... | |
| synchronized Object | validate (nMessageValidator validator) throws Exception |
| This function will validate this nConsumeEvent object with the validator. More... | |
 Public Member Functions inherited from com.pcbsys.nirvana.base.nConsumeEvent | |
| void | ack (boolean isSynchronous, boolean ackPrevious) throws Exception |
| Sends an acknowledgment request for this nConsumeEvent. More... | |
| void | ack (boolean isSynchronous) throws Exception |
| Sends an ack for this event to the server, we will ack all previous events. More... | |
| void | ack (long timeout, boolean isSynchronous, boolean ackPrevious) throws Exception |
| Sends an ack for this event to the server, if a timeout value is passed, the ack will be retried if there is a failure. More... | |
| void | ack (long timeout) throws Exception |
| Sends an ack for this event to the server, if a timeout value is passed, the ack will be retried if there is a failure. More... | |
| Document | getDocument () |
| Gets the XML DOM Document associated with this event, if set. More... | |
| byte[] | getEventData () |
| Gets the event data set for this event. More... | |
| long | getEventID () |
| Gets the unique (for its channel) event id value. More... | |
| String | getEventTag () |
| Gets the event tag set for this event. More... | |
| nEventProperties | getProperties () |
| Gets this event's properties. More... | |
| byte[] | getSignature () |
| Returns the digital signature of the event if it was signed by the publisher else it returns null. More... | |
| long | getTTL () |
| Returns how long the event will be stored on disk in a mixed channel. More... | |
| boolean | isDom () |
| Gets the isDom flag to find out if the event is marked as XML DOM. More... | |
| boolean | isEndOfChannel () |
| When you subscribe to a channel, and the channel's data contains a finite and reasonably static set of events, the last event in the channel is sent and marked as the end of the channel. More... | |
| boolean | isPersistant () |
| Returns the perisitant flag. More... | |
| nConsumeEvent (byte[] tag, byte[] data) | |
| Constructs a new nConsumeEvent with the specified event tag and data. More... | |
| nConsumeEvent (String tag, byte[] data) | |
| Constructs a new nConsumeEvent with the specified event tag and data. More... | |
| nConsumeEvent (String tag, byte[] data, boolean dom) | |
| Constructs a new nConsumeEvent with the specified event tag and data. More... | |
| nConsumeEvent (String tag, nEventProperties properties, byte[] data) | |
| Constructs a new nConsumeEvent with the specified event properties and data. More... | |
| nConsumeEvent (String tag, Document adom) | |
| Constructs a new nConsumeEvent with the specified event tag and XML data. More... | |
| nConsumeEvent (nEventProperties properties, Document adom) | |
| Constructs a new nConsumeEvent with the specified event tag and XML data. More... | |
| void | rollback (boolean isSynchronous) throws Exception |
| Requests the server to roll back this nConsumeEvent. More... | |
| void | rollback (boolean isSynchronous, boolean individualRollback) throws Exception |
| Requests the server to roll back this nConsumeEvent. More... | |
| void | rollback (long timeout, boolean isSynchronous, boolean individualRollback) throws Exception |
| Tells the server that it does not ack this event, if a timeout value is passed, the rollback will be retried if there is a failure. More... | |
| void | setEventID (long newID) |
| Sets the event id value of this event. More... | |
| void | setPersistant (boolean flag) |
| Sets the persistant flag. More... | |
| void | setProperties (nEventProperties newProperties) |
| Sets this event's properties. More... | |
| void | setTTL (long ttl) |
| Sets the TTL for this event. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from com.pcbsys.nirvana.base.nConsumeEvent | |
| void | encodeDOM (xmlHelper helper) |
| Encode the Dom in this conduit event to byte[]. More... | |
This class represents a Nirvana event, which consists of either a tag and some data or an event dictionary and some data.
| com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent | ( | byte[] | tag, |
| byte[] | data | ||
| ) |
Constructs a new nConsumeEvent with the specified event tag and data.
| tag | the event tag byte[] encoded |
| data | the event data byte[] encoded |
| com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent | ( | String | tag, |
| byte[] | data | ||
| ) |
Constructs a new nConsumeEvent with the specified event tag and data.
| tag | the event tag as a string |
| data | the event data byte[] encoded |
| com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent | ( | String | tag, |
| byte[] | data, | ||
| boolean | dom | ||
| ) |
Constructs a new nConsumeEvent with the specified event tag and data.
The event will be flagged as an XML DOM document if the dom flag is true.
| tag | the event tag as a string |
| data | the event data byte[] encoded |
| dom | a flag specifying whether the event should be marked as an XML DOM document |
| com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent | ( | nEventProperties | properties, |
| byte[] | data | ||
| ) |
Constructs a new nConsumeEvent with the specified event properties and data.
The event properties can be used to create filter rules.
| properties | the collection of key-value pairs that can be used for filter rules |
| data | the event data byte[] encoded |
| com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent | ( | String | tag, |
| nEventProperties | properties, | ||
| byte[] | data | ||
| ) |
Constructs a new nConsumeEvent with the specified event properties and data.
The event properties can be used to create filter rules.
| properties | the collection of key-value pairs that can be used for filter rules |
| data | the event data byte[] encoded |
| com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent | ( | String | tag, |
| Document | adom | ||
| ) |
Constructs a new nConsumeEvent with the specified event tag and XML data.
The event will be flagged as an XML DOM document.
| tag | the event tag as a string |
| adom | the event data as an XML DOM document |
| com.pcbsys.nirvana.client.nConsumeEvent.nConsumeEvent | ( | nEventProperties | properties, |
| Document | adom | ||
| ) |
Constructs a new nConsumeEvent with the specified event tag and XML data.
The event will be flagged as an XML DOM document.
| properties | the collection of key-value pairs that can be used for filter rules |
| adom | the event data as an XML DOM document |
| void com.pcbsys.nirvana.client.nConsumeEvent.ack | ( | ) | throws Exception |
Sends an ack for this event to the server.
| Exception | If unable to send the ack request to the server |
| nEventAttributes com.pcbsys.nirvana.client.nConsumeEvent.getAttributes | ( | ) |
Method that returns the nEventAttributes for this event.
| String com.pcbsys.nirvana.client.nConsumeEvent.getChannelName | ( | ) |
This function will return the name of the channel / queue that the event was delivered from.
| String com.pcbsys.nirvana.client.nConsumeEvent.getFullChannelName | ( | ) | throws nBaseClientException |
This function will return the fully qualified name of the channel / queue that the event was delivered from.
| nBaseClientException | If the fully qualified name is not set |
| String com.pcbsys.nirvana.client.nConsumeEvent.getPublishHost | ( | ) |
Return the hostname from which the event was published.
This value will be obtained from the nEventAttributes associated with this event.
| String com.pcbsys.nirvana.client.nConsumeEvent.getPublishUser | ( | ) |
Return the id of the user that published this event.
This value will be obtained from the nEventAttributes associated with this event.
| long com.pcbsys.nirvana.client.nConsumeEvent.getTimestamp | ( | ) |
Return the timestamp of this event.
This value will be obtained from the nEventAttributes associated with this event.
| boolean com.pcbsys.nirvana.client.nConsumeEvent.hasAttributes | ( | ) |
Method indicating whether there is an nEventAttributes associated with this event.
| void com.pcbsys.nirvana.client.nConsumeEvent.rollback | ( | ) | throws Exception |
Tells the server that it does not ack this event.
| Exception | If unable to send the rollback request to the server |
| void com.pcbsys.nirvana.client.nConsumeEvent.setAttributes | ( | nEventAttributes | attributes | ) |
Method that sets the nEventAttributes for this event.
| attributes | nEventAttributes for this event |
| void com.pcbsys.nirvana.client.nConsumeEvent.setSubscriberHost | ( | byte[] | host | ) |
Sets the host name or ip address representing the consumers of this event.
By setting this, only connections matching the host name or ip address will consume this event. Wildcard * are also supported, so you can have *.abc.com fore example
| host | - the host name or ip address of connections that will consume this event |
| void com.pcbsys.nirvana.client.nConsumeEvent.setSubscriberName | ( | byte[] | subName | ) |
Sets the session name that will be the only consumer of this event.
By setting this, no other subscribers, either on a queue or channel will consume this event.
| subName | - the subscriber name, equal to the session name of the designated user. Note : This must be a toLowerCase() representation of the subject / principal string |
| void com.pcbsys.nirvana.client.nConsumeEvent.setSubscriberName | ( | String | subName | ) | throws Exception |
Sets the session name that will be the only consumer of this event.
By setting this, no other subscribers, either on a queue or channel will consume this event.
| subName | - the subscriber name, equal to the session name of the designated user (will be converted to Lower Case) |
| Exception | when there is an encoding issue with the provided string |
| void com.pcbsys.nirvana.client.nConsumeEvent.setSubscriberNames | ( | String[] | subName | ) | throws nIllegalArgumentException |
Sets the session names that will be the only consumers of this event.
By setting this, no other subscribers, either on a queue or channel will consume this event.
| subName | - the subscriber names, equal to the session names of the designated users |
| nIllegalArgumentException | Thrown if the length of the array is greater than 32767 |
| byte [] com.pcbsys.nirvana.client.nConsumeEvent.sign | ( | nMessageSigner | signer | ) | throws Exception |
This function will return a byte[] representing a signature of the nConsumeEvent.
The format and type of the signature is defined by the implementation of the nMessageSigner.
| signer | An implementation of a nMessageSigner interface |
| Exception | Depending on the implementation of the signer depends on what exceptions could be thrown |
| synchronized Object com.pcbsys.nirvana.client.nConsumeEvent.validate | ( | nMessageValidator | validator | ) | throws Exception |
This function will validate this nConsumeEvent object with the validator.
It does this by calling the validator with this objects data and comparing the signature of this nConsumeEvent.
| validator | An implementation of a nMessageValidator |
| Exception | Depending on the implementation of the nMessageValidator |