com.neeve.rog
Interface IRogMetadata

All Known Subinterfaces:

IRogCollectionNode<T>, IRogCollectionNodeElement, IRogContainerNode, IRogDoubleMap<T>, IRogDoubleMapElement, IRogIntMap<T>, IRogIntMapElement, IRogList<T>, IRogListElement, IRogLongMap<T>, IRogLongMapElement, IRogMessage, IRogNode, IRogPojoShadowNode<T>, IRogQueue<T>, IRogQueueElement, IRogRawMessage, IRogSet<T>, IRogStringMap<T>, IRogStringMapElement

All Known Implementing Classes:

AepEnvironmentData, com.neeve.rog.impl.RogNode

public interface IRogMetadata

Defines the metadata associated with an ROG node.

Method Summary

int	getGraphId() Get the object graph to which a graph node belongs
boolean	getInMsgsInTransaction() Get whether there are inbound messages in the transaction
boolean	getIsInboundMessage() Get whether a node is an inbound message (dispatched to app)
boolean	getIsInternal() Get whether a node type is for internal platform use
boolean	getIsLastTransaction() Get whether a node is contained in the last application transaction
boolean	getIsMessage() Get whether a node is a message (send or received)
boolean	getIsOutboundMessage() Get whether a node is an outbound message (sent by app)
boolean	getIsReplayedMessage() Get whether a node was replayed from the recovery log
String	getMessageBus() This method returns the bus associated with a message.
String	getMessageChannel() This method returns the channel associated with a message.
int	getMessageFlow() Returns the system-wide unique flow id.
String	getMessageKey() This method returns the key associated with a message.
int	getMessageSender() Returns the system-wide unique sender id.
long	getMessageSequenceNumber() Get the message sequence number.
boolean	getOutMsgsInTransaction() Get whether there are outbound messages in the transaction
long	getOutTs() Get a message's out timestamp.
com.eaio.uuid.UUID	getParentId() Get the object id of an ROG node's parent node.
long	getPreProcessingTs() Get a message's pre-processing timestamp.
int	getTransactionInSequenceNumber() Get a message node's transaction inbound sequence number.
int	getTransactionOutSequenceNumber() Get a message node's transaction outbound sequence number.
boolean	isPossibleDuplicate() See MessageView.isPossibleDuplicate()
String	metadataToJsonString() Gets a string representation of the metadat in json format with the configured value for nv.ident.json dictating whether the json string is indented.
String	metadataToJsonString(boolean indentOutput) Gets a string representation of the metadat in json format.
String	metadataToString() Gets a string representation of a node's metadata.

Method Detail

getGraphId

int getGraphId()

Get the object graph to which a graph node belongs

Returns:

Returns id of the node's graph.

getParentId

com.eaio.uuid.UUID getParentId()

Get the object id of an ROG node's parent node.

Each ROG node is uniquely identified in the system using a UUID. This method method returns the object id of an ROG node's parent object.

getTransactionInSequenceNumber

int getTransactionInSequenceNumber()

Get a message node's transaction inbound sequence number.

An application transaction can span multiple inbound and/or outbound messages. This field stores the inbound sequence number of a message relative to its transaction. If the message is an inbound message, then this field is the sequence number of the inbound messages within the transaction. If the message is an outbound message, then this field is the sequence number of the inbound message that triggered the outbound message. If no message triggered the outbound message, then this field would be 0.

Returns:

The message sequence number

getTransactionOutSequenceNumber

int getTransactionOutSequenceNumber()

Get a message node's transaction outbound sequence number.

An application transaction can span multiple inbound and/or outbound messages. This field stores the outbound sequence number of a message relative to its transaction. If the message is an inbound message, then this field is always 0. If the message is an outbound message, then this field is the sequence number of the outbound message within the set of outbound messages in the transaction.

Returns:

val The message sequence number

getPreProcessingTs

long getPreProcessingTs()

Get a message's pre-processing timestamp.

Returns:

Returns the timestamp just before the message was dispatched into the application for processing. A value of zero indicates that the pre-processing timestamp was not recorded.

This timestamp, in milliseconds, specifies the time just before a message was dispatched to the application for processing.

getOutTs

long getOutTs()

Get a message's out timestamp.

Returns:

Returns the out timestamp. A value of zero indicates that the outbound timestamp was not recorded.

This timestamp is the same timestamp as the 'send' timestamp but in milliseconds.

getIsInternal

boolean getIsInternal()

Get whether a node type is for internal platform use

getIsLastTransaction

boolean getIsLastTransaction()

Get whether a node is contained in the last application transaction

getIsMessage

boolean getIsMessage()

Get whether a node is a message (send or received)

getIsInboundMessage

boolean getIsInboundMessage()

Get whether a node is an inbound message (dispatched to app)

getIsOutboundMessage

boolean getIsOutboundMessage()

Get whether a node is an outbound message (sent by app)

getIsReplayedMessage

boolean getIsReplayedMessage()

Get whether a node was replayed from the recovery log

getInMsgsInTransaction

boolean getInMsgsInTransaction()

Get whether there are inbound messages in the transaction

getOutMsgsInTransaction

boolean getOutMsgsInTransaction()

Get whether there are outbound messages in the transaction

isPossibleDuplicate

boolean isPossibleDuplicate()

See MessageView.isPossibleDuplicate()

getMessageBus

String getMessageBus()

This method returns the bus associated with a message.

Returns:

the message bus name.

getMessageChannel

String getMessageChannel()

This method returns the channel associated with a message.

Returns:

the message channel name

getMessageKey

String getMessageKey()

This method returns the key associated with a message.

Returns:

the message key

getMessageSender

int getMessageSender()

Returns the system-wide unique sender id. Sequence numbers returned by getMessageSequenceNumber() are scoped by sender.

Returns:

The message sender.

getMessageFlow

int getMessageFlow()

Returns the system-wide unique flow id. Flows define the order in which messages need to be processed.

Returns:

The message flow.

getMessageSequenceNumber

long getMessageSequenceNumber()

Get the message sequence number.

Returns:

This method returns the sender scoped message sequence number.

metadataToString

String metadataToString()

Gets a string representation of a node's metadata.

metadataToJsonString

String metadataToJsonString(boolean indentOutput)

Gets a string representation of the metadat in json format.

Parameters:

indentOutput - Whether or not to indent the output.

Returns:

Json formatted string for metadata

metadataToJsonString

String metadataToJsonString()

Gets a string representation of the metadat in json format with the configured value for nv.ident.json dictating whether the json string is indented.

Returns:

Json formatted string for metadata