com.neeve.rog

Interface IRogMetadata

All Known Subinterfaces:

IRogBooleanMap<T>, IRogByteMap<T>, IRogCharMap<T>, IRogCollectionNode<T>, IRogCollectionNodeElement, IRogContainerNode, IRogCopyableNode<T>, IRogDoubleMap<T>, IRogDoubleMapElement, IRogFloatMap<T>, IRogIntMap<T>, IRogIntMapElement, IRogList<T>, IRogListElement, IRogLongMap<T>, IRogLongMapElement, IRogMessage, IRogNode, IRogPojoShadowNode<T>, IRogQuarkStringMapElement, IRogQueue<T>, IRogQueueElement, IRogRawMessage, IRogSet<T>, IRogShortMap<T>, IRogStringMap<T>, IRogStringMapElement, ISrvMonAppBusBindingCreatedMessage, ISrvMonAppBusBindingCreateFailedMessage, ISrvMonAppBusBindingCreateMessage, ISrvMonAppBusBindingDestroyedMessage, ISrvMonAppBusBindingDestroyMessage, ISrvMonAppBusBindingDownMessage, ISrvMonAppBusBindingOpenedMessage, ISrvMonAppBusBindingOpenFailedMessage, ISrvMonAppBusBindingOpeningMessage, ISrvMonAppBusBindingStateChangeMessage, ISrvMonAppBusBindingStateChangeMessage, ISrvMonAppBusBindingUpMessage, ISrvMonAppBusChannelClosedMessage, ISrvMonAppBusChannelOpenedMessage, ISrvMonAppChannelDownMessage, ISrvMonAppChannelUpMessage, ISrvMonAppClientConnectMessage, ISrvMonAppClientConnectMessage, ISrvMonAppClientDisconnectMessage, ISrvMonAppClientDisconnectMessage, ISrvMonAppDuplicateAcknowledgementAlertMessage, ISrvMonAppEngineActiveMessage, ISrvMonAppEngineCreatedMessage, ISrvMonAppEngineStartedMessage, ISrvMonAppEngineStoppedMessage, ISrvMonAppEngineStoppingMessage, ISrvMonAppExceptionMessage, ISrvMonAppFlowCreateMessage, ISrvMonAppFlowCreateMessage, ISrvMonAppInboundLogExceptionMessage, ISrvMonAppLoadedMessage, ISrvMonAppLoadedMessage, ISrvMonAppMessagingFailedMessage, ISrvMonAppMessagingPrestartMessage, ISrvMonAppMessagingStartedMessage, ISrvMonAppMessagingStartFailedMessage, ISrvMonAppOutboundLogExceptionMessage, ISrvMonAppOutOfOrderSendCommitCompletionAlertMessage, ISrvMonAppSendExceptionMessage, ISrvMonAppStateChangeMessage, ISrvMonAppStateChangeMessage, ISrvMonAppStatsAlertMessage, ISrvMonAppStoreBindingFailedMessage, ISrvMonAppStoreBindingRoleChangedMessage, ISrvMonAppStoreMemberDownMessage, ISrvMonAppStoreMemberInitCompleteMessage, ISrvMonAppStoreMemberUpMessage, ISrvMonAppStoreTransactionLogRepairedMessage, ISrvMonAppStuckAlertMessage, ISrvMonAppUnhandledMessageMessage, ISrvMonAppUnloadedMessage, ISrvMonAppUnloadedMessage, ISrvMonGetLoadedAppsRequest, ISrvMonGetLoadedAppsResponse, ISrvMonGetTraceHistoryRequest, ISrvMonGetTraceHistoryResponse, ISrvMonHeartbeatMessage, ISrvMonInvokeCommandRequest, ISrvMonInvokeCommandResponse, ISrvMonListCommandsRequest, ISrvMonListCommandsResponse, ISrvMonMessageBusBindingReconnectedMessage, ISrvMonMessageBusBindingReconnectingMessage, ISrvMonMessageTraceLoggingExceptionMessage, ISrvMonStartAppWatchCommand, ISrvMonStartTraceWatchRequest, ISrvMonStartTraceWatchResponse, ISrvMonStopAppWatchCommand, ISrvMonStopTraceWatchRequest, ISrvMonStopTraceWatchResponse, ISrvMonTraceRecord, ISrvMonUnhandledMessageMessage, ISrvMonXvmInfoRequest, ISrvMonXvmInfoResponse

All Known Implementing Classes:

AepEnvironmentData, com.neeve.rog.impl.RogNode, SrvMonAppBusBindingCreatedMessage, SrvMonAppBusBindingCreateFailedMessage, SrvMonAppBusBindingCreateMessage, SrvMonAppBusBindingDestroyedMessage, SrvMonAppBusBindingDestroyMessage, SrvMonAppBusBindingDownMessage, SrvMonAppBusBindingOpenedMessage, SrvMonAppBusBindingOpenFailedMessage, SrvMonAppBusBindingOpeningMessage, SrvMonAppBusBindingStateChangeMessage, SrvMonAppBusBindingStateChangeMessage, SrvMonAppBusBindingUpMessage, SrvMonAppBusChannelClosedMessage, SrvMonAppBusChannelOpenedMessage, SrvMonAppChannelDownMessage, SrvMonAppChannelUpMessage, SrvMonAppClientConnectMessage, SrvMonAppClientConnectMessage, SrvMonAppClientDisconnectMessage, SrvMonAppClientDisconnectMessage, SrvMonAppDuplicateAcknowledgementAlertMessage, SrvMonAppEngineActiveMessage, SrvMonAppEngineCreatedMessage, SrvMonAppEngineStartedMessage, SrvMonAppEngineStoppedMessage, SrvMonAppEngineStoppingMessage, SrvMonAppExceptionMessage, SrvMonAppFlowCreateMessage, SrvMonAppFlowCreateMessage, SrvMonAppInboundLogExceptionMessage, SrvMonAppLoadedMessage, SrvMonAppLoadedMessage, SrvMonAppMessagingFailedMessage, SrvMonAppMessagingPrestartMessage, SrvMonAppMessagingStartedMessage, SrvMonAppMessagingStartFailedMessage, SrvMonAppOutboundLogExceptionMessage, SrvMonAppOutOfOrderSendCommitCompletionAlertMessage, SrvMonAppSendExceptionMessage, SrvMonAppStateChangeMessage, SrvMonAppStateChangeMessage, SrvMonAppStatsAlertMessage, SrvMonAppStoreBindingFailedMessage, SrvMonAppStoreBindingRoleChangedMessage, SrvMonAppStoreMemberDownMessage, SrvMonAppStoreMemberInitCompleteMessage, SrvMonAppStoreMemberUpMessage, SrvMonAppStoreTransactionLogRepairedMessage, SrvMonAppStuckAlertMessage, SrvMonAppUnhandledMessageMessage, SrvMonAppUnloadedMessage, SrvMonAppUnloadedMessage, SrvMonGetLoadedAppsRequest, SrvMonGetLoadedAppsResponse, SrvMonGetTraceHistoryRequest, SrvMonGetTraceHistoryResponse, SrvMonHeartbeatMessage, SrvMonInvokeCommandRequest, SrvMonInvokeCommandResponse, SrvMonListCommandsRequest, SrvMonListCommandsResponse, SrvMonMessageBusBindingReconnectedMessage, SrvMonMessageBusBindingReconnectingMessage, SrvMonMessageTraceLoggingExceptionMessage, SrvMonStartAppWatchCommand, SrvMonStartTraceWatchRequest, SrvMonStartTraceWatchResponse, SrvMonStopAppWatchCommand, SrvMonStopTraceWatchRequest, SrvMonStopTraceWatchResponse, SrvMonTraceRecord, SrvMonUnhandledMessageMessage, SrvMonXvmInfoRequest, SrvMonXvmInfoResponse

public interface IRogMetadata

Defines the metadata associated with an ROG node.

Method Summary

Methods

Modifier and Type	Method and Description
long	getEnqueueTs() Get a message's enqueue timestamp in milliseconds.
long	getEnqueueTsMicros() Get a message's enqueue timestamp.
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.
MessageTransportHeaders	getMessageTransportHeaders() Returns the message's transport headers.
boolean	getOutMsgsInTransaction() Get whether there are outbound messages in the transaction
long	getOutTs() Get a message's out timestamp in milliseconds.
long	getOutTsMicros() Get a message's out timestamp in microseconds.
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 in milliseconds.
long	getPreProcessingTsMicros() 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 in milliseconds.

This value is the same as getPreProcessingTsMicros() / 1000.

Returns:

the timestamp or 0 if not recorded.

See Also:

getPreProcessingTsMicros()

getPreProcessingTsMicros

long getPreProcessingTsMicros()

Get a message's pre-processing timestamp.

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

Because the pre-processing timestamp is used to provide HA consistent time for an application that is using Event Sourcing as an HaPolicy, this value is guaranteed to be set to the same value as used on the primary instance. A backup instance or a primary recovering from a transaciton log will see the original preProcessingTs value.

This value is set using UtlTime.nowSinceEpoch() (except as noted above)

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.

getOutTs

long getOutTs()

Get a message's out timestamp in milliseconds.

This value is the same as getOutTsMicros() / 1000.

Returns:

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

See Also:

getOutTsMicros()

getOutTsMicros

long getOutTsMicros()

Get a message's out timestamp in microseconds.

This timestamp is the same timestamp as which an application called send to initiate the send for the message.

Note that this timestamp is not the timestamp at which a message is actually written to the wire for delivery. A sent message is queued for delivery until the transaction that is is part of is committed.

This value is set using UtlTime.nowSinceEpoch()

Returns:

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

getEnqueueTs

long getEnqueueTs()

Get a message's enqueue timestamp in milliseconds.

This timestamp is the same as getEnqueueTsMicros() / 1000.

Returns:

Returns the in timestamp. A value of zero indicates that the enqueue timestamp was not recorded.

See Also:

getEnqueueTsMicros()

getEnqueueTsMicros

long getEnqueueTsMicros()

Get a message's enqueue timestamp.

This timestamp, in microseconds, specifies the time just before a message was enqueued on an application's input queue.

This timestamp can be compared with getPreProcessingTsMicros() to determine the amount of time that the message spent on an application's input queue unless the application is configured to use Event Sourcing and the message is one re-enqueued during recovery from a transaction or received by a backup instance via replication.

This value is set using UtlTime.nowSinceEpoch()

Returns:

Returns the in timestamp. A value of zero indicates that the inbound timestamp was not recorded.

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.

getMessageTransportHeaders

MessageTransportHeaders getMessageTransportHeaders()

Returns the message's transport headers.

Message transport headers store generic name/value pairs that are specific to a concrete messaging provider. Each message bus binding will typically support a different set of transport headers. On receipt of a message the binding pulls values off of the native message type and stores them in the transport header. For sent messages a binding implementation may support propagating values set in the transport header on the underlying native message type.

Returns:

The message transport headers or null if transport headers are disabled, not present, or unsupported by the MessageView

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