com.neeve.server.mon
Interface ISrvMonAppFlowCreateMessage

All Superinterfaces:

CopyableMessageView<ISrvMonAppFlowCreateMessage>, IRogCopyableNode<ISrvMonAppFlowCreateMessage>, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, IStoreObject, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker

All Known Implementing Classes:

SrvMonAppFlowCreateMessage

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
public interface ISrvMonAppFlowCreateMessage
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonAppFlowCreateMessage>

Emitted by a Talon Server to registered admin clients when an app flow has been created.

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

void	clearAppName() Clears the value of 'appName' Field Description The name of the app that created the flow.
void	clearFlowInfo() Clears the value of 'flowInfo' Field Description Holds details about the created flow.
SrvMonAppFlowCreateMessage	copy() Creates a copy of this SrvMonAppFlowCreateMessage.
void	copyInto(SrvMonAppFlowCreateMessage target) Copies the contents of this SrvMonAppFlowCreateMessage into the target.
String	getAppName() Gets the value of 'appName' Field Description The name of the app that created the flow.
<T extends XString> T	getAppNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getAppNameTo(XString val) Copies the value of 'appName' into the provided XString.
XString	getAppNameUnsafe() Gets the raw value of 'appName'.
SrvMonAppFlowInfo	getFlowInfo() Gets the value of 'flowInfo' Field Description Holds details about the created flow.
void	getFlowInfoTo(SrvMonAppFlowInfo val) Copies the value of SrvMonAppFlowInfo into the provided value.
boolean	hasAppName() Checks for the presence of 'appName' Field Description The name of the app that created the flow.
boolean	hasFlowInfo() Checks for the presence of 'flowInfo' Field Description Holds details about the created flow.
void	lendAppName(XString val) Sets the value of 'appName' Field Description The name of the app that created the flow.
void	lendFlowInfo(SrvMonAppFlowInfo val) 'Lends' a reference of the SrvMonAppFlowInfo to the message for this field.
void	setAppName(String val) Sets the value of 'appName' Field Description The name of the app that created the flow.
void	setAppNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setAppNameFrom(XString val) Copies the provided XString value into this object's 'appName'.
void	setFlowInfo(SrvMonAppFlowInfo val) Sets the value of 'flowInfo' Field Description Holds details about the created flow.
SrvMonAppFlowInfo	takeFlowInfo() 'Takes' a reference to the flowInfo field from the message.

Methods inherited from interface com.neeve.rog.IRogNode

deserializeFromProtobuf, dispose, dump, getAttachment, 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, ensureId, getBinding, getCheckpointVersion, getContentEncodingType, getId, getOfid, getOwnershipCount, getSerializedMetadataLength, getStableTransactionId, getTransactionId, serialize, serializeMetadata, setBinding, setCheckpointVersion, setFieldValue, 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, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToString

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setAppName

void setAppName(String val)

Sets the value of 'appName'

Field Description

The name of the app that created the flow.

Parameters:

val - The value to set.

getAppName

String getAppName()

Gets the value of 'appName'

Field Description

The name of the app that created the flow.

Returns:

The name of the app that created the flow.

lendAppName

void lendAppName(XString val)

Sets the value of 'appName'

Field Description

The name of the app that created the flow.

Parameters:

val - The value to set.

setAppNameFrom

void setAppNameFrom(long val)

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

Field Description

The name of the app that created the flow.

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

getAppNameTo

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

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

Field Description

The name of the app that created the flow.

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;

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

setAppNameFrom

void setAppNameFrom(XString val)

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

Field Description

The name of the app that created the flow.

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

getAppNameTo

void getAppNameTo(XString val)

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

Field Description

The name of the app that created the flow.

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

See Also:

getAppName()

getAppNameUnsafe

XString getAppNameUnsafe()

Gets the raw value of 'appName'.

Field Description

The name of the app that created the flow.

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.

Returns:

the field's raw value

See Also:

getAppName()

clearAppName

void clearAppName()

Clears the value of 'appName'

Field Description

The name of the app that created the flow.

See Also:

setAppName(String)

hasAppName

boolean hasAppName()

Checks for the presence of 'appName'

Field Description

The name of the app that created the flow.

See Also:

getAppName()

setFlowInfo

void setFlowInfo(SrvMonAppFlowInfo val)

Sets the value of 'flowInfo'

Field Description

Holds details about the created flow.

Parameters:

val - The value to set.

lendFlowInfo

void lendFlowInfo(SrvMonAppFlowInfo val)

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

Field Description

Holds details about the created flow.

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.

Parameters:

val - the value to 'lend' to lend.

getFlowInfo

SrvMonAppFlowInfo getFlowInfo()

Gets the value of 'flowInfo'

Field Description

Holds details about the created flow.

Returns:

Holds details about the created flow.

getFlowInfoTo

void getFlowInfoTo(SrvMonAppFlowInfo val)

Copies the value of SrvMonAppFlowInfo into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonAppFlowInfo.copyInto(SrvMonAppFlowInfo)

takeFlowInfo

SrvMonAppFlowInfo takeFlowInfo()

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

Field Description

Holds details about the created flow.

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.

Returns:

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

hasFlowInfo

boolean hasFlowInfo()

Checks for the presence of 'flowInfo'

Field Description

Holds details about the created flow.

See Also:

getFlowInfo()

clearFlowInfo

void clearFlowInfo()

Clears the value of 'flowInfo'

Field Description

Holds details about the created flow.

See Also:

setFlowInfo(SrvMonAppFlowInfo)

copy

SrvMonAppFlowCreateMessage copy()

Creates a copy of this SrvMonAppFlowCreateMessage.

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 SrvMonAppFlowCreateMessage's embedded entity fields.

The returned copy will be writeable even if this SrvMonAppFlowCreateMessage 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<ISrvMonAppFlowCreateMessage>

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppFlowCreateMessage>

Returns:

A copy of this SrvMonAppFlowCreateMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonAppFlowCreateMessage target)

Copies the contents of this SrvMonAppFlowCreateMessage 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 SrvMonAppFlowCreateMessage's embedded entity fields.

The returned copy will be writeable even if this SrvMonAppFlowCreateMessage 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.