com.neeve.server.mon

Class SrvMonAppFlowCreateMessage

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.sma.MessageViewImpl

com.neeve.rog.impl.RogNode

com.neeve.server.mon.SrvMonAppFlowCreateMessage

All Implemented Interfaces:

com.neeve.link.ILnkMessage, IStoreObject, IStoreObjectMetadata, IRogCopyableNode<ISrvMonAppFlowCreateMessage>, IRogJsonizable, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, ISrvMonAppFlowCreateMessage, CopyableMessageView<ISrvMonAppFlowCreateMessage>, MapMessageView, MessageReflector, MessageView, UtlReferenceTracker.HasReferenceTracker, com.neeve.xbuf.IXbufDesyncer

Deprecated.

- This message type has been replaced with that of the same name in the SrvMonLifecycleFactory.

ADM Details

ADM Type	Message
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
appName	String	16	The name of the app that created the flow.
flowInfo	SrvMonAppFlowInfo	17	Holds details about the created flow.

@Deprecated
@Generated(value="com.neeve.adm.AdmXbufGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(encoding="Xbuf",
              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)")
@AdmFactoryInfo(factoryClass=SrvMonFactory.class,
                vfid=32,
                ofid=32,
                typeId=10)
public final class SrvMonAppFlowCreateMessage
extends com.neeve.rog.impl.RogNode
implements ISrvMonAppFlowCreateMessage, com.neeve.link.ILnkMessage, MessageReflector, com.neeve.xbuf.IXbufDesyncer, IRogJsonizable

The 'SrvMonAppFlowCreateMessage' type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SrvMonAppFlowCreateMessage.PacketBody Deprecated. The backing packet type for SrvMonAppFlowCreateMessage (used internally for serialization purposes).

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

IRogNode.PoolingListener

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

IStoreObject.EncodingType

Field Summary

Fields

Modifier and Type	Field and Description
static SrvMonAppFlowCreateMessage[]	EMPTY_ARRAY Deprecated. A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Fields inherited from class com.neeve.rog.impl.RogNode

DATE_FORMAT

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

Methods

Modifier and Type	Method and Description
boolean	appendFieldValueTo(Object node, String[] pathComponents, XString target) Deprecated. Appends a reflected field value as a string into the given XString.
boolean	appendFieldValueTo(Object message, String name, XString target) Deprecated. Appends a reflected field value as a string into the given XString.
void	clearAppName() Deprecated. Clears the value of 'appName'.
void	clearContent() Deprecated.
void	clearFlowInfo() Deprecated. Clears the value of 'flowInfo'.
void	clearXRogType() Deprecated.
SrvMonAppFlowCreateMessage	copy() Deprecated. Creates a copy of this SrvMonAppFlowCreateMessage.
void	copyInto(SrvMonAppFlowCreateMessage copy) Deprecated. Copies the contents of this SrvMonAppFlowCreateMessage into the target.
static SrvMonAppFlowCreateMessage	create() Deprecated.
static SrvMonAppFlowCreateMessage	create(com.eaio.uuid.UUID id) Deprecated.
static SrvMonAppFlowCreateMessage	createFrom(byte[] serializedContainer) Deprecated.
static SrvMonAppFlowCreateMessage	createFrom(ByteBuffer serializedContainer) Deprecated.
static SrvMonAppFlowCreateMessage	createFromJson(String json) Deprecated.
static SrvMonAppFlowCreateMessage	createFromRawJson(String json) Deprecated.
static SrvMonAppFlowCreateMessage	createFromSerializedXbufContainer(byte[] serializedContainer) Deprecated.
static SrvMonAppFlowCreateMessage	createFromSerializedXbufContainer(ByteBuffer serializedContainer) Deprecated.
static SrvMonAppFlowCreateMessage	createFromSerializedXbufContainerPacket(byte[] serializedPacket) Deprecated.
static SrvMonAppFlowCreateMessage	createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket) Deprecated.
static SrvMonAppFlowCreateMessage	createFromXbufContainerPacket(PktPacket packet) Deprecated.
static com.neeve.xbuf.XbufSchema	createSchema() Deprecated.
SrvMonAppFlowCreateMessage	deserialize(PktPacket packet) Deprecated. Deserialize an object's data.
SrvMonAppFlowCreateMessage	deserializeFromByteArray(byte[] array) Deprecated. Deserialize a view's backing message from a byte array.
SrvMonAppFlowCreateMessage	deserializeFromByteBuffer(ByteBuffer buffer) Deprecated. Deserialize a view's backing message from a byte buffer.
SrvMonAppFlowCreateMessage	deserializeFromJson(String json) Deprecated. Deserialize a view's backing message from a json string
SrvMonAppFlowCreateMessage	deserializeFromPacket(PktPacket packet) Deprecated. Deserialize a view's backing message from a packet.
SrvMonAppFlowCreateMessage	deserializeFromProtobuf(com.google.protobuf.Message message) Deprecated. Deserialize a node's data from a protobuf message.
SrvMonAppFlowCreateMessage	deserializeFromRawJson(String json) Deprecated.
int	desync(PktBuffer buffer, int pos, boolean frameOnly) Deprecated. Desync fields from a buffer
void	desyncFieldBitmask() Deprecated.
int	dispose() Deprecated. Implementation of IRogNode.dispose() ROG nodes piggyback on packet pooling to perform node pooling.
boolean	fieldExists(Object message, String name) Deprecated. Check if a field of the supplied name exists in a message.
String	getAppName() Deprecated. Gets the value of 'appName'.
com.neeve.xbuf.XbufStringField	getAppNameField() Deprecated.
static int	getAppNameFieldId() Deprecated.
<T extends XString> T	getAppNameTo(XString.Factory<T> factory) Deprecated. Copies the value of this String field into a new XString from the given factory.
void	getAppNameTo(XString val) Deprecated. Copies the value of 'appName' into the provided XString.
XString	getAppNameUnsafe() Deprecated. Gets the raw value of 'appName'.
PktBuffer	getBackingBuffer() Deprecated.
IStoreObject.EncodingType	getContentEncodingType() Deprecated. Get an object's content data encoding type.
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy() Deprecated.
XString	getFieldValueAsRawString(Object message, String name) Deprecated. Get the value of a reflectable field in a message as a string.
XString	getFieldValueAsRawString(Object message, String[] pathComponents) Deprecated. Get the value of a reflectable field in a message as a string.
String	getFieldValueAsString(Object message, String name) Deprecated. Get the value of a reflectable field in a message as a string.
String	getFieldValueAsString(Object message, String[] pathComponents) Deprecated. Get the value of a reflectable field in a message as a string.
SrvMonAppFlowInfo	getFlowInfo() Deprecated. Gets the value of 'flowInfo'.
static int	getFlowInfoFieldId() Deprecated.
void	getFlowInfoTo(SrvMonAppFlowInfo to) Deprecated. Copies the value of SrvMonAppFlowInfo into the provided value.
PktPacket	getPacket() Deprecated. Return the packet tied to this message.
short	getXRogType() Deprecated.
com.neeve.xbuf.XbufVariableShortField	getXRogTypeField() Deprecated.
static int	getXRogTypeFieldId() Deprecated.
boolean	hasAppName() Deprecated. Checks for the presence of 'appName'.
boolean	hasFlowInfo() Deprecated. Checks for the presence of 'flowInfo'.
boolean	hasXRogType() Deprecated.
boolean	isDirty() Deprecated.
boolean	isFieldReflectable(Object message, String name) Deprecated. Check if a field of the supplied name is reflectable.
void	lendAppName(XString val) Deprecated. Lends the value of 'appName' to this object.
void	lendFlowInfo(SrvMonAppFlowInfo val) Deprecated. 'Lends' a reference of the SrvMonAppFlowInfo to the message for this field.
boolean	needsSync() Deprecated. Check if a view needs to be sync'd for reflection.
static void	optimizeFor(int val) Deprecated.
PktPacket	serialize() Deprecated. Serialize an object's data.
byte[]	serializeToByteArray() Deprecated. Serialize a view's backing message to a byte array.
ByteBuffer	serializeToByteBuffer() Deprecated. Serialize a view's backing message to a byte buffer.
com.neeve.io.IOBuffer	serializeToIOBuffer(boolean useNative) Deprecated. Serializes the MessageView to an IOBuffer.
String	serializeToJson() Deprecated. Serialize a view's backing message to JSON.
PktPacket	serializeToPacket() Deprecated. Serialize a view's backing message to a packet.
com.google.protobuf.Message	serializeToProtobuf() Deprecated. Serialize a node's data to a proto message.
String	serializeToRawJson() Deprecated.
void	setAppName(String val) Deprecated. Sets the value of 'appName'.
void	setAppNameFrom(long val) Deprecated. Sets the value of this String field to the given numeric value.
void	setAppNameFrom(com.neeve.xbuf.XbufStringField val) Deprecated.
void	setAppNameFrom(XString val) Deprecated. Copies the provided XString value into this object's 'appName'.
void	setAsReadOnly() Deprecated. Implementation of IRogNode.setAsReadOnly()
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val) Deprecated.
static void	setFieldInterest(List<Integer> fieldIds) Deprecated.
IStoreObject	setFieldValue(int id, Object val) Deprecated.
void	setFlowInfo(SrvMonAppFlowInfo val) Deprecated. Sets the value of 'flowInfo'.
void	setPreserializedFields(PktBuffer buffer) Deprecated.
void	setXRogType(short val) Deprecated.
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val) Deprecated.
void	sync() Deprecated. Ensure a view's backing message is prepared and ready for transport
void	syncFieldBitmask() Deprecated.
SrvMonAppFlowInfo	takeFlowInfo() Deprecated. 'Takes' a reference to the flowInfo field from the message.
String	toJsonString() Deprecated. Get a JSON representation of an ROG entity
String	toJsonString(boolean includeMetadata, String metadataObjectName, String payloadObjectName) Deprecated. Get a full JSON representation of an ROG entity
String	toString() Deprecated. Return a string representation of an ROG node.
void	undispose(com.eaio.uuid.UUID id) Deprecated. Recuscitate a disposed node.

Methods inherited from class com.neeve.rog.impl.RogNode

accept, deserializeMetadata, deserializeMetadata, dump, ensureId, getAppSendBeginTs, getAppSendDoneTs, getAttachment, getBinding, getCheckpointVersion, getCommittedDataSize, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getFields, getGraphId, getId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsLiveInboundMessage, getIsMessage, getIsOutboundMessage, getIsPriority, getIsReadOnly, getIsReplayedMessage, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageReflector, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getMetadata, getOfid, getOriginTs, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParent, getParentId, getPoolingListener, getPostDeserializeTs, getPostProcessingTs, getPostProcessingTsMicros, getPostSerializeTs, getPostWireSendTs, getPostWireTs, getPreDeserializeTs, getPreProcessingTs, getPreProcessingTsMicros, getPreSerializeTs, getPreWireTs, getReceiveTs, getSendStartTs, getSendTs, getSerializedMetadataLength, getStableTransactionId, getStoreMetadata, getTransactionId, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, getTypeFromJson, getValidationErrors, isPossibleDuplicate, isValid, metadataToJsonString, metadataToJsonString, metadataToString, resolveMessageKeyWith, resolveMessageKeyWith, saveMemory, serializeMetadata, setAppSendBeginTs, setAppSendDoneTs, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setBinding, setCheckpointVersion, setCommittedDataSize, setCreateTs, setEnqueueTsMicros, setFieldValue, setGraphId, setId, setInMsgsInTransaction, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageSender, setMessageSequenceNumber, setMessageTransportHeaders, setOriginTs, setOutMsgsInTransaction, setOutTs, setOutTsMicros, setParentId, setPoolingListener, setPossibleDuplicate, setPostDeserializeTs, setPostProcessingTs, setPostProcessingTsMicros, setPostSerializeTs, setPostWireSendTs, setPostWireTs, setPreDeserializeTs, setPreProcessingTs, setPreProcessingTsMicros, setPreSerializeTs, setPreWireTs, setReceiveTs, setSendStartTs, setSendTs, setStableTransactionId, setTransactionId, setTransactionInSequenceNumber, setTransactionOutSequenceNumber

Methods inherited from class com.neeve.sma.MessageViewImpl

acquire, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, referenceTracker, setTag

Methods inherited from class com.neeve.util.UtlListElement

count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.neeve.rog.IRogNode

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

Methods inherited from interface com.neeve.ods.IStoreObject

acquire, deserializeMetadata, deserializeMetadata, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, 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

Field Detail

EMPTY_ARRAY

public static final SrvMonAppFlowCreateMessage[] EMPTY_ARRAY

Deprecated.

A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Method Detail

create

public static SrvMonAppFlowCreateMessage create()

Deprecated.

create

public static SrvMonAppFlowCreateMessage create(com.eaio.uuid.UUID id)

Deprecated.

createFromXbufContainerPacket

public static SrvMonAppFlowCreateMessage createFromXbufContainerPacket(PktPacket packet)

Deprecated.

createFromSerializedXbufContainerPacket

public static SrvMonAppFlowCreateMessage createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)

Deprecated.

createFromSerializedXbufContainerPacket

public static SrvMonAppFlowCreateMessage createFromSerializedXbufContainerPacket(byte[] serializedPacket)

Deprecated.

createFromSerializedXbufContainer

public static SrvMonAppFlowCreateMessage createFromSerializedXbufContainer(ByteBuffer serializedContainer)

Deprecated.

createFromSerializedXbufContainer

public static SrvMonAppFlowCreateMessage createFromSerializedXbufContainer(byte[] serializedContainer)

Deprecated.

createFromRawJson

public static SrvMonAppFlowCreateMessage createFromRawJson(String json)

Deprecated.

createFromJson

public static SrvMonAppFlowCreateMessage createFromJson(String json)

Deprecated.

createFrom

public static SrvMonAppFlowCreateMessage createFrom(ByteBuffer serializedContainer)

Deprecated.

createFrom

public static SrvMonAppFlowCreateMessage createFrom(byte[] serializedContainer)

Deprecated.

setDesyncPolicy

public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)

Deprecated.

getDesyncPolicy

public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()

Deprecated.

setFieldInterest

public static final void setFieldInterest(List<Integer> fieldIds)

Deprecated.

clearContent

public final void clearContent()

Deprecated.

syncFieldBitmask

public final void syncFieldBitmask()

Deprecated.

desyncFieldBitmask

public final void desyncFieldBitmask()

Deprecated.

getBackingBuffer

public final PktBuffer getBackingBuffer()

Deprecated.

optimizeFor

public static final void optimizeFor(int val)

Deprecated.

getPacket

public final PktPacket getPacket()

Deprecated.

Description copied from interface: com.neeve.link.ILnkMessage

Return the packet tied to this message.

Specified by:

getPacket in interface com.neeve.link.ILnkMessage

serializeToProtobuf

public final com.google.protobuf.Message serializeToProtobuf()

Deprecated.

Description copied from interface: IRogNode

Serialize a node's data to a proto message.

Specified by:

serializeToProtobuf in interface IRogNode

serializeToRawJson

public final String serializeToRawJson()

Deprecated.

serializeToJson

public final String serializeToJson()

Deprecated.

Description copied from interface: MessageView

Serialize a view's backing message to JSON.

Serializing/deserializing a message to/from JSON is an optional operation

Specified by:

serializeToJson in interface MessageView

deserializeFromProtobuf

public final SrvMonAppFlowCreateMessage deserializeFromProtobuf(com.google.protobuf.Message message)

Deprecated.

Description copied from interface: IRogNode

Deserialize a node's data from a protobuf message.

Specified by:

deserializeFromProtobuf in interface IRogNode

Parameters:

message - The protobuf message

deserializeFromRawJson

public final SrvMonAppFlowCreateMessage deserializeFromRawJson(String json)

Deprecated.

deserializeFromJson

public final SrvMonAppFlowCreateMessage deserializeFromJson(String json)

Deprecated.

Description copied from interface: MessageView

Deserialize a view's backing message from a json string

Specified by:

deserializeFromJson in interface MessageView

Parameters:

json - The view's backing message serialized as a json string.

Serializing/deserializing a message to/from JSON is an optional operation

setAsReadOnly

public final void setAsReadOnly()

Deprecated.

Description copied from class: com.neeve.rog.impl.RogNode

Implementation of IRogNode.setAsReadOnly()

Specified by:

setAsReadOnly in interface IRogNode

Overrides:

setAsReadOnly in class com.neeve.rog.impl.RogNode

dispose

public int dispose()

Deprecated.

Description copied from class: com.neeve.rog.impl.RogNode

Implementation of IRogNode.dispose()

ROG nodes piggyback on packet pooling to perform node pooling. When this disposed, nodes release their reference to their backing packet (if a node is not backed by a packet, the this method does nothing and the node is released for garbage collection). The reference release will cause the packet to ultimately enter into its pool (if a poolable packet type). Since nodes are tagged to packets (via TAG_ROG_ENVELOPE), nodes implictly also get pooled. To resuscitate a disposed node, the user should get the node from its packet and invoke RogNode.undispose(com.eaio.uuid.UUID)

Specified by:

dispose in interface IStoreObject

Specified by:

dispose in interface IRogNode

Specified by:

dispose in interface MessageView

Overrides:

dispose in class com.neeve.rog.impl.RogNode

Returns:

The reference count after the dispose completed.

undispose

public void undispose(com.eaio.uuid.UUID id)

Deprecated.

Description copied from class: com.neeve.rog.impl.RogNode

Recuscitate a disposed node.

Overrides:

undispose in class com.neeve.rog.impl.RogNode

Parameters:

id - The resuscitated node's id.

This method should be called to resuscitate a disposed node. Since the caller must release all references to a disposed node, the only place a disposed node can be obtained from is its pooled backing packet container. Upon retrieving a packet from a pool, the user should obtain the node from the TAG_ROG_ENVELOPE packet tag. If the tag is non-null, then it refers to an ROG node object. The user should invoke this method on the node before using the node.

setPreserializedFields

public final void setPreserializedFields(PktBuffer buffer)

Deprecated.

getXRogTypeFieldId

public static final int getXRogTypeFieldId()

Deprecated.

setXRogType

public final void setXRogType(short val)

Deprecated.

getXRogType

public final short getXRogType()

Deprecated.

setXRogTypeFrom

public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)

Deprecated.

getXRogTypeField

public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()

Deprecated.

hasXRogType

public final boolean hasXRogType()

Deprecated.

clearXRogType

public final void clearXRogType()

Deprecated.

getAppNameFieldId

public static final int getAppNameFieldId()

Deprecated.

setAppName

public final void setAppName(String val)

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

Sets the value of 'appName'.

Field Description

The name of the app that created the flow.

Specified by:

setAppName in interface ISrvMonAppFlowCreateMessage

Parameters:

val - The value to set.

getAppName

public final String getAppName()

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

Gets the value of 'appName'.

Field Description

The name of the app that created the flow.

Specified by:

getAppName in interface ISrvMonAppFlowCreateMessage

Returns:

The name of the app that created the flow.

lendAppName

public final void lendAppName(XString val)

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

Lends the value of 'appName' to this object.

This method is equivalent to setAppName 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 name of the app that created the flow.

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:

lendAppName in interface ISrvMonAppFlowCreateMessage

Parameters:

val - The value to set.

setAppNameFrom

public final void setAppNameFrom(long val)

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

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 ISrvMonAppFlowCreateMessage.setAppName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setAppNameFrom in interface ISrvMonAppFlowCreateMessage

getAppNameTo

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

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

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;

Specified by:

getAppNameTo in interface ISrvMonAppFlowCreateMessage

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.

setAppNameFrom

public final void setAppNameFrom(XString val)

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

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 ISrvMonAppFlowCreateMessage.setAppName(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setAppNameFrom in interface ISrvMonAppFlowCreateMessage

getAppNameTo

public final void getAppNameTo(XString val)

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

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 ISrvMonAppFlowCreateMessage.getAppName() bec because it can avoid decoding the value into an String.

Specified by:

getAppNameTo in interface ISrvMonAppFlowCreateMessage

See Also:

ISrvMonAppFlowCreateMessage.getAppName()

getAppNameUnsafe

public final XString getAppNameUnsafe()

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

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.

Specified by:

getAppNameUnsafe in interface ISrvMonAppFlowCreateMessage

Returns:

the field's raw value

See Also:

ISrvMonAppFlowCreateMessage.getAppName()

setAppNameFrom

public final void setAppNameFrom(com.neeve.xbuf.XbufStringField val)

Deprecated.

getAppNameField

public final com.neeve.xbuf.XbufStringField getAppNameField()

Deprecated.

hasAppName

public final boolean hasAppName()

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

Checks for the presence of 'appName'.

Field Description

The name of the app that created the flow.

Specified by:

hasAppName in interface ISrvMonAppFlowCreateMessage

See Also:

ISrvMonAppFlowCreateMessage.getAppName()

clearAppName

public final void clearAppName()

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

Clears the value of 'appName'.

Field Description

The name of the app that created the flow.

Specified by:

clearAppName in interface ISrvMonAppFlowCreateMessage

See Also:

ISrvMonAppFlowCreateMessage.setAppName(String)

getFlowInfoFieldId

public static final int getFlowInfoFieldId()

Deprecated.

setFlowInfo

public final void setFlowInfo(SrvMonAppFlowInfo val)

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

Sets the value of 'flowInfo'.

Field Description

Holds details about the created flow.

Specified by:

setFlowInfo in interface ISrvMonAppFlowCreateMessage

Parameters:

val - The value to set.

lendFlowInfo

public final void lendFlowInfo(SrvMonAppFlowInfo val)

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

'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.

Specified by:

lendFlowInfo in interface ISrvMonAppFlowCreateMessage

Parameters:

val - the value to 'lend' to lend.

getFlowInfo

public final SrvMonAppFlowInfo getFlowInfo()

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

Gets the value of 'flowInfo'.

Field Description

Holds details about the created flow.

Specified by:

getFlowInfo in interface ISrvMonAppFlowCreateMessage

Returns:

Holds details about the created flow.

getFlowInfoTo

public final void getFlowInfoTo(SrvMonAppFlowInfo to)

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

Copies the value of SrvMonAppFlowInfo into the provided value.

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

Specified by:

getFlowInfoTo in interface ISrvMonAppFlowCreateMessage

Parameters:

to - the value to copy into

See Also:

SrvMonAppFlowInfo.copyInto(SrvMonAppFlowInfo)

takeFlowInfo

public final SrvMonAppFlowInfo takeFlowInfo()

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

'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.

Specified by:

takeFlowInfo in interface ISrvMonAppFlowCreateMessage

Returns:

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

hasFlowInfo

public final boolean hasFlowInfo()

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

Checks for the presence of 'flowInfo'.

Field Description

Holds details about the created flow.

Specified by:

hasFlowInfo in interface ISrvMonAppFlowCreateMessage

See Also:

ISrvMonAppFlowCreateMessage.getFlowInfo()

clearFlowInfo

public final void clearFlowInfo()

Deprecated.

Description copied from interface: ISrvMonAppFlowCreateMessage

Clears the value of 'flowInfo'.

Field Description

Holds details about the created flow.

Specified by:

clearFlowInfo in interface ISrvMonAppFlowCreateMessage

See Also:

ISrvMonAppFlowCreateMessage.setFlowInfo(SrvMonAppFlowInfo)

isDirty

public final boolean isDirty()

Deprecated.

createSchema

public static final com.neeve.xbuf.XbufSchema createSchema()

Deprecated.

serializeToByteArray

public final byte[] serializeToByteArray()

Deprecated.

Description copied from interface: MessageView

Serialize a view's backing message to a byte array.

Specified by:

serializeToByteArray in interface MessageView

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

Deprecated.

Description copied from interface: MessageView

Serialize a view's backing message to a byte buffer.

Specified by:

serializeToByteBuffer in interface MessageView

serializeToIOBuffer

public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)

Deprecated.

Description copied from interface: MessageView

Serializes the MessageView to an IOBuffer.

Ownership of the returned IOBuffer is given to the caller which should dispose of it when done.

The buffer backing the IOBuffer should be flipped (ready for read) upon return.

Specified by:

serializeToIOBuffer in interface MessageView

Overrides:

serializeToIOBuffer in class MessageViewImpl

Parameters:

useNative - Whether the returned buffer should be native.

Returns:

The MessageView serialized to an IOBuffer.

serializeToPacket

public final PktPacket serializeToPacket()

Deprecated.

Description copied from interface: MessageView

Serialize a view's backing message to a packet.

Specified by:

serializeToPacket in interface MessageView

deserializeFromByteArray

public final SrvMonAppFlowCreateMessage deserializeFromByteArray(byte[] array)

Deprecated.

Description copied from interface: MessageView

Deserialize a view's backing message from a byte array.

Specified by:

deserializeFromByteArray in interface MessageView

Parameters:

array - The view's backing message serialized as a byte array.

deserializeFromByteBuffer

public final SrvMonAppFlowCreateMessage deserializeFromByteBuffer(ByteBuffer buffer)

Deprecated.

Description copied from interface: MessageView

Deserialize a view's backing message from a byte buffer.

Specified by:

deserializeFromByteBuffer in interface MessageView

Parameters:

buffer - The view's backing message serialized as a byte buffer.

deserializeFromPacket

public final SrvMonAppFlowCreateMessage deserializeFromPacket(PktPacket packet)

Deprecated.

Description copied from interface: MessageView

Deserialize a view's backing message from a packet.

Specified by:

deserializeFromPacket in interface MessageView

Parameters:

packet - The view's backing message serialized as a packet.

sync

public final void sync()

Deprecated.

Description copied from interface: MessageView

Ensure a view's backing message is prepared and ready for transport

Specified by:

sync in interface MessageView

copy

public final SrvMonAppFlowCreateMessage copy()

Deprecated.

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.

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppFlowCreateMessage>

Specified by:

copy in interface ISrvMonAppFlowCreateMessage

Specified by:

copy in interface CopyableMessageView<ISrvMonAppFlowCreateMessage>

Returns:

A copy of this SrvMonAppFlowCreateMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

public final void copyInto(SrvMonAppFlowCreateMessage copy)

Deprecated.

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.

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Specified by:

copyInto in interface ISrvMonAppFlowCreateMessage

Parameters:

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

desync

public final int desync(PktBuffer buffer,
         int pos,
         boolean frameOnly)

Deprecated.

Description copied from interface: com.neeve.xbuf.IXbufDesyncer

Desync fields from a buffer

Specified by:

desync in interface com.neeve.xbuf.IXbufDesyncer

Parameters:

buffer - The buffer to desync from

pos - The position in the container's backing buffer to desync from

frameOnly - Whether to frame the field on the underlying buffer. See XbufField.desync(PktBuffer, int, boolean) for more information

needsSync

public boolean needsSync()

Deprecated.

Description copied from interface: MessageReflector

Check if a view needs to be sync'd for reflection.

Specified by:

needsSync in interface MessageReflector

fieldExists

public final boolean fieldExists(Object message,
                  String name)

Deprecated.

Description copied from interface: MessageReflector

Check if a field of the supplied name exists in a message.

Specified by:

fieldExists in interface MessageReflector

Parameters:

message - The message to check in.

name - The field to check for.

isFieldReflectable

public final boolean isFieldReflectable(Object message,
                         String name)

Deprecated.

Description copied from interface: MessageReflector

Check if a field of the supplied name is reflectable.

Specified by:

isFieldReflectable in interface MessageReflector

Parameters:

message - The message to check in.

name - The field to check for.

Returns:

Returns null if a field of the supplied name is either not present in the message or is of a type that makes it non-reflectable.

getFieldValueAsString

public final String getFieldValueAsString(Object message,
                           String name)

Deprecated.

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

Note that this method is generally less efficient than its variant MessageReflector.getFieldValueAsString(Object, String[]) since this method requires splitting the supplied path name into its dot separated path components. In cases where the caller intends to reuse the same path name often, it is better for the caller to supply it in split form.

Specified by:

getFieldValueAsString in interface MessageReflector

Parameters:

message - The message to introspect.

name - The field whose value is to be retrieved specified as a bean path

Returns:

Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsString

public final String getFieldValueAsString(Object message,
                           String[] pathComponents)

Deprecated.

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

Specified by:

getFieldValueAsString in interface MessageReflector

Parameters:

message - The message to introspect.

pathComponents - The path components to use to access the field.

Returns:

Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsRawString

public final XString getFieldValueAsRawString(Object message,
                               String name)

Deprecated.

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

Note that this method is generally less efficient than its variant MessageReflector.getFieldValueAsString(Object, String[]) since this method requires splitting the supplied path name into its dot separated path components. In cases where the caller intends to reuse the same path name often, it is better for the caller to supply it in split form.

Specified by:

getFieldValueAsRawString in interface MessageReflector

Parameters:

message - The message to introspect.

name - The field whose value is to be retrieved specified as a bean path

Returns:

Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsRawString

public final XString getFieldValueAsRawString(Object message,
                               String[] pathComponents)

Deprecated.

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

Specified by:

getFieldValueAsRawString in interface MessageReflector

Parameters:

message - The message to introspect.

pathComponents - The path components to use to access the field.

Returns:

Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

appendFieldValueTo

public final boolean appendFieldValueTo(Object message,
                         String name,
                         XString target)

Deprecated.

Description copied from class: com.neeve.rog.impl.RogNode

Appends a reflected field value as a string into the given XString.

If this node has a non-null messageReflector as returned by RogNode.getMessageReflector(), then this method will use that reflector to append the value of the field provided by it if the field is reflectable and not null.

Specified by:

appendFieldValueTo in interface MessageReflector

Overrides:

appendFieldValueTo in class com.neeve.rog.impl.RogNode

Parameters:

message - the node on which to reflect (which need not be this object).

name - the bean path to the field on the provided object.

target - The target XString into which to append the result.

Returns:

true if the field was reflectable and had a value which could be appended, false otherwise.

appendFieldValueTo

public final boolean appendFieldValueTo(Object node,
                         String[] pathComponents,
                         XString target)

Deprecated.

Description copied from class: com.neeve.rog.impl.RogNode

Appends a reflected field value as a string into the given XString.

If this node has a non-null messageReflector as returned by RogNode.getMessageReflector(), then this method will use that reflector to append the value of the field provided by it if the field is reflectable and not null.

Specified by:

appendFieldValueTo in interface MessageReflector

Overrides:

appendFieldValueTo in class com.neeve.rog.impl.RogNode

Parameters:

node - the node on which to reflect (which need not be this object).

pathComponents - the bean path to the field on the provided object split by its '.' separated components. .

target - The target XString into which to append the result.

Returns:

true if the field was reflectable and had a value which could be appended, false otherwise.

getContentEncodingType

public final IStoreObject.EncodingType getContentEncodingType()

Deprecated.

Description copied from interface: IStoreObject

Get an object's content data encoding type.

Specified by:

getContentEncodingType in interface IStoreObject

serialize

public final PktPacket serialize()

Deprecated.

Description copied from interface: IStoreObject

Serialize an object's data.

Specified by:

serialize in interface IStoreObject

deserialize

public final SrvMonAppFlowCreateMessage deserialize(PktPacket packet)

Deprecated.

Description copied from interface: IStoreObject

Deserialize an object's data.

Specified by:

deserialize in interface IStoreObject

Parameters:

packet - The object in serialized form.

Returns:

Returns 'this' object for invocation chaining.

setFieldValue

public final IStoreObject setFieldValue(int id,
                         Object val)

Deprecated.

toJsonString

public final String toJsonString(boolean includeMetadata,
                  String metadataObjectName,
                  String payloadObjectName)

Deprecated.

Description copied from interface: IRogJsonizable

Get a full JSON representation of an ROG entity

Specified by:

toJsonString in interface IRogJsonizable

Parameters:

includeMetadata - Specify this parameter for the ROG entity metadata to also be included in the JSON output. If included, the entire ROG entity object is treated as a composite object containing a nested metadata object and a nested data object. The next two parameters metadataObjectName and dataObjectName specify the names of the nested objects as they will appear in the output JSON string.

metadataObjectName - The name of the nested metadata object as it will appear in the output JSON string. A value of null will default to using 'metadata' as the nested object name.

payloadObjectName - The name of the nested data object as it will appear in the output JSON string. A value of null will default to using 'data' as the nested object name.

toJsonString

public final String toJsonString()

Deprecated.

Description copied from interface: IRogJsonizable

Get a JSON representation of an ROG entity

Specified by:

toJsonString in interface IRogJsonizable

toString

public final String toString()

Deprecated.

Description copied from class: com.neeve.rog.impl.RogNode

Return a string representation of an ROG node.

Overrides:

toString in class com.neeve.rog.impl.RogNode