com.neeve.server.mon.cnc
Class SrvMonInvokeCommandRequest

java.lang.Object
  extended by com.neeve.util.UtlListElement
      extended by com.neeve.sma.MessageViewImpl
          extended by com.neeve.rog.impl.RogNode
              extended by com.neeve.server.mon.cnc.SrvMonInvokeCommandRequest
All Implemented Interfaces:
com.neeve.link.ILnkMessage, IStoreObject, IRogCopyableNode<ISrvMonInvokeCommandRequest>, IRogJsonizable, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, ISrvMonInvokeCommandRequest, CopyableMessageView<ISrvMonInvokeCommandRequest>, MapMessageView, MessageReflector, MessageView, UtlReferenceTracker.HasReferenceTracker, com.neeve.xbuf.IXbufDesyncer

@Generated(value="com.neeve.adm.AdmXbufGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(encoding="Xbuf",
              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)")
@AdmFactoryInfo(factoryClass=SrvMonCncFactory.class,
                vfid=36,
                ofid=36,
                typeId=10)
public final class SrvMonInvokeCommandRequest
extends com.neeve.rog.impl.RogNode
implements ISrvMonInvokeCommandRequest, com.neeve.link.ILnkMessage, MessageReflector, com.neeve.xbuf.IXbufDesyncer, IRogJsonizable

Instructs the server to inoke a command.


Nested Class Summary
static class SrvMonInvokeCommandRequest.PacketBody
          The backing packet type for SrvMonInvokeCommandRequest (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
static SrvMonInvokeCommandRequest[] EMPTY_ARRAY
          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
 void addParameters(String val)
          Adds the provided value to the list of 'parameters' values.
 boolean appendFieldValueTo(Object node, String[] pathComponents, XString target)
          Appends a reflected field value as a string into the given XString.
 boolean appendFieldValueTo(Object message, String name, XString target)
          Appends a reflected field value as a string into the given XString.
 void clearCommandName()
          Clears the value of 'commandName' Field Description The name of the command to invoke
 void clearContent()
           
 void clearParameters()
          Clears the value of 'parameters' Field Description The list of options and arguments for the command For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like: --rate 20 --count 1000 true
 void clearTarget()
          Clears the value of 'target' Field Description The target (e.g. app) on which to invoke the command
 void clearXRogType()
           
 SrvMonInvokeCommandRequest copy()
          Creates a copy of this SrvMonInvokeCommandRequest.
 void copyInto(SrvMonInvokeCommandRequest copy)
          Copies the contents of this SrvMonInvokeCommandRequest into the target.
static SrvMonInvokeCommandRequest create()
           
static SrvMonInvokeCommandRequest create(com.eaio.uuid.UUID id)
           
static SrvMonInvokeCommandRequest createFrom(byte[] serializedContainer)
           
static SrvMonInvokeCommandRequest createFrom(ByteBuffer serializedContainer)
           
static SrvMonInvokeCommandRequest createFromJson(String json)
           
static SrvMonInvokeCommandRequest createFromRawJson(String json)
           
static SrvMonInvokeCommandRequest createFromSerializedXbufContainer(byte[] serializedContainer)
           
static SrvMonInvokeCommandRequest createFromSerializedXbufContainer(ByteBuffer serializedContainer)
           
static SrvMonInvokeCommandRequest createFromSerializedXbufContainerPacket(byte[] serializedPacket)
           
static SrvMonInvokeCommandRequest createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
           
static SrvMonInvokeCommandRequest createFromXbufContainerPacket(PktPacket packet)
           
static com.neeve.xbuf.XbufRepeatedStringFieldBuffer createParametersFieldBuffer(int initialBufferLength, boolean isNative)
          Returns a wrapped buffer that can be used for doing an efficient bulk copy from an XIterator returned for this field.
static com.neeve.xbuf.XbufSchema createSchema()
           
 SrvMonInvokeCommandRequest deserialize(PktPacket packet)
          Deserialize an object's data.
 SrvMonInvokeCommandRequest deserializeFromByteArray(byte[] array)
          Deserialize a view's backing message from a byte array.
 SrvMonInvokeCommandRequest deserializeFromByteBuffer(ByteBuffer buffer)
          Deserialize a view's backing message from a byte buffer.
 SrvMonInvokeCommandRequest deserializeFromJson(String json)
          Deserialize a view's backing message from a json string
 SrvMonInvokeCommandRequest deserializeFromPacket(PktPacket packet)
          Deserialize a view's backing message from a packet.
 SrvMonInvokeCommandRequest deserializeFromProtobuf(com.google.protobuf.Message message)
          Deserialize a node's data from a protobuf message.
 SrvMonInvokeCommandRequest deserializeFromRawJson(String json)
           
 int desync(PktBuffer buffer, int pos, boolean frameOnly)
           
 void desyncFieldBitmask()
           
 int dispose()
          Default implementation of MessageView.dispose() This is the default implementation of the dispose method.
 boolean fieldExists(Object message, String name)
          Check if a field of the supplied name exists in a message.
 PktBuffer getBackingBuffer()
           
 String getCommandName()
          Gets the value of 'commandName' Field Description The name of the command to invoke
 com.neeve.xbuf.XbufStringField getCommandNameField()
           
static int getCommandNameFieldId()
          Get the field id for 'commandName' This method can be used to set field interests.
<T extends XString>
T
getCommandNameTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getCommandNameTo(XString val)
          Copies the value of 'commandName' into the provided XString.
 XString getCommandNameUnsafe()
          Gets the raw value of 'commandName'.
 IStoreObject.EncodingType getContentEncodingType()
          Get an object's content data encoding type.
static com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
           
 XString getFieldValueAsRawString(Object message, String name)
          Get the value of a reflectable field in a message as a string.
 XString getFieldValueAsRawString(Object message, String[] pathComponents)
          Get the value of a reflectable field in a message as a string.
 String getFieldValueAsString(Object message, String name)
          Get the value of a reflectable field in a message as a string.
 String getFieldValueAsString(Object message, String[] pathComponents)
          Get the value of a reflectable field in a message as a string.
 PktPacket getPacket()
           
 String[] getParameters()
          Gets the value of 'parameters' If the field is not set this method will return null.
 String[] getParametersEmptyIfNull()
          Gets the value of 'parameters' or an empty array if the value is null or not set.
static int getParametersFieldId()
          Get the field id for 'parameters' This method can be used to set field interests.
 XStringIterator getParametersIterator()
          Gets the value of 'parameters' as iterator of values.
 String getTarget()
          Gets the value of 'target' Field Description The target (e.g. app) on which to invoke the command
 com.neeve.xbuf.XbufStringField getTargetField()
           
static int getTargetFieldId()
          Get the field id for 'target' This method can be used to set field interests.
<T extends XString>
T
getTargetTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getTargetTo(XString val)
          Copies the value of 'target' into the provided XString.
 XString getTargetUnsafe()
          Gets the raw value of 'target'.
 short getXRogType()
           
 com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
           
static int getXRogTypeFieldId()
          Get the field id for 'xRogType' This method can be used to set field interests.
 boolean hasCommandName()
          Checks for the presence of 'commandName' Field Description The name of the command to invoke
 boolean hasTarget()
          Checks for the presence of 'target' Field Description The target (e.g. app) on which to invoke the command
 boolean hasXRogType()
           
 boolean isDirty()
           
 boolean isFieldReflectable(Object message, String name)
          Check if a field of the supplied name is reflectable.
 void lendCommandName(XString val)
          Sets the value of 'commandName' Field Description The name of the command to invoke
 void lendTarget(XString val)
          Sets the value of 'target' Field Description The target (e.g. app) on which to invoke the command
 boolean needsSync()
          Check if a view needs to be sync'd for reflection.
static void optimizeFor(int val)
           
 PktPacket serialize()
          Serialize an object's data.
 byte[] serializeToByteArray()
          Serialize a view's backing message to a byte array.
 ByteBuffer serializeToByteBuffer()
          Serialize a view's backing message to a byte buffer.
 com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
          Serializes the MessageView to an IOBuffer.
 String serializeToJson()
          Serialize a view's backing message to JSON.
 PktPacket serializeToPacket()
          Serialize a view's backing message to a packet.
 com.google.protobuf.Message serializeToProtobuf()
          Serialize a node's data to a proto message.
 String serializeToRawJson()
           
 void setAsReadOnly()
          Set whether a node is read only Note: This read-only flag only applies to data, not metadata
 void setCommandName(String val)
          Sets the value of 'commandName' Field Description The name of the command to invoke
 void setCommandNameFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setCommandNameFrom(com.neeve.xbuf.XbufStringField val)
           
 void setCommandNameFrom(XString val)
          Copies the provided XString value into this object's 'commandName'.
static void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
           
static void setFieldInterest(List<Integer> fieldIds)
           
 IStoreObject setFieldValue(int id, Object val)
          Set the value of an object field.
 void setParameters(String[] val)
          Sets the value of 'parameters' Field Description The list of options and arguments for the command For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like: --rate 20 --count 1000 true
 void setParametersFrom(XIterator<String> val)
          Sets the value of 'parameters' using the values from the provided iterator.
 void setTarget(String val)
          Sets the value of 'target' Field Description The target (e.g. app) on which to invoke the command
 void setTargetFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setTargetFrom(com.neeve.xbuf.XbufStringField val)
           
 void setTargetFrom(XString val)
          Copies the provided XString value into this object's 'target'.
 void setXRogType(short val)
           
 void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
           
 void sync()
          Ensure a view's backing message is prepared and ready for transport
 void syncFieldBitmask()
           
 String toJsonString()
          Get a JSON representation of an ROG entity
 String toJsonString(boolean includeMetadata, String metadataObjectName, String payloadObjectName)
          Get a full JSON representation of an ROG entity
 String toString()
          Return a string representation of this object
 void undispose(com.eaio.uuid.UUID id)
           
 
Methods inherited from class com.neeve.rog.impl.RogNode
accept, deserializeMetadata, deserializeMetadata, dump, ensureId, getAppSendBeginTs, getAppSendDoneTs, getAttachment, getBinding, getCheckpointVersion, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getFields, getGraphId, getId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsPriority, getIsReadOnly, getIsReplayedMessage, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageReflector, getMessageSender, getMessageSequenceNumber, 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, getTransactionId, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, getTypeFromJson, getValidationErrors, isPossibleDuplicate, isValid, metadataToJsonString, metadataToJsonString, metadataToString, serializeMetadata, setAppSendBeginTs, setAppSendDoneTs, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setBinding, setCheckpointVersion, setCreateTs, setEnqueueTsMicros, setId, setInMsgsInTransaction, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageSender, setMessageSequenceNumber, 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, 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, ensureId, getBinding, getCheckpointVersion, getId, getOfid, getOwnershipCount, getSerializedMetadataLength, getStableTransactionId, getTransactionId, serializeMetadata, setBinding, setCheckpointVersion, 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
 

Field Detail

EMPTY_ARRAY

public static final SrvMonInvokeCommandRequest[] EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Method Detail

create

public static SrvMonInvokeCommandRequest create()

create

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

createFromXbufContainerPacket

public static SrvMonInvokeCommandRequest createFromXbufContainerPacket(PktPacket packet)

createFromSerializedXbufContainerPacket

public static SrvMonInvokeCommandRequest createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)

createFromSerializedXbufContainerPacket

public static SrvMonInvokeCommandRequest createFromSerializedXbufContainerPacket(byte[] serializedPacket)

createFromSerializedXbufContainer

public static SrvMonInvokeCommandRequest createFromSerializedXbufContainer(ByteBuffer serializedContainer)

createFromSerializedXbufContainer

public static SrvMonInvokeCommandRequest createFromSerializedXbufContainer(byte[] serializedContainer)

createFromRawJson

public static SrvMonInvokeCommandRequest createFromRawJson(String json)

createFromJson

public static SrvMonInvokeCommandRequest createFromJson(String json)

createFrom

public static SrvMonInvokeCommandRequest createFrom(ByteBuffer serializedContainer)

createFrom

public static SrvMonInvokeCommandRequest createFrom(byte[] serializedContainer)

setDesyncPolicy

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

getDesyncPolicy

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

setFieldInterest

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

clearContent

public final void clearContent()

syncFieldBitmask

public final void syncFieldBitmask()

desyncFieldBitmask

public final void desyncFieldBitmask()

getBackingBuffer

public final PktBuffer getBackingBuffer()

optimizeFor

public static final void optimizeFor(int val)

getPacket

public final PktPacket getPacket()
Specified by:
getPacket in interface com.neeve.link.ILnkMessage

serializeToProtobuf

public final com.google.protobuf.Message serializeToProtobuf()
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()

serializeToJson

public final String serializeToJson()
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 SrvMonInvokeCommandRequest deserializeFromProtobuf(com.google.protobuf.Message message)
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 SrvMonInvokeCommandRequest deserializeFromRawJson(String json)

deserializeFromJson

public final SrvMonInvokeCommandRequest deserializeFromJson(String json)
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()
Description copied from interface: IRogNode
Set whether a node is read only

Note: This read-only flag only applies to data, not metadata

Specified by:
setAsReadOnly in interface IRogNode
Overrides:
setAsReadOnly in class com.neeve.rog.impl.RogNode

dispose

public int dispose()
Description copied from class: MessageViewImpl
Default implementation of MessageView.dispose()

This is the default implementation of the dispose method. The implementation just decrements the ownership count. Implementations that implement view object pooling or other such functionality should override this method but invoke this method to decrement the object reference count.

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)
Overrides:
undispose in class com.neeve.rog.impl.RogNode

getXRogTypeFieldId

public static final int getXRogTypeFieldId()
Get the field id for 'xRogType'

This method can be used to set field interests.

See Also:
getXRogType()

setXRogType

public final void setXRogType(short val)

getXRogType

public final short getXRogType()

setXRogTypeFrom

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

getXRogTypeField

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

hasXRogType

public final boolean hasXRogType()

clearXRogType

public final void clearXRogType()

getTargetFieldId

public static final int getTargetFieldId()
Get the field id for 'target'

This method can be used to set field interests.

See Also:
getTarget()

setTarget

public final void setTarget(String val)
Description copied from interface: ISrvMonInvokeCommandRequest
Sets the value of 'target'

Field Description

The target (e.g. app) on which to invoke the command

Specified by:
setTarget in interface ISrvMonInvokeCommandRequest
Parameters:
val - The value to set.

getTarget

public final String getTarget()
Description copied from interface: ISrvMonInvokeCommandRequest
Gets the value of 'target'

Field Description

The target (e.g. app) on which to invoke the command

Specified by:
getTarget in interface ISrvMonInvokeCommandRequest
Returns:
The target (e.g. app) on which to invoke the command

lendTarget

public final void lendTarget(XString val)
Description copied from interface: ISrvMonInvokeCommandRequest
Sets the value of 'target'

Field Description

The target (e.g. app) on which to invoke the command

Specified by:
lendTarget in interface ISrvMonInvokeCommandRequest
Parameters:
val - The value to set.

setTargetFrom

public final void setTargetFrom(long val)
Description copied from interface: ISrvMonInvokeCommandRequest
Sets the value of this String field to the given numeric value.

Field Description

The target (e.g. app) on which to invoke the command

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

Specified by:
setTargetFrom in interface ISrvMonInvokeCommandRequest

getTargetTo

public final <T extends XString> T getTargetTo(XString.Factory<T> factory)
Description copied from interface: ISrvMonInvokeCommandRequest
Copies the value of this String field into a new XString from the given factory.

Field Description

The target (e.g. app) on which to invoke the command

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:
getTargetTo in interface ISrvMonInvokeCommandRequest
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.

setTargetFrom

public final void setTargetFrom(XString val)
Description copied from interface: ISrvMonInvokeCommandRequest
Copies the provided XString value into this object's 'target'.

Field Description

The target (e.g. app) on which to invoke the command

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

Specified by:
setTargetFrom in interface ISrvMonInvokeCommandRequest

getTargetTo

public final void getTargetTo(XString val)
Description copied from interface: ISrvMonInvokeCommandRequest
Copies the value of 'target' into the provided XString.

Field Description

The target (e.g. app) on which to invoke the command

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

Specified by:
getTargetTo in interface ISrvMonInvokeCommandRequest
See Also:
ISrvMonInvokeCommandRequest.getTarget()

getTargetUnsafe

public final XString getTargetUnsafe()
Description copied from interface: ISrvMonInvokeCommandRequest
Gets the raw value of 'target'.

Field Description

The target (e.g. app) on which to invoke the command

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:
getTargetUnsafe in interface ISrvMonInvokeCommandRequest
Returns:
the field's raw value
See Also:
ISrvMonInvokeCommandRequest.getTarget()

setTargetFrom

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

getTargetField

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

hasTarget

public final boolean hasTarget()
Description copied from interface: ISrvMonInvokeCommandRequest
Checks for the presence of 'target'

Field Description

The target (e.g. app) on which to invoke the command

Specified by:
hasTarget in interface ISrvMonInvokeCommandRequest
See Also:
ISrvMonInvokeCommandRequest.getTarget()

clearTarget

public final void clearTarget()
Description copied from interface: ISrvMonInvokeCommandRequest
Clears the value of 'target'

Field Description

The target (e.g. app) on which to invoke the command

Specified by:
clearTarget in interface ISrvMonInvokeCommandRequest
See Also:
ISrvMonInvokeCommandRequest.setTarget(String)

getCommandNameFieldId

public static final int getCommandNameFieldId()
Get the field id for 'commandName'

This method can be used to set field interests.

See Also:
getCommandName()

setCommandName

public final void setCommandName(String val)
Description copied from interface: ISrvMonInvokeCommandRequest
Sets the value of 'commandName'

Field Description

The name of the command to invoke

Specified by:
setCommandName in interface ISrvMonInvokeCommandRequest
Parameters:
val - The value to set.

getCommandName

public final String getCommandName()
Description copied from interface: ISrvMonInvokeCommandRequest
Gets the value of 'commandName'

Field Description

The name of the command to invoke

Specified by:
getCommandName in interface ISrvMonInvokeCommandRequest
Returns:
The name of the command to invoke

lendCommandName

public final void lendCommandName(XString val)
Description copied from interface: ISrvMonInvokeCommandRequest
Sets the value of 'commandName'

Field Description

The name of the command to invoke

Specified by:
lendCommandName in interface ISrvMonInvokeCommandRequest
Parameters:
val - The value to set.

setCommandNameFrom

public final void setCommandNameFrom(long val)
Description copied from interface: ISrvMonInvokeCommandRequest
Sets the value of this String field to the given numeric value.

Field Description

The name of the command to invoke

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

Specified by:
setCommandNameFrom in interface ISrvMonInvokeCommandRequest

getCommandNameTo

public final <T extends XString> T getCommandNameTo(XString.Factory<T> factory)
Description copied from interface: ISrvMonInvokeCommandRequest
Copies the value of this String field into a new XString from the given factory.

Field Description

The name of the command to invoke

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:
getCommandNameTo in interface ISrvMonInvokeCommandRequest
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.

setCommandNameFrom

public final void setCommandNameFrom(XString val)
Description copied from interface: ISrvMonInvokeCommandRequest
Copies the provided XString value into this object's 'commandName'.

Field Description

The name of the command to invoke

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

Specified by:
setCommandNameFrom in interface ISrvMonInvokeCommandRequest

getCommandNameTo

public final void getCommandNameTo(XString val)
Description copied from interface: ISrvMonInvokeCommandRequest
Copies the value of 'commandName' into the provided XString.

Field Description

The name of the command to invoke

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

Specified by:
getCommandNameTo in interface ISrvMonInvokeCommandRequest
See Also:
ISrvMonInvokeCommandRequest.getCommandName()

getCommandNameUnsafe

public final XString getCommandNameUnsafe()
Description copied from interface: ISrvMonInvokeCommandRequest
Gets the raw value of 'commandName'.

Field Description

The name of the command to invoke

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:
getCommandNameUnsafe in interface ISrvMonInvokeCommandRequest
Returns:
the field's raw value
See Also:
ISrvMonInvokeCommandRequest.getCommandName()

setCommandNameFrom

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

getCommandNameField

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

hasCommandName

public final boolean hasCommandName()
Description copied from interface: ISrvMonInvokeCommandRequest
Checks for the presence of 'commandName'

Field Description

The name of the command to invoke

Specified by:
hasCommandName in interface ISrvMonInvokeCommandRequest
See Also:
ISrvMonInvokeCommandRequest.getCommandName()

clearCommandName

public final void clearCommandName()
Description copied from interface: ISrvMonInvokeCommandRequest
Clears the value of 'commandName'

Field Description

The name of the command to invoke

Specified by:
clearCommandName in interface ISrvMonInvokeCommandRequest
See Also:
ISrvMonInvokeCommandRequest.setCommandName(String)

getParametersFieldId

public static final int getParametersFieldId()
Get the field id for 'parameters'

This method can be used to set field interests.

See Also:
getParameters()

createParametersFieldBuffer

public static final com.neeve.xbuf.XbufRepeatedStringFieldBuffer createParametersFieldBuffer(int initialBufferLength,
                                                                                             boolean isNative)
Returns a wrapped buffer that can be used for doing an efficient bulk copy from an XIterator returned for this field.

For example the following would result in a bulk transfer from this message

 XbufRepeatedStringFieldBuffer preallocated = SrvMonInvokeCommandRequest.createParametersFieldBuffer(1024, true);
 // The following would then result in a buffer copy without any iteration:
 preallocated.setValue(inboundMessage.getParametersIterator());
 // The preallocated bulk copied values can then be transfered to an outbound message:
 outboundMessage.setParameters.setValueFrom(preallocated);
 

Bulk transfer from the backing buffer may only possible between two fields with the same id (protobuf tag) because the bulk transfered bytes are in protobuf wire format which for most repeated fields encode the field's tag for each element.

Parameters:
initialBufferLength - the initial size of the underlying backing buffer.
isNative - Whether the backing buffer should be a native or heap buffer.

setParameters

public final void setParameters(String[] val)
Description copied from interface: ISrvMonInvokeCommandRequest
Sets the value of 'parameters'

Field Description

The list of options and arguments for the command

For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:

Specified by:
setParameters in interface ISrvMonInvokeCommandRequest
Parameters:
val - The value to set.

setParametersFrom

public final void setParametersFrom(XIterator<String> val)
Description copied from interface: ISrvMonInvokeCommandRequest
Sets the value of 'parameters' using the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'parameters' accessor can copy the values without iteration.

Field Description

The list of options and arguments for the command

For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:

NOTE:
Passing a null or empty iterator has the same affect as calling ISrvMonInvokeCommandRequest.setParameters(String[]) with a value of null.

Specified by:
setParametersFrom in interface ISrvMonInvokeCommandRequest
Parameters:
val - the values to set.

addParameters

public final void addParameters(String val)
Description copied from interface: ISrvMonInvokeCommandRequest
Adds the provided value to the list of 'parameters' values.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'parameters' accessor can copy the values without iteration.

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

The list of options and arguments for the command

For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:

Specified by:
addParameters in interface ISrvMonInvokeCommandRequest
Parameters:
val - the value to add.

getParameters

public final String[] getParameters()
Description copied from interface: ISrvMonInvokeCommandRequest
Gets the value of 'parameters'

If the field is not set this method will return null.

Field Description

The list of options and arguments for the command

For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:

Specified by:
getParameters in interface ISrvMonInvokeCommandRequest
Returns:
The list of options and arguments for the command If the field is not set this method will return null.

getParametersEmptyIfNull

public final String[] getParametersEmptyIfNull()
Description copied from interface: ISrvMonInvokeCommandRequest
Gets the value of 'parameters' or an empty array if the value is null or not set.

Field Description

The list of options and arguments for the command

For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:

Specified by:
getParametersEmptyIfNull in interface ISrvMonInvokeCommandRequest
Returns:
The list of options and arguments for the command or an empty array if null if not set.
See Also:
ISrvMonInvokeCommandRequest.getParameters()

getParametersIterator

public final XStringIterator getParametersIterator()
Description copied from interface: ISrvMonInvokeCommandRequest
Gets the value of 'parameters' as iterator of values.

This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(com.neeve.lang.XStringIterator) method can perform a direct copy of the underlying values without iteration.

Field Description

The list of options and arguments for the command

For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:

Specified by:
getParametersIterator in interface ISrvMonInvokeCommandRequest
Returns:
An XStringIterator containing this field values.

clearParameters

public final void clearParameters()
Description copied from interface: ISrvMonInvokeCommandRequest
Clears the value of 'parameters'

Field Description

The list of options and arguments for the command

For example when invoking MyApp doSend --rate 20 --count 1000 true the parameters would look like:

Specified by:
clearParameters in interface ISrvMonInvokeCommandRequest
See Also:
ISrvMonInvokeCommandRequest.setParameters(String[])

isDirty

public final boolean isDirty()

createSchema

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

serializeToByteArray

public final byte[] serializeToByteArray()
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()
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)
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()
Description copied from interface: MessageView
Serialize a view's backing message to a packet.

Specified by:
serializeToPacket in interface MessageView

deserializeFromByteArray

public final SrvMonInvokeCommandRequest deserializeFromByteArray(byte[] array)
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 SrvMonInvokeCommandRequest deserializeFromByteBuffer(ByteBuffer buffer)
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 SrvMonInvokeCommandRequest deserializeFromPacket(PktPacket packet)
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()
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 SrvMonInvokeCommandRequest copy()
Creates a copy of this SrvMonInvokeCommandRequest.

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

The returned copy will be writeable even if this SrvMonInvokeCommandRequest 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<ISrvMonInvokeCommandRequest>
Specified by:
copy in interface ISrvMonInvokeCommandRequest
Specified by:
copy in interface CopyableMessageView<ISrvMonInvokeCommandRequest>
Returns:
A copy of this SrvMonInvokeCommandRequest.
See Also:
IRogCopyableNode, CopyableMessageView

copyInto

public final void copyInto(SrvMonInvokeCommandRequest copy)
Copies the contents of this SrvMonInvokeCommandRequest 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 SrvMonInvokeCommandRequest's embedded entity fields.

The returned copy will be writeable even if this SrvMonInvokeCommandRequest 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 ISrvMonInvokeCommandRequest
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)
Specified by:
desync in interface com.neeve.xbuf.IXbufDesyncer

needsSync

public boolean needsSync()
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)
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)
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)
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)
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)
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)
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)
Description copied from interface: MessageReflector
Appends a reflected field value as a string into the given XString.

If the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.

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.
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)
Description copied from interface: MessageReflector
Appends a reflected field value as a string into the given XString.

If the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.

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()
Description copied from interface: IStoreObject
Get an object's content data encoding type.

Specified by:
getContentEncodingType in interface IStoreObject

serialize

public final PktPacket serialize()
Description copied from interface: IStoreObject
Serialize an object's data.

Specified by:
serialize in interface IStoreObject

deserialize

public final SrvMonInvokeCommandRequest deserialize(PktPacket packet)
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)
Description copied from interface: IStoreObject
Set the value of an object field.

Specified by:
setFieldValue in interface IStoreObject
Overrides:
setFieldValue in class com.neeve.rog.impl.RogNode
Returns:
Returns this object for invocation chaining.

This method is invoked during the rollback process to restore field values.


toJsonString

public final String toJsonString(boolean includeMetadata,
                                 String metadataObjectName,
                                 String payloadObjectName)
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()
Description copied from interface: IRogJsonizable
Get a JSON representation of an ROG entity

Specified by:
toJsonString in interface IRogJsonizable

toString

public final String toString()
Description copied from class: MessageViewImpl
Return a string representation of this object

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


Copyright © 2016 Neeve Research, LLC. All Rights Reserved.