com.neeve.server.mon
Class SrvMonAppInfo

java.lang.Object
  com.neeve.server.mon.SrvMonAppInfo

All Implemented Interfaces:

IRogValidatable, ISrvMonAppInfo, UtlPool.Item<SrvMonAppInfo>, 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=SrvMonFactory.class,
                vfid=32,
                ofid=32,
                typeId=100)
public final class SrvMonAppInfo
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonAppInfo>, ISrvMonAppInfo

Holds information about an application.

Nested Class Summary

static class	SrvMonAppInfo.Field The SrvMonAppInfo xbuf field (used internally when this entity is used as a field of another entity).
static class	SrvMonAppInfo.ListField The SrvMonAppInfo list field (used internally when this entity is used as an array field of another entity).

Field Summary

static SrvMonAppInfo[]

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

Constructor Summary

SrvMonAppInfo()

SrvMonAppInfo(int initialBackingBufferSize)

Method Summary

SrvMonAppInfo	acquire()
void	addBusBindingsInfo(SrvMonAppBusBindingInfo val) Adds the provided value to the list of 'busBindingsInfo' values.
void	addClientsInfo(SrvMonAppClientInfo val) Adds the provided value to the list of 'clientsInfo' values.
void	addFlowsInfo(SrvMonAppFlowInfo val) Adds the provided value to the list of 'flowsInfo' values.
void	clearBusBindingsInfo() Clears the value of 'busBindingsInfo' Field Description Holds information about a app's message bus bindings.
void	clearClientsInfo() Clears the value of 'clientsInfo' Field Description Holds information about a app's connected clients.
void	clearContent()
void	clearFlowsInfo() Clears the value of 'flowsInfo' Field Description Holds information about a app's active message flows.
void	clearHAPolicy() Clears the value of 'HAPolicy' Field Description The application's HAPolicy.
void	clearJarVersion() Deprecated. - No Reason Given
void	clearJarVersionString() Clears the value of 'jarVersionString' Field Description The jar version of the application (if specified/known)
void	clearLoadedTime() Clears the value of 'loadedTime' Field Description The time at which the app was last loaded
void	clearName() Clears the value of 'name' Field Description The application's name.
void	clearRole() Clears the value of 'role' Field Description The application's current HA role.
void	clearState() Clears the value of 'state' Field Description The application's current state.
void	clearVersion() Clears the value of 'version' Field Description The application version if (if specified/known).
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonAppInfo	copy() Creates a copy of this SrvMonAppInfo.
void	copyInto(SrvMonAppInfo copy) Copies the contents of this SrvMonAppInfo into the target.
static SrvMonAppInfo	create()
static SrvMonAppInfo	createFrom(byte[] serializedContainer)
static SrvMonAppInfo	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonAppInfo	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonAppInfo	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonAppInfo	deserializeFromByteArray(byte[] array)
SrvMonAppInfo	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppInfo	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonAppInfo	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppInfo	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonAppInfo	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppInfo	deserializeFromNative(long address, int offset, int length)
SrvMonAppInfo	deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
int	desync(PktBuffer buffer, int pos, boolean frameOnly)
void	desyncFieldBitmask()
void	dispose()
PktBuffer	getBackingBuffer()
SrvMonAppBusBindingInfo[]	getBusBindingsInfo() Gets the value of 'busBindingsInfo' If the field is not set this method will return null.
SrvMonAppBusBindingInfo[]	getBusBindingsInfoEmptyIfNull() Gets the value of 'busBindingsInfo' or an empty array if the value is null or not set.
static int	getBusBindingsInfoFieldId() Get the field id for 'busBindingsInfo' This method can be used to set field interests.
XIterator<SrvMonAppBusBindingInfo>	getBusBindingsInfoIterator() Gets the value of 'busBindingsInfo' as iterator of values.
SrvMonAppClientInfo[]	getClientsInfo() Gets the value of 'clientsInfo' If the field is not set this method will return null.
SrvMonAppClientInfo[]	getClientsInfoEmptyIfNull() Gets the value of 'clientsInfo' or an empty array if the value is null or not set.
static int	getClientsInfoFieldId() Get the field id for 'clientsInfo' This method can be used to set field interests.
XIterator<SrvMonAppClientInfo>	getClientsInfoIterator() Gets the value of 'clientsInfo' as iterator of values.
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
SrvMonAppFlowInfo[]	getFlowsInfo() Gets the value of 'flowsInfo' If the field is not set this method will return null.
SrvMonAppFlowInfo[]	getFlowsInfoEmptyIfNull() Gets the value of 'flowsInfo' or an empty array if the value is null or not set.
static int	getFlowsInfoFieldId() Get the field id for 'flowsInfo' This method can be used to set field interests.
XIterator<SrvMonAppFlowInfo>	getFlowsInfoIterator() Gets the value of 'flowsInfo' as iterator of values.
SrvMonAppHAPolicy	getHAPolicy() Gets the value of 'HAPolicy' Field Description The application's HAPolicy.
com.neeve.xbuf.XbufVariableEnumField<SrvMonAppHAPolicy>	getHAPolicyField()
static int	getHAPolicyFieldId() Get the field id for 'HAPolicy' This method can be used to set field interests.
boolean	getIsReadOnly()
int	getJarVersion() Deprecated. - No Reason Given
com.neeve.xbuf.XbufVariableIntField	getJarVersionField() Deprecated. - No Reason Given
static int	getJarVersionFieldId() Deprecated. - No Reason Given
String	getJarVersionString() Gets the value of 'jarVersionString' Field Description The jar version of the application (if specified/known)
com.neeve.xbuf.XbufStringField	getJarVersionStringField()
static int	getJarVersionStringFieldId() Get the field id for 'jarVersionString' This method can be used to set field interests.
<T extends XString> T	getJarVersionStringTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getJarVersionStringTo(XString val) Copies the value of 'jarVersionString' into the provided XString.
XString	getJarVersionStringUnsafe() Gets the raw value of 'jarVersionString'.
Date	getLoadedTime() Gets the value of 'loadedTime' Field Description The time at which the app was last loaded
long	getLoadedTimeAsTimestamp() Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
com.neeve.xbuf.XbufVariableDateField	getLoadedTimeField()
static int	getLoadedTimeFieldId() Get the field id for 'loadedTime' This method can be used to set field interests.
String	getName() Gets the value of 'name' Field Description The application's name.
com.neeve.xbuf.XbufStringField	getNameField()
static int	getNameFieldId() Get the field id for 'name' This method can be used to set field interests.
<T extends XString> T	getNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getNameTo(XString val) Copies the value of 'name' into the provided XString.
XString	getNameUnsafe() Gets the raw value of 'name'.
int	getOwnerCount()
UtlPool<SrvMonAppInfo>	getPool() Get a pool item's pool.
SrvMonAppRole	getRole() Gets the value of 'role' Field Description The application's current HA role.
com.neeve.xbuf.XbufVariableEnumField<SrvMonAppRole>	getRoleField()
static int	getRoleFieldId() Get the field id for 'role' This method can be used to set field interests.
int	getSerializeToNativeLength()
SrvMonAppState	getState() Gets the value of 'state' Field Description The application's current state.
com.neeve.xbuf.XbufVariableEnumField<SrvMonAppState>	getStateField()
static int	getStateFieldId() Get the field id for 'state' This method can be used to set field interests.
void	getValidationErrors(List<XString> results, String errorPrefix) Collects validation errors into the provided list.
int	getVersion() Gets the value of 'version' Field Description The application version if (if specified/known).
com.neeve.xbuf.XbufVariableIntField	getVersionField()
static int	getVersionFieldId() Get the field id for 'version' This method can be used to set field interests.
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	hasHAPolicy() Checks for the presence of 'HAPolicy' Field Description The application's HAPolicy.
boolean	hasJarVersion() Deprecated. - No Reason Given
boolean	hasJarVersionString() Checks for the presence of 'jarVersionString' Field Description The jar version of the application (if specified/known)
boolean	hasLoadedTime() Checks for the presence of 'loadedTime' Field Description The time at which the app was last loaded
boolean	hasName() Checks for the presence of 'name' Field Description The application's name.
boolean	hasRole() Checks for the presence of 'role' Field Description The application's current HA role.
boolean	hasState() Checks for the presence of 'state' Field Description The application's current state.
boolean	hasVersion() Checks for the presence of 'version' Field Description The application version if (if specified/known).
boolean	hasXRogType()
SrvMonAppInfo	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
void	lendBusBindingsInfo(SrvMonAppBusBindingInfo val) Adds the provided value to the list of 'busBindingsInfo' values and acquires a reference to it.
void	lendBusBindingsInfo(SrvMonAppBusBindingInfo[] val) Lends the value of 'busBindingsInfo' Field Description Holds information about a app's message bus bindings.
void	lendBusBindingsInfoFrom(XIterator<SrvMonAppBusBindingInfo> val) Sets the value of 'busBindingsInfo' by lending the values from the provided iterator.
void	lendClientsInfo(SrvMonAppClientInfo val) Adds the provided value to the list of 'clientsInfo' values and acquires a reference to it.
void	lendClientsInfo(SrvMonAppClientInfo[] val) Lends the value of 'clientsInfo' Field Description Holds information about a app's connected clients.
void	lendClientsInfoFrom(XIterator<SrvMonAppClientInfo> val) Sets the value of 'clientsInfo' by lending the values from the provided iterator.
void	lendFlowsInfo(SrvMonAppFlowInfo val) Adds the provided value to the list of 'flowsInfo' values and acquires a reference to it.
void	lendFlowsInfo(SrvMonAppFlowInfo[] val) Lends the value of 'flowsInfo' Field Description Holds information about a app's active message flows.
void	lendFlowsInfoFrom(XIterator<SrvMonAppFlowInfo> val) Sets the value of 'flowsInfo' by lending the values from the provided iterator.
void	lendJarVersionString(XString val) Sets the value of 'jarVersionString' Field Description The jar version of the application (if specified/known)
void	lendName(XString val) Sets the value of 'name' Field Description The application's name.
static void	optimizeFor(int val)
byte[]	serializeToByteArray()
ByteBuffer	serializeToByteBuffer()
com.neeve.io.IOBuffer	serializeToIOBuffer(boolean useNative)
int	serializeToNative(long address, int addressOffset)
void	setAsReadOnly()
void	setBusBindingsInfo(SrvMonAppBusBindingInfo[] val) Sets the value of 'busBindingsInfo' Field Description Holds information about a app's message bus bindings.
void	setBusBindingsInfoFrom(XIterator<SrvMonAppBusBindingInfo> val) Sets the value of 'busBindingsInfo' using the values from the provided iterator.
void	setClientsInfo(SrvMonAppClientInfo[] val) Sets the value of 'clientsInfo' Field Description Holds information about a app's connected clients.
void	setClientsInfoFrom(XIterator<SrvMonAppClientInfo> val) Sets the value of 'clientsInfo' using the values from the provided iterator.
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
static void	setFieldInterest(List<Integer> fieldIds)
void	setFlowsInfo(SrvMonAppFlowInfo[] val) Sets the value of 'flowsInfo' Field Description Holds information about a app's active message flows.
void	setFlowsInfoFrom(XIterator<SrvMonAppFlowInfo> val) Sets the value of 'flowsInfo' using the values from the provided iterator.
void	setHAPolicy(SrvMonAppHAPolicy val) Sets the value of 'HAPolicy' Field Description The application's HAPolicy.
void	setHAPolicyFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonAppHAPolicy> val)
void	setJarVersion(int val) Deprecated. - No Reason Given
void	setJarVersionFrom(com.neeve.xbuf.XbufVariableIntField val) Deprecated. - No Reason Given
void	setJarVersionString(String val) Sets the value of 'jarVersionString' Field Description The jar version of the application (if specified/known)
void	setJarVersionStringFrom(long val) Sets the value of this String field to the given numeric value.
void	setJarVersionStringFrom(com.neeve.xbuf.XbufStringField val)
void	setJarVersionStringFrom(XString val) Copies the provided XString value into this object's 'jarVersionString'.
void	setLoadedTime(Date val) Sets the value of 'loadedTime' Field Description The time at which the app was last loaded
void	setLoadedTimeAsTimestamp(long val) Sets the date value as a timestamp.
void	setLoadedTimeFrom(com.neeve.xbuf.XbufVariableDateField val)
void	setName(String val) Sets the value of 'name' Field Description The application's name.
void	setNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setNameFrom(com.neeve.xbuf.XbufStringField val)
void	setNameFrom(XString val) Copies the provided XString value into this object's 'name'.
SrvMonAppInfo	setPool(UtlPool<SrvMonAppInfo> pool) Set a pool item's pool.
void	setRole(SrvMonAppRole val) Sets the value of 'role' Field Description The application's current HA role.
void	setRoleFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonAppRole> val)
void	setState(SrvMonAppState val) Sets the value of 'state' Field Description The application's current state.
void	setStateFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonAppState> val)
void	setVersion(int val) Sets the value of 'version' Field Description The application version if (if specified/known).
void	setVersionFrom(com.neeve.xbuf.XbufVariableIntField val)
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync()
void	syncFieldBitmask()
SrvMonAppBusBindingInfo[]	takeBusBindingsInfo() Takes the value of 'busBindingsInfo' Field Description Holds information about a app's message bus bindings.
SrvMonAppClientInfo[]	takeClientsInfo() Takes the value of 'clientsInfo' Field Description Holds information about a app's connected clients.
SrvMonAppFlowInfo[]	takeFlowsInfo() Takes the value of 'flowsInfo' Field Description Holds information about a app's active message flows.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final SrvMonAppInfo[] EMPTY_ARRAY

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

Constructor Detail

SrvMonAppInfo

public SrvMonAppInfo()

SrvMonAppInfo

public SrvMonAppInfo(int initialBackingBufferSize)

Method Detail

create

public static SrvMonAppInfo create()

createFromSerializedXbufContainer

public static SrvMonAppInfo createFromSerializedXbufContainer(byte[] serializedContainer,
                                                              com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

createFromSerializedXbufContainer

public static SrvMonAppInfo createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

public static SrvMonAppInfo createFrom(byte[] serializedContainer,
                                       com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

createFrom

public static SrvMonAppInfo 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)

setAsReadOnly

public final void setAsReadOnly()

getIsReadOnly

public final boolean getIsReadOnly()

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()

getVersionFieldId

public static final int getVersionFieldId()

Get the field id for 'version'

This method can be used to set field interests.

See Also:

getVersion()

setVersion

public final void setVersion(int val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'version'

Field Description

The application version if (if specified/known). Typically this will come from the app's @AppVersion

Specified by:

setVersion in interface ISrvMonAppInfo

Parameters:

val - The value to set.

getVersion

public final int getVersion()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'version'

Field Description

The application version if (if specified/known). Typically this will come from the app's @AppVersion

Specified by:

getVersion in interface ISrvMonAppInfo

Returns:

The application version if (if specified/known). Typically this will come from the app's @AppVersion

setVersionFrom

public final void setVersionFrom(com.neeve.xbuf.XbufVariableIntField val)

getVersionField

public final com.neeve.xbuf.XbufVariableIntField getVersionField()

hasVersion

public final boolean hasVersion()

Description copied from interface: ISrvMonAppInfo

Checks for the presence of 'version'

Field Description

The application version if (if specified/known). Typically this will come from the app's @AppVersion

Specified by:

hasVersion in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.getVersion()

clearVersion

public final void clearVersion()

Description copied from interface: ISrvMonAppInfo

Clears the value of 'version'

Field Description

The application version if (if specified/known). Typically this will come from the app's @AppVersion

Specified by:

clearVersion in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.setVersion(int)

getJarVersionFieldId

@Deprecated
public static final int getJarVersionFieldId()

Deprecated. - No Reason Given

Get the field id for 'jarVersion'

This method can be used to set field interests.

See Also:

getJarVersion()

setJarVersion

@Deprecated
public final void setJarVersion(int val)

Deprecated. - No Reason Given

Description copied from interface: ISrvMonAppInfo

Sets the value of 'jarVersion'

Field Description

The jar version of the application (if specified/known)

Specified by:

setJarVersion in interface ISrvMonAppInfo

Parameters:

val - The value to set.

getJarVersion

@Deprecated
public final int getJarVersion()

Deprecated. - No Reason Given

Description copied from interface: ISrvMonAppInfo

Gets the value of 'jarVersion'

Field Description

The jar version of the application (if specified/known)

Specified by:

getJarVersion in interface ISrvMonAppInfo

Returns:

The jar version of the application (if specified/known)

setJarVersionFrom

@Deprecated
public final void setJarVersionFrom(com.neeve.xbuf.XbufVariableIntField val)

Deprecated. - No Reason Given

getJarVersionField

@Deprecated
public final com.neeve.xbuf.XbufVariableIntField getJarVersionField()

Deprecated. - No Reason Given

hasJarVersion

@Deprecated
public final boolean hasJarVersion()

Deprecated. - No Reason Given

Description copied from interface: ISrvMonAppInfo

Checks for the presence of 'jarVersion'

Field Description

The jar version of the application (if specified/known)

Specified by:

hasJarVersion in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.getJarVersion()

clearJarVersion

@Deprecated
public final void clearJarVersion()

Deprecated. - No Reason Given

Description copied from interface: ISrvMonAppInfo

Clears the value of 'jarVersion'

Field Description

The jar version of the application (if specified/known)

Specified by:

clearJarVersion in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.setJarVersion(int)

getStateFieldId

public static final int getStateFieldId()

Get the field id for 'state'

This method can be used to set field interests.

See Also:

getState()

setState

public final void setState(SrvMonAppState val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'state'

Field Description

The application's current state.

Specified by:

setState in interface ISrvMonAppInfo

Parameters:

val - The value to set.

setStateFrom

public final void setStateFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonAppState> val)

getStateField

public final com.neeve.xbuf.XbufVariableEnumField<SrvMonAppState> getStateField()

getState

public final SrvMonAppState getState()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'state'

Field Description

The application's current state.

Specified by:

getState in interface ISrvMonAppInfo

Returns:

The application's current state.

hasState

public final boolean hasState()

Description copied from interface: ISrvMonAppInfo

Checks for the presence of 'state'

Field Description

The application's current state.

Specified by:

hasState in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.getState()

clearState

public final void clearState()

Description copied from interface: ISrvMonAppInfo

Clears the value of 'state'

Field Description

The application's current state.

Specified by:

clearState in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.setState(SrvMonAppState)

getRoleFieldId

public static final int getRoleFieldId()

Get the field id for 'role'

This method can be used to set field interests.

See Also:

getRole()

setRole

public final void setRole(SrvMonAppRole val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'role'

Field Description

The application's current HA role.

Specified by:

setRole in interface ISrvMonAppInfo

Parameters:

val - The value to set.

setRoleFrom

public final void setRoleFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonAppRole> val)

getRoleField

public final com.neeve.xbuf.XbufVariableEnumField<SrvMonAppRole> getRoleField()

getRole

public final SrvMonAppRole getRole()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'role'

Field Description

The application's current HA role.

Specified by:

getRole in interface ISrvMonAppInfo

Returns:

The application's current HA role.

hasRole

public final boolean hasRole()

Description copied from interface: ISrvMonAppInfo

Checks for the presence of 'role'

Field Description

The application's current HA role.

Specified by:

hasRole in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.getRole()

clearRole

public final void clearRole()

Description copied from interface: ISrvMonAppInfo

Clears the value of 'role'

Field Description

The application's current HA role.

Specified by:

clearRole in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.setRole(SrvMonAppRole)

getHAPolicyFieldId

public static final int getHAPolicyFieldId()

Get the field id for 'HAPolicy'

This method can be used to set field interests.

See Also:

getHAPolicy()

setHAPolicy

public final void setHAPolicy(SrvMonAppHAPolicy val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'HAPolicy'

Field Description

The application's HAPolicy.

Specified by:

setHAPolicy in interface ISrvMonAppInfo

Parameters:

val - The value to set.

setHAPolicyFrom

public final void setHAPolicyFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonAppHAPolicy> val)

getHAPolicyField

public final com.neeve.xbuf.XbufVariableEnumField<SrvMonAppHAPolicy> getHAPolicyField()

getHAPolicy

public final SrvMonAppHAPolicy getHAPolicy()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'HAPolicy'

Field Description

The application's HAPolicy.

Specified by:

getHAPolicy in interface ISrvMonAppInfo

Returns:

The application's HAPolicy.

hasHAPolicy

public final boolean hasHAPolicy()

Description copied from interface: ISrvMonAppInfo

Checks for the presence of 'HAPolicy'

Field Description

The application's HAPolicy.

Specified by:

hasHAPolicy in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.getHAPolicy()

clearHAPolicy

public final void clearHAPolicy()

Description copied from interface: ISrvMonAppInfo

Clears the value of 'HAPolicy'

Field Description

The application's HAPolicy.

Specified by:

clearHAPolicy in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.setHAPolicy(SrvMonAppHAPolicy)

getLoadedTimeFieldId

public static final int getLoadedTimeFieldId()

Get the field id for 'loadedTime'

This method can be used to set field interests.

See Also:

getLoadedTime()

setLoadedTime

public final void setLoadedTime(Date val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'loadedTime'

Field Description

The time at which the app was last loaded

Specified by:

setLoadedTime in interface ISrvMonAppInfo

Parameters:

val - The value to set.

getLoadedTime

public final Date getLoadedTime()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'loadedTime'

Field Description

The time at which the app was last loaded

Specified by:

getLoadedTime in interface ISrvMonAppInfo

Returns:

The time at which the app was last loaded

setLoadedTimeAsTimestamp

public final void setLoadedTimeAsTimestamp(long val)

Description copied from interface: ISrvMonAppInfo

Sets the date value as a timestamp.

Field Description

The time at which the app was last loaded

Specified by:

setLoadedTimeAsTimestamp in interface ISrvMonAppInfo

Parameters:

val - The date value in milliseconds from the epoch

getLoadedTimeAsTimestamp

public final long getLoadedTimeAsTimestamp()

Description copied from interface: ISrvMonAppInfo

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

Field Description

The time at which the app was last loaded

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, ISrvMonAppInfo.hasLoadedTime() should be called.

Specified by:

getLoadedTimeAsTimestamp in interface ISrvMonAppInfo

Returns:

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

setLoadedTimeFrom

public final void setLoadedTimeFrom(com.neeve.xbuf.XbufVariableDateField val)

getLoadedTimeField

public final com.neeve.xbuf.XbufVariableDateField getLoadedTimeField()

hasLoadedTime

public final boolean hasLoadedTime()

Description copied from interface: ISrvMonAppInfo

Checks for the presence of 'loadedTime'

Field Description

The time at which the app was last loaded

Specified by:

hasLoadedTime in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.getLoadedTime()

clearLoadedTime

public final void clearLoadedTime()

Description copied from interface: ISrvMonAppInfo

Clears the value of 'loadedTime'

Field Description

The time at which the app was last loaded

Specified by:

clearLoadedTime in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.setLoadedTime(Date)

getNameFieldId

public static final int getNameFieldId()

Get the field id for 'name'

This method can be used to set field interests.

See Also:

getName()

setName

public final void setName(String val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'name'

Field Description

The application's name.

Specified by:

setName in interface ISrvMonAppInfo

Parameters:

val - The value to set.

getName

public final String getName()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'name'

Field Description

The application's name.

Specified by:

getName in interface ISrvMonAppInfo

Returns:

The application's name.

lendName

public final void lendName(XString val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'name'

Field Description

The application's name.

Specified by:

lendName in interface ISrvMonAppInfo

Parameters:

val - The value to set.

setNameFrom

public final void setNameFrom(long val)

Description copied from interface: ISrvMonAppInfo

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

Field Description

The application's name.

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

Specified by:

setNameFrom in interface ISrvMonAppInfo

getNameTo

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

Description copied from interface: ISrvMonAppInfo

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

Field Description

The application's name.

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:

getNameTo in interface ISrvMonAppInfo

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.

setNameFrom

public final void setNameFrom(XString val)

Description copied from interface: ISrvMonAppInfo

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

Field Description

The application's name.

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

Specified by:

setNameFrom in interface ISrvMonAppInfo

getNameTo

public final void getNameTo(XString val)

Description copied from interface: ISrvMonAppInfo

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

Field Description

The application's name.

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

Specified by:

getNameTo in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.getName()

getNameUnsafe

public final XString getNameUnsafe()

Description copied from interface: ISrvMonAppInfo

Gets the raw value of 'name'.

Field Description

The application's name.

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:

getNameUnsafe in interface ISrvMonAppInfo

Returns:

the field's raw value

See Also:

ISrvMonAppInfo.getName()

setNameFrom

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

getNameField

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

hasName

public final boolean hasName()

Description copied from interface: ISrvMonAppInfo

Checks for the presence of 'name'

Field Description

The application's name.

Specified by:

hasName in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.getName()

clearName

public final void clearName()

Description copied from interface: ISrvMonAppInfo

Clears the value of 'name'

Field Description

The application's name.

Specified by:

clearName in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.setName(String)

getClientsInfoFieldId

public static final int getClientsInfoFieldId()

Get the field id for 'clientsInfo'

This method can be used to set field interests.

See Also:

getClientsInfo()

setClientsInfo

public final void setClientsInfo(SrvMonAppClientInfo[] val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'clientsInfo'

Field Description

Holds information about a app's connected clients.

Specified by:

setClientsInfo in interface ISrvMonAppInfo

Parameters:

val - The value to set.

setClientsInfoFrom

public final void setClientsInfoFrom(XIterator<SrvMonAppClientInfo> val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'clientsInfo' 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 'clientsInfo' accessor can copy the values without iteration.

Field Description

Holds information about a app's connected clients.

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonAppInfo.setClientsInfo(SrvMonAppClientInfo[]) with a value of null.

Specified by:

setClientsInfoFrom in interface ISrvMonAppInfo

Parameters:

val - the values to set.

lendClientsInfoFrom

public final void lendClientsInfoFrom(XIterator<SrvMonAppClientInfo> val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'clientsInfo' by lending 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 will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.

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

Field Description

Holds information about a app's connected clients.

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonAppInfo.setClientsInfo(SrvMonAppClientInfo[]) with a value of null.

Specified by:

lendClientsInfoFrom in interface ISrvMonAppInfo

Parameters:

val - the values to set.

lendClientsInfo

public final void lendClientsInfo(SrvMonAppClientInfo[] val)

Description copied from interface: ISrvMonAppInfo

Lends the value of 'clientsInfo'

Field Description

Holds information about a app's connected clients.

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:

lendClientsInfo in interface ISrvMonAppInfo

Parameters:

val - the value to 'lend' to lend.

addClientsInfo

public final void addClientsInfo(SrvMonAppClientInfo val)

Description copied from interface: ISrvMonAppInfo

Adds the provided value to the list of 'clientsInfo' values.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'clientsInfo' 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

Holds information about a app's connected clients.

Specified by:

addClientsInfo in interface ISrvMonAppInfo

Parameters:

val - the value to add.

lendClientsInfo

public final void lendClientsInfo(SrvMonAppClientInfo val)

Description copied from interface: ISrvMonAppInfo

Adds the provided value to the list of 'clientsInfo' values and acquires a reference to it.

Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'clientsInfo' 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

Holds information about a app's connected clients.

Specified by:

lendClientsInfo in interface ISrvMonAppInfo

Parameters:

val - the value to add.

getClientsInfo

public final SrvMonAppClientInfo[] getClientsInfo()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'clientsInfo'

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

Field Description

Holds information about a app's connected clients.

Specified by:

getClientsInfo in interface ISrvMonAppInfo

Returns:

Holds information about a app's connected clients. If the field is not set this method will return null.

getClientsInfoEmptyIfNull

public final SrvMonAppClientInfo[] getClientsInfoEmptyIfNull()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'clientsInfo' or an empty array if the value is null or not set.

Field Description

Holds information about a app's connected clients.

Specified by:

getClientsInfoEmptyIfNull in interface ISrvMonAppInfo

Returns:

Holds information about a app's connected clients. or an empty array if null if not set.

See Also:

ISrvMonAppInfo.getClientsInfo()

getClientsInfoIterator

public final XIterator<SrvMonAppClientInfo> getClientsInfoIterator()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'clientsInfo' 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.

The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

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(XIterator method can perform a direct copy of the underlying values without iteration.

Field Description

Holds information about a app's connected clients.

Specified by:

getClientsInfoIterator in interface ISrvMonAppInfo

Returns:

An iterator containing this field values.

takeClientsInfo

public final SrvMonAppClientInfo[] takeClientsInfo()

Description copied from interface: ISrvMonAppInfo

Takes the value of 'clientsInfo'

Field Description

Holds information about a app's connected clients.

NOTE:
A nested entity reference returned by ISrvMonAppInfo.getClientsInfo() 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:

takeClientsInfo in interface ISrvMonAppInfo

Returns:

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

clearClientsInfo

public final void clearClientsInfo()

Description copied from interface: ISrvMonAppInfo

Clears the value of 'clientsInfo'

Field Description

Holds information about a app's connected clients.

Specified by:

clearClientsInfo in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.setClientsInfo(SrvMonAppClientInfo[])

getBusBindingsInfoFieldId

public static final int getBusBindingsInfoFieldId()

Get the field id for 'busBindingsInfo'

This method can be used to set field interests.

See Also:

getBusBindingsInfo()

setBusBindingsInfo

public final void setBusBindingsInfo(SrvMonAppBusBindingInfo[] val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'busBindingsInfo'

Field Description

Holds information about a app's message bus bindings.

Specified by:

setBusBindingsInfo in interface ISrvMonAppInfo

Parameters:

val - The value to set.

setBusBindingsInfoFrom

public final void setBusBindingsInfoFrom(XIterator<SrvMonAppBusBindingInfo> val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'busBindingsInfo' 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 'busBindingsInfo' accessor can copy the values without iteration.

Field Description

Holds information about a app's message bus bindings.

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonAppInfo.setBusBindingsInfo(SrvMonAppBusBindingInfo[]) with a value of null.

Specified by:

setBusBindingsInfoFrom in interface ISrvMonAppInfo

Parameters:

val - the values to set.

lendBusBindingsInfoFrom

public final void lendBusBindingsInfoFrom(XIterator<SrvMonAppBusBindingInfo> val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'busBindingsInfo' by lending 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 will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.

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

Field Description

Holds information about a app's message bus bindings.

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonAppInfo.setBusBindingsInfo(SrvMonAppBusBindingInfo[]) with a value of null.

Specified by:

lendBusBindingsInfoFrom in interface ISrvMonAppInfo

Parameters:

val - the values to set.

lendBusBindingsInfo

public final void lendBusBindingsInfo(SrvMonAppBusBindingInfo[] val)

Description copied from interface: ISrvMonAppInfo

Lends the value of 'busBindingsInfo'

Field Description

Holds information about a app's message bus bindings.

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:

lendBusBindingsInfo in interface ISrvMonAppInfo

Parameters:

val - the value to 'lend' to lend.

addBusBindingsInfo

public final void addBusBindingsInfo(SrvMonAppBusBindingInfo val)

Description copied from interface: ISrvMonAppInfo

Adds the provided value to the list of 'busBindingsInfo' values.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'busBindingsInfo' 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

Holds information about a app's message bus bindings.

Specified by:

addBusBindingsInfo in interface ISrvMonAppInfo

Parameters:

val - the value to add.

lendBusBindingsInfo

public final void lendBusBindingsInfo(SrvMonAppBusBindingInfo val)

Description copied from interface: ISrvMonAppInfo

Adds the provided value to the list of 'busBindingsInfo' values and acquires a reference to it.

Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'busBindingsInfo' 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

Holds information about a app's message bus bindings.

Specified by:

lendBusBindingsInfo in interface ISrvMonAppInfo

Parameters:

val - the value to add.

getBusBindingsInfo

public final SrvMonAppBusBindingInfo[] getBusBindingsInfo()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'busBindingsInfo'

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

Field Description

Holds information about a app's message bus bindings.

Specified by:

getBusBindingsInfo in interface ISrvMonAppInfo

Returns:

Holds information about a app's message bus bindings. If the field is not set this method will return null.

getBusBindingsInfoEmptyIfNull

public final SrvMonAppBusBindingInfo[] getBusBindingsInfoEmptyIfNull()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'busBindingsInfo' or an empty array if the value is null or not set.

Field Description

Holds information about a app's message bus bindings.

Specified by:

getBusBindingsInfoEmptyIfNull in interface ISrvMonAppInfo

Returns:

Holds information about a app's message bus bindings. or an empty array if null if not set.

See Also:

ISrvMonAppInfo.getBusBindingsInfo()

getBusBindingsInfoIterator

public final XIterator<SrvMonAppBusBindingInfo> getBusBindingsInfoIterator()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'busBindingsInfo' 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.

The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

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(XIterator method can perform a direct copy of the underlying values without iteration.

Field Description

Holds information about a app's message bus bindings.

Specified by:

getBusBindingsInfoIterator in interface ISrvMonAppInfo

Returns:

An iterator containing this field values.

takeBusBindingsInfo

public final SrvMonAppBusBindingInfo[] takeBusBindingsInfo()

Description copied from interface: ISrvMonAppInfo

Takes the value of 'busBindingsInfo'

Field Description

Holds information about a app's message bus bindings.

NOTE:
A nested entity reference returned by ISrvMonAppInfo.getBusBindingsInfo() 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:

takeBusBindingsInfo in interface ISrvMonAppInfo

Returns:

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

clearBusBindingsInfo

public final void clearBusBindingsInfo()

Description copied from interface: ISrvMonAppInfo

Clears the value of 'busBindingsInfo'

Field Description

Holds information about a app's message bus bindings.

Specified by:

clearBusBindingsInfo in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.setBusBindingsInfo(SrvMonAppBusBindingInfo[])

getFlowsInfoFieldId

public static final int getFlowsInfoFieldId()

Get the field id for 'flowsInfo'

This method can be used to set field interests.

See Also:

getFlowsInfo()

setFlowsInfo

public final void setFlowsInfo(SrvMonAppFlowInfo[] val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'flowsInfo'

Field Description

Holds information about a app's active message flows.

Specified by:

setFlowsInfo in interface ISrvMonAppInfo

Parameters:

val - The value to set.

setFlowsInfoFrom

public final void setFlowsInfoFrom(XIterator<SrvMonAppFlowInfo> val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'flowsInfo' 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 'flowsInfo' accessor can copy the values without iteration.

Field Description

Holds information about a app's active message flows.

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonAppInfo.setFlowsInfo(SrvMonAppFlowInfo[]) with a value of null.

Specified by:

setFlowsInfoFrom in interface ISrvMonAppInfo

Parameters:

val - the values to set.

lendFlowsInfoFrom

public final void lendFlowsInfoFrom(XIterator<SrvMonAppFlowInfo> val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'flowsInfo' by lending 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 will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.

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

Field Description

Holds information about a app's active message flows.

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonAppInfo.setFlowsInfo(SrvMonAppFlowInfo[]) with a value of null.

Specified by:

lendFlowsInfoFrom in interface ISrvMonAppInfo

Parameters:

val - the values to set.

lendFlowsInfo

public final void lendFlowsInfo(SrvMonAppFlowInfo[] val)

Description copied from interface: ISrvMonAppInfo

Lends the value of 'flowsInfo'

Field Description

Holds information about a app's active message flows.

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:

lendFlowsInfo in interface ISrvMonAppInfo

Parameters:

val - the value to 'lend' to lend.

addFlowsInfo

public final void addFlowsInfo(SrvMonAppFlowInfo val)

Description copied from interface: ISrvMonAppInfo

Adds the provided value to the list of 'flowsInfo' values.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'flowsInfo' 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

Holds information about a app's active message flows.

Specified by:

addFlowsInfo in interface ISrvMonAppInfo

Parameters:

val - the value to add.

lendFlowsInfo

public final void lendFlowsInfo(SrvMonAppFlowInfo val)

Description copied from interface: ISrvMonAppInfo

Adds the provided value to the list of 'flowsInfo' values and acquires a reference to it.

Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'flowsInfo' 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

Holds information about a app's active message flows.

Specified by:

lendFlowsInfo in interface ISrvMonAppInfo

Parameters:

val - the value to add.

getFlowsInfo

public final SrvMonAppFlowInfo[] getFlowsInfo()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'flowsInfo'

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

Field Description

Holds information about a app's active message flows.

Specified by:

getFlowsInfo in interface ISrvMonAppInfo

Returns:

Holds information about a app's active message flows. If the field is not set this method will return null.

getFlowsInfoEmptyIfNull

public final SrvMonAppFlowInfo[] getFlowsInfoEmptyIfNull()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'flowsInfo' or an empty array if the value is null or not set.

Field Description

Holds information about a app's active message flows.

Specified by:

getFlowsInfoEmptyIfNull in interface ISrvMonAppInfo

Returns:

Holds information about a app's active message flows. or an empty array if null if not set.

See Also:

ISrvMonAppInfo.getFlowsInfo()

getFlowsInfoIterator

public final XIterator<SrvMonAppFlowInfo> getFlowsInfoIterator()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'flowsInfo' 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.

The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

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(XIterator method can perform a direct copy of the underlying values without iteration.

Field Description

Holds information about a app's active message flows.

Specified by:

getFlowsInfoIterator in interface ISrvMonAppInfo

Returns:

An iterator containing this field values.

takeFlowsInfo

public final SrvMonAppFlowInfo[] takeFlowsInfo()

Description copied from interface: ISrvMonAppInfo

Takes the value of 'flowsInfo'

Field Description

Holds information about a app's active message flows.

NOTE:
A nested entity reference returned by ISrvMonAppInfo.getFlowsInfo() 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:

takeFlowsInfo in interface ISrvMonAppInfo

Returns:

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

clearFlowsInfo

public final void clearFlowsInfo()

Description copied from interface: ISrvMonAppInfo

Clears the value of 'flowsInfo'

Field Description

Holds information about a app's active message flows.

Specified by:

clearFlowsInfo in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.setFlowsInfo(SrvMonAppFlowInfo[])

getJarVersionStringFieldId

public static final int getJarVersionStringFieldId()

Get the field id for 'jarVersionString'

This method can be used to set field interests.

See Also:

getJarVersionString()

setJarVersionString

public final void setJarVersionString(String val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'jarVersionString'

Field Description

The jar version of the application (if specified/known)

Specified by:

setJarVersionString in interface ISrvMonAppInfo

Parameters:

val - The value to set.

getJarVersionString

public final String getJarVersionString()

Description copied from interface: ISrvMonAppInfo

Gets the value of 'jarVersionString'

Field Description

The jar version of the application (if specified/known)

Specified by:

getJarVersionString in interface ISrvMonAppInfo

Returns:

The jar version of the application (if specified/known)

lendJarVersionString

public final void lendJarVersionString(XString val)

Description copied from interface: ISrvMonAppInfo

Sets the value of 'jarVersionString'

Field Description

The jar version of the application (if specified/known)

Specified by:

lendJarVersionString in interface ISrvMonAppInfo

Parameters:

val - The value to set.

setJarVersionStringFrom

public final void setJarVersionStringFrom(long val)

Description copied from interface: ISrvMonAppInfo

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

Field Description

The jar version of the application (if specified/known)

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

Specified by:

setJarVersionStringFrom in interface ISrvMonAppInfo

getJarVersionStringTo

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

Description copied from interface: ISrvMonAppInfo

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

Field Description

The jar version of the application (if specified/known)

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:

getJarVersionStringTo in interface ISrvMonAppInfo

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.

setJarVersionStringFrom

public final void setJarVersionStringFrom(XString val)

Description copied from interface: ISrvMonAppInfo

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

Field Description

The jar version of the application (if specified/known)

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

Specified by:

setJarVersionStringFrom in interface ISrvMonAppInfo

getJarVersionStringTo

public final void getJarVersionStringTo(XString val)

Description copied from interface: ISrvMonAppInfo

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

Field Description

The jar version of the application (if specified/known)

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

Specified by:

getJarVersionStringTo in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.getJarVersionString()

getJarVersionStringUnsafe

public final XString getJarVersionStringUnsafe()

Description copied from interface: ISrvMonAppInfo

Gets the raw value of 'jarVersionString'.

Field Description

The jar version of the application (if specified/known)

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:

getJarVersionStringUnsafe in interface ISrvMonAppInfo

Returns:

the field's raw value

See Also:

ISrvMonAppInfo.getJarVersionString()

setJarVersionStringFrom

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

getJarVersionStringField

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

hasJarVersionString

public final boolean hasJarVersionString()

Description copied from interface: ISrvMonAppInfo

Checks for the presence of 'jarVersionString'

Field Description

The jar version of the application (if specified/known)

Specified by:

hasJarVersionString in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.getJarVersionString()

clearJarVersionString

public final void clearJarVersionString()

Description copied from interface: ISrvMonAppInfo

Clears the value of 'jarVersionString'

Field Description

The jar version of the application (if specified/known)

Specified by:

clearJarVersionString in interface ISrvMonAppInfo

See Also:

ISrvMonAppInfo.setJarVersionString(String)

isDirty

public final boolean isDirty()

createSchema

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

serializeToByteArray

public final byte[] serializeToByteArray()

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

serializeToIOBuffer

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

isBufferBacked

public final boolean isBufferBacked()

getSerializeToNativeLength

public final int getSerializeToNativeLength()

serializeToNative

public final int serializeToNative(long address,
                                   int addressOffset)

deserializeFromIOElasticBuffer

public final SrvMonAppInfo deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                          int offset,
                                                          int length,
                                                          com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromIOElasticBuffer

public final SrvMonAppInfo deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                          int offset,
                                                          int length)

deserializeFromByteArray

public final SrvMonAppInfo deserializeFromByteArray(byte[] array,
                                                    com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromByteArray

public final SrvMonAppInfo deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

public final SrvMonAppInfo deserializeFromByteBuffer(ByteBuffer buffer,
                                                     com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromByteBuffer

public final SrvMonAppInfo deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

public final SrvMonAppInfo deserializeFromNative(long address,
                                                 int offset,
                                                 int length,
                                                 com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromNative

public final SrvMonAppInfo deserializeFromNative(long address,
                                                 int offset,
                                                 int length)

sync

public final void sync()

desync

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

Specified by:

desync in interface com.neeve.xbuf.IXbufDesyncer

init

public final SrvMonAppInfo init()

Description copied from interface: UtlPool.Item

Initialize an item.

This method is invoked by an item pool very time an item is put into the pool. The method should wipe the contents of the item so as to present a fresh instance of the item to the caller when retrieved from the pool.

Specified by:

init in interface UtlPool.Item<SrvMonAppInfo>

Returns:

Return 'this' object for method invocation chaining.

setPool

public final SrvMonAppInfo setPool(UtlPool<SrvMonAppInfo> pool)

Description copied from interface: UtlPool.Item

Set a pool item's pool.

This method is invoked by an item pool at the time an item is added to the pool. The intent is to record the item's source pool in the item so it can be disposed back into the pool when the user is done working with it.

Specified by:

setPool in interface UtlPool.Item<SrvMonAppInfo>

Returns:

Return 'this' object for method invocation chaining.

getPool

public final UtlPool<SrvMonAppInfo> getPool()

Description copied from interface: UtlPool.Item

Get a pool item's pool.

This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool)

Specified by:

getPool in interface UtlPool.Item<SrvMonAppInfo>

Returns:

the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool)

isReferenceCounted

public final boolean isReferenceCounted()

acquire

public final SrvMonAppInfo acquire()

getOwnerCount

public final int getOwnerCount()

dispose

public final void dispose()

clone

public final Object clone()

Creates a clone of this object.

This method differs from the copy() method in that:

• For protobuf and xbuf generated objects pass-through fields are not preserved. Pass through fields are fields not defined by ADM model that generated this class, but may exist in the backing buffer or protobuf message for the object.
• The copy method may replace empty arrays with a null value whereas this method preserves empty array fields.

Overrides:

clone in class Object

copy

public final SrvMonAppInfo copy()

Creates a copy of this SrvMonAppInfo.

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

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

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.

Returns:

The copied entity.

copyInto

public final void copyInto(SrvMonAppInfo copy)

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

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

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.

Parameters:

copy - The target into which to copy.

isValid

public final boolean isValid()

Description copied from interface: IRogValidatable

Tests if this object has any validation errors.

Specified by:

isValid in interface IRogValidatable

getValidationErrors

public final void getValidationErrors(List<XString> results,
                                      String errorPrefix)

Description copied from interface: IRogValidatable

Collects validation errors into the provided list. It is illegal for the caller to hold onto the List of XStrings beyond the lifespace of this object.

Specified by:

getValidationErrors in interface IRogValidatable

Parameters:

results - A results list into which validation errors will be collected.

errorPrefix - The bean path prefix to use when identifying invalid fields or null if validating a top level entity.

toString

public final String toString()

Overrides:

toString in class Object