com.neeve.server.mon.lifecycle

Interface ISrvMonAppEngineStartedMessage

All Superinterfaces:

CopyableMessageView<ISrvMonAppEngineStartedMessage>, com.neeve.server.mon.common.IHasSrvMonXvmHeader, IRogCopyableNode<ISrvMonAppEngineStartedMessage>, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, com.neeve.server.mon.common.ISrvMonEvent, com.neeve.server.mon.common.ISrvMonLifecycleEvent, IStoreObject, IStoreObjectMetadata, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker

All Known Implementing Classes:

SrvMonAppEngineStartedMessage

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:31 EDT 2020")
@AdmGenerated(compatLevel="4.0.0",
              admVersion="nvx-rumi-adm v3.14 (build 29)",
              date="5/7/20 3:37 PM",
              buildInfo="nvx-talon-3.14.19 (nvx-codegen-plugin)")
public interface ISrvMonAppEngineStartedMessage
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonAppEngineStartedMessage>, com.neeve.server.mon.common.ISrvMonLifecycleEvent

Event notifying an AEP application that its engine has started.

This event is dispatched to an application to notify it that the AEP engine has been successfully started.

ADM Details

ADM Type	Message
Factory	SrvMonLifecycleFactory

ADM Field Summary

Field	Type	Id	Description
eventSource	String	6006	The source of an event.
eventTimestamp	Date	6007	The timestamp of an event.
timestamp	Long	1	The timestamp at which this event occurred (millis since the epoch).
xvmHeader	SrvMonXvmHeader	6004	Details about the message source.

Nested Class Summary

Nested classes/interfaces inherited from interface com.neeve.rog.IRogNode

IRogNode.PoolingListener

Nested classes/interfaces inherited from interface com.neeve.ods.IStoreObject

IStoreObject.EncodingType

Method Summary

Methods

Modifier and Type	Method and Description
void	clearEventSource() Clears the value of 'eventSource'.
void	clearEventTimestamp() Clears the value of 'eventTimestamp'.
void	clearTimestamp() Deprecated. - Use eventTimestamp instead.
void	clearXvmHeader() Clears the value of 'xvmHeader'.
SrvMonAppEngineStartedMessage	copy() Creates a copy of this SrvMonAppEngineStartedMessage.
void	copyInto(SrvMonAppEngineStartedMessage target) Copies the contents of this SrvMonAppEngineStartedMessage into the target.
String	getEventSource() Gets the value of 'eventSource'.
<T extends XString> T	getEventSourceTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getEventSourceTo(XString val) Copies the value of 'eventSource' into the provided XString.
XString	getEventSourceUnsafe() Gets the raw value of 'eventSource'.
Date	getEventTimestamp() Gets the value of 'eventTimestamp'.
long	getEventTimestampAsTimestamp() Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
long	getTimestamp() Deprecated. - Use eventTimestamp instead.
com.neeve.server.mon.common.SrvMonXvmHeader	getXvmHeader() Gets the value of 'xvmHeader'.
void	getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val) Copies the value of SrvMonXvmHeader into the provided value.
boolean	hasEventSource() Checks for the presence of 'eventSource'.
boolean	hasEventTimestamp() Checks for the presence of 'eventTimestamp'.
boolean	hasTimestamp() Deprecated. - Use eventTimestamp instead.
boolean	hasXvmHeader() Checks for the presence of 'xvmHeader'.
void	lendEventSource(XString val) Lends the value of 'eventSource' to this object.
void	lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val) 'Lends' a reference of the SrvMonXvmHeader to the message for this field.
void	setEventSource(String val) Sets the value of 'eventSource'.
void	setEventSourceFrom(long val) Sets the value of this String field to the given numeric value.
void	setEventSourceFrom(XString val) Copies the provided XString value into this object's 'eventSource'.
void	setEventTimestamp(Date val) Sets the value of 'eventTimestamp'.
void	setEventTimestampAsTimestamp(long val) Sets the date value as a timestamp.
void	setTimestamp(long val) Deprecated. - Use eventTimestamp instead.
void	setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val) Sets the value of 'xvmHeader'.
com.neeve.server.mon.common.SrvMonXvmHeader	takeXvmHeader() 'Takes' a reference to the xvmHeader field from the message.

Methods inherited from interface com.neeve.rog.IRogNode

deserializeFromProtobuf, dispose, dump, getAttachment, getIsLiveInboundMessage, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, serializeToProtobuf, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReadOnly, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumber

Methods inherited from interface com.neeve.ods.IStoreObject

acquire, deserialize, deserializeMetadata, deserializeMetadata, getContentEncodingType, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, serialize, serializeMetadata, setFieldValue

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata

ensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, setId, setStableTransactionId, setTransactionId

Methods inherited from interface com.neeve.sma.MapMessageView

getMessageReflector

Methods inherited from interface com.neeve.rog.IRogMetadata

getEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToString

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setEventTimestamp

void setEventTimestamp(Date val)

Sets the value of 'eventTimestamp'.

Field Description

The timestamp of an event.

Specified by:

setEventTimestamp in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

setEventTimestamp in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Parameters:

val - The value to set.

getEventTimestamp

Date getEventTimestamp()

Gets the value of 'eventTimestamp'.

Field Description

The timestamp of an event.

Specified by:

getEventTimestamp in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

getEventTimestamp in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Returns:

The timestamp of an event.

setEventTimestampAsTimestamp

void setEventTimestampAsTimestamp(long val)

Sets the date value as a timestamp.

Field Description

The timestamp of an event.

Specified by:

setEventTimestampAsTimestamp in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

setEventTimestampAsTimestamp in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Parameters:

val - The date value in milliseconds from the epoch

getEventTimestampAsTimestamp

long getEventTimestampAsTimestamp()

Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).

Field Description

The timestamp of an event.

NOTE:
Note that a return value of -1 could also indicate 1 millisecond before the epoch. In cases where a such an ambiguity is a practical concern, hasEventTimestamp() should be called.

Specified by:

getEventTimestampAsTimestamp in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

getEventTimestampAsTimestamp in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Returns:

The data as a timestamp in milliseconds from the epoch or -1 if null or not set

clearEventTimestamp

void clearEventTimestamp()

Clears the value of 'eventTimestamp'.

Field Description

The timestamp of an event.

Specified by:

clearEventTimestamp in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

clearEventTimestamp in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

See Also:

setEventTimestamp(Date)

hasEventTimestamp

boolean hasEventTimestamp()

Checks for the presence of 'eventTimestamp'.

Field Description

The timestamp of an event.

Specified by:

hasEventTimestamp in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

hasEventTimestamp in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

See Also:

getEventTimestamp()

setTimestamp

@Deprecated
void setTimestamp(long val)

Deprecated. - Use eventTimestamp instead.

Sets the value of 'timestamp'.

Field Description

The timestamp at which this event occurred (millis since the epoch).

Parameters:

val - The value to set.

getTimestamp

@Deprecated
long getTimestamp()

Deprecated. - Use eventTimestamp instead.

Gets the value of 'timestamp'.

Field Description

The timestamp at which this event occurred (millis since the epoch).

Returns:

The timestamp at which this event occurred (millis since the epoch).

clearTimestamp

@Deprecated
void clearTimestamp()

Deprecated. - Use eventTimestamp instead.

Clears the value of 'timestamp'.

Field Description

The timestamp at which this event occurred (millis since the epoch).

See Also:

setTimestamp(long)

hasTimestamp

@Deprecated
boolean hasTimestamp()

Deprecated. - Use eventTimestamp instead.

Checks for the presence of 'timestamp'.

Field Description

The timestamp at which this event occurred (millis since the epoch).

See Also:

getTimestamp()

setXvmHeader

void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)

Sets the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

setXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

setXvmHeader in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

setXvmHeader in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Parameters:

val - The value to set.

lendXvmHeader

void lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)

'Lends' a reference of the SrvMonXvmHeader to the message for this field.

Field Description

Details about the message source.

NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().

To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.

Specified by:

lendXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

lendXvmHeader in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

lendXvmHeader in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Parameters:

val - the value to 'lend' to lend.

getXvmHeader

com.neeve.server.mon.common.SrvMonXvmHeader getXvmHeader()

Gets the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

getXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

getXvmHeader in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

getXvmHeader in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Returns:

Details about the message source.

getXvmHeaderTo

void getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val)

Copies the value of SrvMonXvmHeader into the provided value.

IF the value is not set, then the contents of the provided SrvMonXvmHeader are cleared.

Specified by:

getXvmHeaderTo in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

getXvmHeaderTo in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

getXvmHeaderTo in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Parameters:

val - the value to copy into

See Also:

SrvMonXvmHeader.copyInto(SrvMonXvmHeader)

takeXvmHeader

com.neeve.server.mon.common.SrvMonXvmHeader takeXvmHeader()

'Takes' a reference to the xvmHeader field from the message.

Field Description

Details about the message source.

NOTE:
A nested entity reference returned by getXXX() is only valid until the entity is disposed i.e. the act of getting an entity does not transfer ownership of the entity to the application A message disposes of its reference to its contained entities when it is disposed itself.

An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.

Specified by:

takeXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

takeXvmHeader in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

takeXvmHeader in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Returns:

a 'taken' reference to the field or null if the field is not set.

hasXvmHeader

boolean hasXvmHeader()

Checks for the presence of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

hasXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

hasXvmHeader in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

hasXvmHeader in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

See Also:

getXvmHeader()

clearXvmHeader

void clearXvmHeader()

Clears the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

clearXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

clearXvmHeader in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

clearXvmHeader in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

See Also:

setXvmHeader(SrvMonXvmHeader)

setEventSource

void setEventSource(String val)

Sets the value of 'eventSource'.

Field Description

The source of an event.

Specified by:

setEventSource in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

setEventSource in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Parameters:

val - The value to set.

getEventSource

String getEventSource()

Gets the value of 'eventSource'.

Field Description

The source of an event.

Specified by:

getEventSource in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

getEventSource in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Returns:

The source of an event.

lendEventSource

void lendEventSource(XString val)

Lends the value of 'eventSource' to this object.

This method is equivalent to setEventSource except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.

Field Description

The source of an event.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.

Specified by:

lendEventSource in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

lendEventSource in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setEventSourceFrom

void setEventSourceFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

The source of an event.

NOTE:
This is the same as calling setEventSource(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setEventSourceFrom in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

setEventSourceFrom in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

getEventSourceTo

<T extends XString> T getEventSourceTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

The source of an event.

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Specified by:

getEventSourceTo in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

getEventSourceTo in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setEventSourceFrom

void setEventSourceFrom(XString val)

Copies the provided XString value into this object's 'eventSource'.

Field Description

The source of an event.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setEventSource(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setEventSourceFrom in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

setEventSourceFrom in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

getEventSourceTo

void getEventSourceTo(XString val)

Copies the value of 'eventSource' into the provided XString.

Field Description

The source of an event.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getEventSource() bec because it can avoid decoding the value into an String.

Specified by:

getEventSourceTo in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

getEventSourceTo in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

See Also:

getEventSource()

getEventSourceUnsafe

XString getEventSourceUnsafe()

Gets the raw value of 'eventSource'.

Field Description

The source of an event.

NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.

However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.

Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.

Specified by:

getEventSourceUnsafe in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

getEventSourceUnsafe in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

Returns:

the field's raw value

See Also:

getEventSource()

clearEventSource

void clearEventSource()

Clears the value of 'eventSource'.

Field Description

The source of an event.

Specified by:

clearEventSource in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

clearEventSource in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

See Also:

setEventSource(String)

hasEventSource

boolean hasEventSource()

Checks for the presence of 'eventSource'.

Field Description

The source of an event.

Specified by:

hasEventSource in interface com.neeve.server.mon.common.ISrvMonEvent

Specified by:

hasEventSource in interface com.neeve.server.mon.common.ISrvMonLifecycleEvent

See Also:

getEventSource()

copy

SrvMonAppEngineStartedMessage copy()

Creates a copy of this SrvMonAppEngineStartedMessage.

The copy copies primitive, enum and embedded entity fields into the returned copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonAppEngineStartedMessage's embedded entity fields.

The returned copy will be writeable even if this SrvMonAppEngineStartedMessage is read only.

No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.

Specified by:

copy in interface CopyableMessageView<ISrvMonAppEngineStartedMessage>

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppEngineStartedMessage>

Returns:

A copy of this SrvMonAppEngineStartedMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonAppEngineStartedMessage target)

Copies the contents of this SrvMonAppEngineStartedMessage into the target.

The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonAppEngineStartedMessage's embedded entity fields.

The returned copy will be writeable even if this SrvMonAppEngineStartedMessage is read only.

No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.

Parameters:

target - The target to copy into which must not be null or read only.