com.neeve.server.mon.cnc

Interface ISrvMonInvokeCommandResponse

All Superinterfaces:

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

All Known Implementing Classes:

SrvMonInvokeCommandResponse

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

Response to a command invocation.

ADM Details

ADM Type	Message
Factory	SrvMonCncFactory

ADM Field Summary

Field	Type	Id	Description
adminClientId	String	201	The admin client targeted in the command exchange.
booleanReturnValue	Boolean	2	The value for a BOOLEAN return type.
byteReturnValue	Byte	3	The value for a BYTE return type.
charReturnValue	Char	4	The value for a CHAR return type.
correlationId	Long	202	The request correlation ID.
dateReturnValue	Date	11	The value for a DATE return type.
doubleReturnValue	Double	9	The value for a DOUBLE return type.
errorMessage	String	12	If the command did not complete successfully this field holds an error message.
floatReturnValue	Float	8	The value for a FLOAT return type.
intReturnValue	Integer	6	The value for a INT return type.
longReturnValue	Long	7	The value for a LONG return type.
returnType	SrvMonReturnType	1	The response type. This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.
shortReturnValue	Short	5	The value for a SHORT return type.
stackTrace	String	13	A stack trace that can accompany an error message if there was an exception.
stringReturnValue	String	10	The value for a STRING return type.
xvmHeader	SrvMonXvmHeader	6004	Details about the message source.
xvmName	String	203	The name of the XVM targeted in the command exchange.

Nested Class Summary

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

IRogNode.PoolingListener

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

IStoreObject.EncodingType

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAdminClientId() Clears the value of 'adminClientId'.
void	clearBooleanReturnValue() Clears the value of 'booleanReturnValue'.
void	clearByteReturnValue() Clears the value of 'byteReturnValue'.
void	clearCharReturnValue() Clears the value of 'charReturnValue'.
void	clearCorrelationId() Clears the value of 'correlationId'.
void	clearDateReturnValue() Clears the value of 'dateReturnValue'.
void	clearDoubleReturnValue() Clears the value of 'doubleReturnValue'.
void	clearErrorMessage() Clears the value of 'errorMessage'.
void	clearFloatReturnValue() Clears the value of 'floatReturnValue'.
void	clearIntReturnValue() Clears the value of 'intReturnValue'.
void	clearLongReturnValue() Clears the value of 'longReturnValue'.
void	clearReturnType() Clears the value of 'returnType'.
void	clearShortReturnValue() Clears the value of 'shortReturnValue'.
void	clearStackTrace() Clears the value of 'stackTrace'.
void	clearStringReturnValue() Clears the value of 'stringReturnValue'.
void	clearXvmHeader() Clears the value of 'xvmHeader'.
void	clearXvmName() Clears the value of 'xvmName'.
SrvMonInvokeCommandResponse	copy() Creates a copy of this SrvMonInvokeCommandResponse.
void	copyInto(SrvMonInvokeCommandResponse target) Copies the contents of this SrvMonInvokeCommandResponse into the target.
String	getAdminClientId() Gets the value of 'adminClientId'.
<T extends XString> T	getAdminClientIdTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getAdminClientIdTo(XString val) Copies the value of 'adminClientId' into the provided XString.
XString	getAdminClientIdUnsafe() Gets the raw value of 'adminClientId'.
boolean	getBooleanReturnValue() Gets the value of 'booleanReturnValue'.
byte	getByteReturnValue() Gets the value of 'byteReturnValue'.
char	getCharReturnValue() Gets the value of 'charReturnValue'.
long	getCorrelationId() Gets the value of 'correlationId'.
Date	getDateReturnValue() Gets the value of 'dateReturnValue'.
long	getDateReturnValueAsTimestamp() Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
double	getDoubleReturnValue() Gets the value of 'doubleReturnValue'.
String	getErrorMessage() Gets the value of 'errorMessage'.
<T extends XString> T	getErrorMessageTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getErrorMessageTo(XString val) Copies the value of 'errorMessage' into the provided XString.
XString	getErrorMessageUnsafe() Gets the raw value of 'errorMessage'.
float	getFloatReturnValue() Gets the value of 'floatReturnValue'.
int	getIntReturnValue() Gets the value of 'intReturnValue'.
long	getLongReturnValue() Gets the value of 'longReturnValue'.
SrvMonReturnType	getReturnType() Gets the value of 'returnType'.
short	getShortReturnValue() Gets the value of 'shortReturnValue'.
String	getStackTrace() Gets the value of 'stackTrace'.
<T extends XString> T	getStackTraceTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getStackTraceTo(XString val) Copies the value of 'stackTrace' into the provided XString.
XString	getStackTraceUnsafe() Gets the raw value of 'stackTrace'.
String	getStringReturnValue() Gets the value of 'stringReturnValue'.
<T extends XString> T	getStringReturnValueTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getStringReturnValueTo(XString val) Copies the value of 'stringReturnValue' into the provided XString.
XString	getStringReturnValueUnsafe() Gets the raw value of 'stringReturnValue'.
com.neeve.server.mon.common.SrvMonXvmHeader	getXvmHeader() Gets the value of 'xvmHeader'.
void	getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val) Copies the value of SrvMonXvmHeader into the provided value.
String	getXvmName() Gets the value of 'xvmName'.
<T extends XString> T	getXvmNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getXvmNameTo(XString val) Copies the value of 'xvmName' into the provided XString.
XString	getXvmNameUnsafe() Gets the raw value of 'xvmName'.
boolean	hasAdminClientId() Checks for the presence of 'adminClientId'.
boolean	hasBooleanReturnValue() Checks for the presence of 'booleanReturnValue'.
boolean	hasByteReturnValue() Checks for the presence of 'byteReturnValue'.
boolean	hasCharReturnValue() Checks for the presence of 'charReturnValue'.
boolean	hasCorrelationId() Checks for the presence of 'correlationId'.
boolean	hasDateReturnValue() Checks for the presence of 'dateReturnValue'.
boolean	hasDoubleReturnValue() Checks for the presence of 'doubleReturnValue'.
boolean	hasErrorMessage() Checks for the presence of 'errorMessage'.
boolean	hasFloatReturnValue() Checks for the presence of 'floatReturnValue'.
boolean	hasIntReturnValue() Checks for the presence of 'intReturnValue'.
boolean	hasLongReturnValue() Checks for the presence of 'longReturnValue'.
boolean	hasReturnType() Checks for the presence of 'returnType'.
boolean	hasShortReturnValue() Checks for the presence of 'shortReturnValue'.
boolean	hasStackTrace() Checks for the presence of 'stackTrace'.
boolean	hasStringReturnValue() Checks for the presence of 'stringReturnValue'.
boolean	hasXvmHeader() Checks for the presence of 'xvmHeader'.
boolean	hasXvmName() Checks for the presence of 'xvmName'.
void	lendAdminClientId(XString val) Lends the value of 'adminClientId' to this object.
void	lendErrorMessage(XString val) Lends the value of 'errorMessage' to this object.
void	lendStackTrace(XString val) Lends the value of 'stackTrace' to this object.
void	lendStringReturnValue(XString val) Lends the value of 'stringReturnValue' to this object.
void	lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val) 'Lends' a reference of the SrvMonXvmHeader to the message for this field.
void	lendXvmName(XString val) Lends the value of 'xvmName' to this object.
void	setAdminClientId(String val) Sets the value of 'adminClientId'.
void	setAdminClientIdFrom(long val) Sets the value of this String field to the given numeric value.
void	setAdminClientIdFrom(XString val) Copies the provided XString value into this object's 'adminClientId'.
void	setBooleanReturnValue(boolean val) Sets the value of 'booleanReturnValue'.
void	setByteReturnValue(byte val) Sets the value of 'byteReturnValue'.
void	setCharReturnValue(char val) Sets the value of 'charReturnValue'.
void	setCorrelationId(long val) Sets the value of 'correlationId'.
void	setDateReturnValue(Date val) Sets the value of 'dateReturnValue'.
void	setDateReturnValueAsTimestamp(long val) Sets the date value as a timestamp.
void	setDoubleReturnValue(double val) Sets the value of 'doubleReturnValue'.
void	setErrorMessage(String val) Sets the value of 'errorMessage'.
void	setErrorMessageFrom(long val) Sets the value of this String field to the given numeric value.
void	setErrorMessageFrom(XString val) Copies the provided XString value into this object's 'errorMessage'.
void	setFloatReturnValue(float val) Sets the value of 'floatReturnValue'.
void	setIntReturnValue(int val) Sets the value of 'intReturnValue'.
void	setLongReturnValue(long val) Sets the value of 'longReturnValue'.
void	setReturnType(SrvMonReturnType val) Sets the value of 'returnType'.
void	setShortReturnValue(short val) Sets the value of 'shortReturnValue'.
void	setStackTrace(String val) Sets the value of 'stackTrace'.
void	setStackTraceFrom(long val) Sets the value of this String field to the given numeric value.
void	setStackTraceFrom(XString val) Copies the provided XString value into this object's 'stackTrace'.
void	setStringReturnValue(String val) Sets the value of 'stringReturnValue'.
void	setStringReturnValueFrom(long val) Sets the value of this String field to the given numeric value.
void	setStringReturnValueFrom(XString val) Copies the provided XString value into this object's 'stringReturnValue'.
void	setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val) Sets the value of 'xvmHeader'.
void	setXvmName(String val) Sets the value of 'xvmName'.
void	setXvmNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setXvmNameFrom(XString val) Copies the provided XString value into this object's 'xvmName'.
com.neeve.server.mon.common.SrvMonXvmHeader	takeXvmHeader() 'Takes' a reference to the xvmHeader field from the message.

Methods inherited from interface com.neeve.rog.IRogNode

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

Methods inherited from interface com.neeve.ods.IStoreObject

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

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata

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

Methods inherited from interface com.neeve.sma.MapMessageView

getMessageReflector

Methods inherited from interface com.neeve.rog.IRogMetadata

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

Method Detail

setCorrelationId

void setCorrelationId(long val)

Sets the value of 'correlationId'.

Field Description

The request correlation ID.

Specified by:

setCorrelationId in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

getCorrelationId

long getCorrelationId()

Gets the value of 'correlationId'.

Field Description

The request correlation ID.

Specified by:

getCorrelationId in interface ISrvMonXvmResponse

Returns:

The request correlation ID

clearCorrelationId

void clearCorrelationId()

Clears the value of 'correlationId'.

Field Description

The request correlation ID.

Specified by:

clearCorrelationId in interface ISrvMonXvmResponse

See Also:

setCorrelationId(long)

hasCorrelationId

boolean hasCorrelationId()

Checks for the presence of 'correlationId'.

Field Description

The request correlation ID.

Specified by:

hasCorrelationId in interface ISrvMonXvmResponse

See Also:

getCorrelationId()

setReturnType

void setReturnType(SrvMonReturnType val)

Sets the value of 'returnType'.

Field Description

The response type.

This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.

Parameters:

val - The value to set.

getReturnType

SrvMonReturnType getReturnType()

Gets the value of 'returnType'.

Field Description

The response type.

This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.

Returns:

The response type.

clearReturnType

void clearReturnType()

Clears the value of 'returnType'.

Field Description

The response type.

This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.

See Also:

setReturnType(SrvMonReturnType)

hasReturnType

boolean hasReturnType()

Checks for the presence of 'returnType'.

Field Description

The response type.

This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.

See Also:

getReturnType()

setBooleanReturnValue

void setBooleanReturnValue(boolean val)

Sets the value of 'booleanReturnValue'.

Field Description

The value for a BOOLEAN return type.

Parameters:

val - The value to set.

getBooleanReturnValue

boolean getBooleanReturnValue()

Gets the value of 'booleanReturnValue'.

Field Description

The value for a BOOLEAN return type.

Returns:

The value for a BOOLEAN return type.

clearBooleanReturnValue

void clearBooleanReturnValue()

Clears the value of 'booleanReturnValue'.

Field Description

The value for a BOOLEAN return type.

See Also:

setBooleanReturnValue(boolean)

hasBooleanReturnValue

boolean hasBooleanReturnValue()

Checks for the presence of 'booleanReturnValue'.

Field Description

The value for a BOOLEAN return type.

See Also:

getBooleanReturnValue()

setByteReturnValue

void setByteReturnValue(byte val)

Sets the value of 'byteReturnValue'.

Field Description

The value for a BYTE return type.

Parameters:

val - The value to set.

getByteReturnValue

byte getByteReturnValue()

Gets the value of 'byteReturnValue'.

Field Description

The value for a BYTE return type.

Returns:

The value for a BYTE return type.

clearByteReturnValue

void clearByteReturnValue()

Clears the value of 'byteReturnValue'.

Field Description

The value for a BYTE return type.

See Also:

setByteReturnValue(byte)

hasByteReturnValue

boolean hasByteReturnValue()

Checks for the presence of 'byteReturnValue'.

Field Description

The value for a BYTE return type.

See Also:

getByteReturnValue()

setCharReturnValue

void setCharReturnValue(char val)

Sets the value of 'charReturnValue'.

Field Description

The value for a CHAR return type.

Parameters:

val - The value to set.

getCharReturnValue

char getCharReturnValue()

Gets the value of 'charReturnValue'.

Field Description

The value for a CHAR return type.

Returns:

The value for a CHAR return type.

clearCharReturnValue

void clearCharReturnValue()

Clears the value of 'charReturnValue'.

Field Description

The value for a CHAR return type.

See Also:

setCharReturnValue(char)

hasCharReturnValue

boolean hasCharReturnValue()

Checks for the presence of 'charReturnValue'.

Field Description

The value for a CHAR return type.

See Also:

getCharReturnValue()

setShortReturnValue

void setShortReturnValue(short val)

Sets the value of 'shortReturnValue'.

Field Description

The value for a SHORT return type.

Parameters:

val - The value to set.

getShortReturnValue

short getShortReturnValue()

Gets the value of 'shortReturnValue'.

Field Description

The value for a SHORT return type.

Returns:

The value for a SHORT return type.

clearShortReturnValue

void clearShortReturnValue()

Clears the value of 'shortReturnValue'.

Field Description

The value for a SHORT return type.

See Also:

setShortReturnValue(short)

hasShortReturnValue

boolean hasShortReturnValue()

Checks for the presence of 'shortReturnValue'.

Field Description

The value for a SHORT return type.

See Also:

getShortReturnValue()

setIntReturnValue

void setIntReturnValue(int val)

Sets the value of 'intReturnValue'.

Field Description

The value for a INT return type.

Parameters:

val - The value to set.

getIntReturnValue

int getIntReturnValue()

Gets the value of 'intReturnValue'.

Field Description

The value for a INT return type.

Returns:

The value for a INT return type.

clearIntReturnValue

void clearIntReturnValue()

Clears the value of 'intReturnValue'.

Field Description

The value for a INT return type.

See Also:

setIntReturnValue(int)

hasIntReturnValue

boolean hasIntReturnValue()

Checks for the presence of 'intReturnValue'.

Field Description

The value for a INT return type.

See Also:

getIntReturnValue()

setLongReturnValue

void setLongReturnValue(long val)

Sets the value of 'longReturnValue'.

Field Description

The value for a LONG return type.

Parameters:

val - The value to set.

getLongReturnValue

long getLongReturnValue()

Gets the value of 'longReturnValue'.

Field Description

The value for a LONG return type.

Returns:

The value for a LONG return type.

clearLongReturnValue

void clearLongReturnValue()

Clears the value of 'longReturnValue'.

Field Description

The value for a LONG return type.

See Also:

setLongReturnValue(long)

hasLongReturnValue

boolean hasLongReturnValue()

Checks for the presence of 'longReturnValue'.

Field Description

The value for a LONG return type.

See Also:

getLongReturnValue()

setFloatReturnValue

void setFloatReturnValue(float val)

Sets the value of 'floatReturnValue'.

Field Description

The value for a FLOAT return type.

Parameters:

val - The value to set.

getFloatReturnValue

float getFloatReturnValue()

Gets the value of 'floatReturnValue'.

Field Description

The value for a FLOAT return type.

Returns:

The value for a FLOAT return type.

clearFloatReturnValue

void clearFloatReturnValue()

Clears the value of 'floatReturnValue'.

Field Description

The value for a FLOAT return type.

See Also:

setFloatReturnValue(float)

hasFloatReturnValue

boolean hasFloatReturnValue()

Checks for the presence of 'floatReturnValue'.

Field Description

The value for a FLOAT return type.

See Also:

getFloatReturnValue()

setDoubleReturnValue

void setDoubleReturnValue(double val)

Sets the value of 'doubleReturnValue'.

Field Description

The value for a DOUBLE return type.

Parameters:

val - The value to set.

getDoubleReturnValue

double getDoubleReturnValue()

Gets the value of 'doubleReturnValue'.

Field Description

The value for a DOUBLE return type.

Returns:

The value for a DOUBLE return type.

clearDoubleReturnValue

void clearDoubleReturnValue()

Clears the value of 'doubleReturnValue'.

Field Description

The value for a DOUBLE return type.

See Also:

setDoubleReturnValue(double)

hasDoubleReturnValue

boolean hasDoubleReturnValue()

Checks for the presence of 'doubleReturnValue'.

Field Description

The value for a DOUBLE return type.

See Also:

getDoubleReturnValue()

setDateReturnValue

void setDateReturnValue(Date val)

Sets the value of 'dateReturnValue'.

Field Description

The value for a DATE return type.

Parameters:

val - The value to set.

getDateReturnValue

Date getDateReturnValue()

Gets the value of 'dateReturnValue'.

Field Description

The value for a DATE return type.

Returns:

The value for a DATE return type.

setDateReturnValueAsTimestamp

void setDateReturnValueAsTimestamp(long val)

Sets the date value as a timestamp.

Field Description

The value for a DATE return type.

Parameters:

val - The date value in milliseconds from the epoch

getDateReturnValueAsTimestamp

long getDateReturnValueAsTimestamp()

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

Field Description

The value for a DATE return type.

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

Returns:

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

clearDateReturnValue

void clearDateReturnValue()

Clears the value of 'dateReturnValue'.

Field Description

The value for a DATE return type.

See Also:

setDateReturnValue(Date)

hasDateReturnValue

boolean hasDateReturnValue()

Checks for the presence of 'dateReturnValue'.

Field Description

The value for a DATE return type.

See Also:

getDateReturnValue()

setXvmHeader

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

Sets the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

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

Specified by:

setXvmHeader in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

lendXvmHeader

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

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

Field Description

Details about the message source.

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

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

Specified by:

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

Specified by:

lendXvmHeader in interface ISrvMonXvmResponse

Parameters:

val - the value to 'lend' to lend.

getXvmHeader

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

Gets the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

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

Specified by:

getXvmHeader in interface ISrvMonXvmResponse

Returns:

Details about the message source.

getXvmHeaderTo

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

Copies the value of SrvMonXvmHeader into the provided value.

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

Specified by:

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

Specified by:

getXvmHeaderTo in interface ISrvMonXvmResponse

Parameters:

val - the value to copy into

See Also:

SrvMonXvmHeader.copyInto(SrvMonXvmHeader)

takeXvmHeader

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

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

Field Description

Details about the message source.

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

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

Specified by:

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

Specified by:

takeXvmHeader in interface ISrvMonXvmResponse

Returns:

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

hasXvmHeader

boolean hasXvmHeader()

Checks for the presence of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

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

Specified by:

hasXvmHeader in interface ISrvMonXvmResponse

See Also:

getXvmHeader()

clearXvmHeader

void clearXvmHeader()

Clears the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

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

Specified by:

clearXvmHeader in interface ISrvMonXvmResponse

See Also:

setXvmHeader(SrvMonXvmHeader)

setAdminClientId

void setAdminClientId(String val)

Sets the value of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

Specified by:

setAdminClientId in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

getAdminClientId

String getAdminClientId()

Gets the value of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

Specified by:

getAdminClientId in interface ISrvMonXvmResponse

Returns:

The admin client targeted in the command exchange

lendAdminClientId

void lendAdminClientId(XString val)

Lends the value of 'adminClientId' to this object.

This method is equivalent to setAdminClientId 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 admin client targeted in the command exchange.

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:

lendAdminClientId in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setAdminClientIdFrom

void setAdminClientIdFrom(long val)

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

Field Description

The admin client targeted in the command exchange.

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

Specified by:

setAdminClientIdFrom in interface ISrvMonXvmResponse

getAdminClientIdTo

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

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

Field Description

The admin client targeted in the command exchange.

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:

getAdminClientIdTo in interface ISrvMonXvmResponse

Parameters:

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

Returns:

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

Throws:

NullPointerException - if the provided factory is null

setAdminClientIdFrom

void setAdminClientIdFrom(XString val)

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

Field Description

The admin client targeted in the command exchange.

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

Specified by:

setAdminClientIdFrom in interface ISrvMonXvmResponse

getAdminClientIdTo

void getAdminClientIdTo(XString val)

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

Field Description

The admin client targeted in the command exchange.

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

Specified by:

getAdminClientIdTo in interface ISrvMonXvmResponse

See Also:

getAdminClientId()

getAdminClientIdUnsafe

XString getAdminClientIdUnsafe()

Gets the raw value of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

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:

getAdminClientIdUnsafe in interface ISrvMonXvmResponse

Returns:

the field's raw value

See Also:

getAdminClientId()

clearAdminClientId

void clearAdminClientId()

Clears the value of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

Specified by:

clearAdminClientId in interface ISrvMonXvmResponse

See Also:

setAdminClientId(String)

hasAdminClientId

boolean hasAdminClientId()

Checks for the presence of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

Specified by:

hasAdminClientId in interface ISrvMonXvmResponse

See Also:

getAdminClientId()

setXvmName

void setXvmName(String val)

Sets the value of 'xvmName'.

Field Description

The name of the XVM targeted in the command exchange.

Specified by:

setXvmName in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

getXvmName

String getXvmName()

Gets the value of 'xvmName'.

Field Description

The name of the XVM targeted in the command exchange.

Specified by:

getXvmName in interface ISrvMonXvmResponse

Returns:

The name of the XVM targeted in the command exchange

lendXvmName

void lendXvmName(XString val)

Lends the value of 'xvmName' to this object.

This method is equivalent to setXvmName 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 XVM targeted in the command exchange.

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:

lendXvmName in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setXvmNameFrom

void setXvmNameFrom(long val)

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

Field Description

The name of the XVM targeted in the command exchange.

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

Specified by:

setXvmNameFrom in interface ISrvMonXvmResponse

getXvmNameTo

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

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

Field Description

The name of the XVM targeted in the command exchange.

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:

getXvmNameTo in interface ISrvMonXvmResponse

Parameters:

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

Returns:

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

Throws:

NullPointerException - if the provided factory is null

setXvmNameFrom

void setXvmNameFrom(XString val)

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

Field Description

The name of the XVM targeted in the command exchange.

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

Specified by:

setXvmNameFrom in interface ISrvMonXvmResponse

getXvmNameTo

void getXvmNameTo(XString val)

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

Field Description

The name of the XVM targeted in the command exchange.

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

Specified by:

getXvmNameTo in interface ISrvMonXvmResponse

See Also:

getXvmName()

getXvmNameUnsafe

XString getXvmNameUnsafe()

Gets the raw value of 'xvmName'.

Field Description

The name of the XVM targeted in the command exchange.

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:

getXvmNameUnsafe in interface ISrvMonXvmResponse

Returns:

the field's raw value

See Also:

getXvmName()

clearXvmName

void clearXvmName()

Clears the value of 'xvmName'.

Field Description

The name of the XVM targeted in the command exchange.

Specified by:

clearXvmName in interface ISrvMonXvmResponse

See Also:

setXvmName(String)

hasXvmName

boolean hasXvmName()

Checks for the presence of 'xvmName'.

Field Description

The name of the XVM targeted in the command exchange.

Specified by:

hasXvmName in interface ISrvMonXvmResponse

See Also:

getXvmName()

setStringReturnValue

void setStringReturnValue(String val)

Sets the value of 'stringReturnValue'.

Field Description

The value for a STRING return type.

Parameters:

val - The value to set.

getStringReturnValue

String getStringReturnValue()

Gets the value of 'stringReturnValue'.

Field Description

The value for a STRING return type.

Returns:

The value for a STRING return type.

lendStringReturnValue

void lendStringReturnValue(XString val)

Lends the value of 'stringReturnValue' to this object.

This method is equivalent to setStringReturnValue 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 value for a STRING return type.

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.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setStringReturnValueFrom

void setStringReturnValueFrom(long val)

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

Field Description

The value for a STRING return type.

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

getStringReturnValueTo

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

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

Field Description

The value for a STRING return type.

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

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

Parameters:

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

Returns:

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

Throws:

NullPointerException - if the provided factory is null

setStringReturnValueFrom

void setStringReturnValueFrom(XString val)

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

Field Description

The value for a STRING return type.

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

getStringReturnValueTo

void getStringReturnValueTo(XString val)

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

Field Description

The value for a STRING return type.

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

See Also:

getStringReturnValue()

getStringReturnValueUnsafe

XString getStringReturnValueUnsafe()

Gets the raw value of 'stringReturnValue'.

Field Description

The value for a STRING return type.

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

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

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

Returns:

the field's raw value

See Also:

getStringReturnValue()

clearStringReturnValue

void clearStringReturnValue()

Clears the value of 'stringReturnValue'.

Field Description

The value for a STRING return type.

See Also:

setStringReturnValue(String)

hasStringReturnValue

boolean hasStringReturnValue()

Checks for the presence of 'stringReturnValue'.

Field Description

The value for a STRING return type.

See Also:

getStringReturnValue()

setErrorMessage

void setErrorMessage(String val)

Sets the value of 'errorMessage'.

Field Description

If the command did not complete successfully this field holds an error message.

Parameters:

val - The value to set.

getErrorMessage

String getErrorMessage()

Gets the value of 'errorMessage'.

Field Description

If the command did not complete successfully this field holds an error message.

Returns:

If the command did not complete successfully this field holds an error message.

lendErrorMessage

void lendErrorMessage(XString val)

Lends the value of 'errorMessage' to this object.

This method is equivalent to setErrorMessage 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

If the command did not complete successfully this field holds an error message.

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.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setErrorMessageFrom

void setErrorMessageFrom(long val)

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

Field Description

If the command did not complete successfully this field holds an error message.

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

getErrorMessageTo

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

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

Field Description

If the command did not complete successfully this field holds an error message.

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

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

Parameters:

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

Returns:

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

Throws:

NullPointerException - if the provided factory is null

setErrorMessageFrom

void setErrorMessageFrom(XString val)

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

Field Description

If the command did not complete successfully this field holds an error message.

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

getErrorMessageTo

void getErrorMessageTo(XString val)

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

Field Description

If the command did not complete successfully this field holds an error message.

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

See Also:

getErrorMessage()

getErrorMessageUnsafe

XString getErrorMessageUnsafe()

Gets the raw value of 'errorMessage'.

Field Description

If the command did not complete successfully this field holds an error message.

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

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

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

Returns:

the field's raw value

See Also:

getErrorMessage()

clearErrorMessage

void clearErrorMessage()

Clears the value of 'errorMessage'.

Field Description

If the command did not complete successfully this field holds an error message.

See Also:

setErrorMessage(String)

hasErrorMessage

boolean hasErrorMessage()

Checks for the presence of 'errorMessage'.

Field Description

If the command did not complete successfully this field holds an error message.

See Also:

getErrorMessage()

setStackTrace

void setStackTrace(String val)

Sets the value of 'stackTrace'.

Field Description

A stack trace that can accompany an error message if there was an exception.

Parameters:

val - The value to set.

getStackTrace

String getStackTrace()

Gets the value of 'stackTrace'.

Field Description

A stack trace that can accompany an error message if there was an exception.

Returns:

A stack trace that can accompany an error message if there was an exception

lendStackTrace

void lendStackTrace(XString val)

Lends the value of 'stackTrace' to this object.

This method is equivalent to setStackTrace 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

A stack trace that can accompany an error message if there was an exception.

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.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setStackTraceFrom

void setStackTraceFrom(long val)

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

Field Description

A stack trace that can accompany an error message if there was an exception.

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

getStackTraceTo

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

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

Field Description

A stack trace that can accompany an error message if there was an exception.

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

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

Parameters:

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

Returns:

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

Throws:

NullPointerException - if the provided factory is null

setStackTraceFrom

void setStackTraceFrom(XString val)

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

Field Description

A stack trace that can accompany an error message if there was an exception.

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

getStackTraceTo

void getStackTraceTo(XString val)

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

Field Description

A stack trace that can accompany an error message if there was an exception.

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

See Also:

getStackTrace()

getStackTraceUnsafe

XString getStackTraceUnsafe()

Gets the raw value of 'stackTrace'.

Field Description

A stack trace that can accompany an error message if there was an exception.

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

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

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

Returns:

the field's raw value

See Also:

getStackTrace()

clearStackTrace

void clearStackTrace()

Clears the value of 'stackTrace'.

Field Description

A stack trace that can accompany an error message if there was an exception.

See Also:

setStackTrace(String)

hasStackTrace

boolean hasStackTrace()

Checks for the presence of 'stackTrace'.

Field Description

A stack trace that can accompany an error message if there was an exception.

See Also:

getStackTrace()

copy

SrvMonInvokeCommandResponse copy()

Creates a copy of this SrvMonInvokeCommandResponse.

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

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

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

Specified by:

copy in interface CopyableMessageView<ISrvMonInvokeCommandResponse>

Specified by:

copy in interface IRogCopyableNode<ISrvMonInvokeCommandResponse>

Returns:

A copy of this SrvMonInvokeCommandResponse.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonInvokeCommandResponse target)

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

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

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

Parameters:

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