com.neeve.aep

Class AepEnvironmentData

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.sma.MessageViewImpl

com.neeve.rog.impl.RogNode

com.neeve.aep.AepEnvironmentData

All Implemented Interfaces:

IStoreObject, IStoreObjectMetadata, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker

public final class AepEnvironmentData
extends com.neeve.rog.impl.RogNode
implements IRogMessage

Implements the store object to replicate environment provider data

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

Field Summary

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

DATE_FORMAT

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Fields inherited from interface com.neeve.sma.MessageView

ENCODING_TYPE_CUSTOM, ENCODING_TYPE_JSON, ENCODING_TYPE_PROTOBUF, ENCODING_TYPE_QUARK, ENCODING_TYPE_XBUF, ENCODING_TYPE_XBUF2, NEXT_FREE_ENCODING_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
static AepEnvironmentData	create()
IStoreObject	deserialize(PktPacket object) Deserialize an object's data.
AepEnvironmentData	deserializeFromByteArray(byte[] array) Deserialize a view's backing message from a byte array.
AepEnvironmentData	deserializeFromByteBuffer(ByteBuffer buffer) Deserialize a view's backing message from a byte buffer.
AepEnvironmentData	deserializeFromJson(String json) Deserialize a view's backing message from a json string
AepEnvironmentData	deserializeFromPacket(PktPacket packet) Deserialize a view's backing message from a packet.
AepEnvironmentData	deserializeFromProtobuf(com.google.protobuf.Message message) Deserialize a node's data from a protobuf message.
int	dispose() Implementation of IRogNode.dispose() ROG nodes piggyback on packet pooling to perform node pooling.
IStoreObject.EncodingType	getContentEncodingType() Get an object's content data encoding type.
PktPacket	serialize() Serialize an object's data.
byte[]	serializeToByteArray() Serialize a view's backing message to a byte array.
ByteBuffer	serializeToByteBuffer() Serialize a view's backing message to a byte buffer.
String	serializeToJson() Serialize a view's backing message to JSON.
PktPacket	serializeToPacket() Serialize a view's backing message to a packet.
com.google.protobuf.Message	serializeToProtobuf() Serialize a node's data to a proto message.
IStoreObject	setFieldValue(int id, Object val)
void	sync() Ensure a view's backing message is prepared and ready for transport
String	toString() Return a string representation of an ROG node.
void	undispose(com.eaio.uuid.UUID id) Recuscitate a disposed node.

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

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

Methods inherited from class com.neeve.sma.MessageViewImpl

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

Methods inherited from class com.neeve.util.UtlListElement

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neeve.rog.IRogNode

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

Methods inherited from interface com.neeve.ods.IStoreObject

acquire, deserializeMetadata, deserializeMetadata, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, serializeMetadata, setFieldValue

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata

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

Methods inherited from interface com.neeve.sma.MapMessageView

getMessageReflector

Methods inherited from interface com.neeve.sma.MessageView

acquire, getAppSendBeginTs, getAppSendDoneTs, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getMessage, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageEncodingType, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getOriginTs, getOutTs, getOutTsMicros, getOwnershipCount, getPostDeserializeTs, getPostProcessingTs, getPostProcessingTsMicros, getPostSerializeTs, getPostWireSendTs, getPostWireTs, getPreDeserializeTs, getPreProcessingTs, getPreProcessingTsMicros, getPreSerializeTs, getPreWireTs, getReceiveTs, getSendStartTs, getSendTs, getTag, getVfid, isPossibleDuplicate, resolveMessageKeyWith, resolveMessageKeyWith, serializeToIOBuffer, setAppSendBeginTs, setAppSendDoneTs, setCreateTs, setEnqueueTsMicros, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageSender, setMessageSequenceNumber, setMessageTransportHeaders, setOriginTs, setOutTs, setOutTsMicros, setPossibleDuplicate, setPostDeserializeTs, setPostProcessingTs, setPostProcessingTsMicros, setPostSerializeTs, setPostWireSendTs, setPostWireTs, setPreDeserializeTs, setPreProcessingTs, setPreProcessingTsMicros, setPreSerializeTs, setPreWireTs, setReceiveTs, setSendStartTs, setSendTs, setTag

Methods inherited from interface com.neeve.util.UtlReferenceTracker.HasReferenceTracker

referenceTracker

Methods inherited from interface com.neeve.rog.IRogMetadata

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

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

create

public static AepEnvironmentData create()

serializeToByteArray

public final byte[] serializeToByteArray()

Description copied from interface: MessageView

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

Specified by:

serializeToByteArray in interface MessageView

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

Description copied from interface: MessageView

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

Specified by:

serializeToByteBuffer in interface MessageView

serializeToPacket

public final PktPacket serializeToPacket()

Description copied from interface: MessageView

Serialize a view's backing message to a packet.

Specified by:

serializeToPacket in interface MessageView

serializeToProtobuf

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

Description copied from interface: IRogNode

Serialize a node's data to a proto message.

Specified by:

serializeToProtobuf in interface IRogNode

serializeToJson

public final String serializeToJson()

Description copied from interface: MessageView

Serialize a view's backing message to JSON.

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

Specified by:

serializeToJson in interface MessageView

deserializeFromByteArray

public final AepEnvironmentData deserializeFromByteArray(byte[] array)

Description copied from interface: MessageView

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

Specified by:

deserializeFromByteArray in interface MessageView

Parameters:

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

deserializeFromByteBuffer

public final AepEnvironmentData deserializeFromByteBuffer(ByteBuffer buffer)

Description copied from interface: MessageView

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

Specified by:

deserializeFromByteBuffer in interface MessageView

Parameters:

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

deserializeFromPacket

public final AepEnvironmentData deserializeFromPacket(PktPacket packet)

Description copied from interface: MessageView

Deserialize a view's backing message from a packet.

Specified by:

deserializeFromPacket in interface MessageView

Parameters:

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

deserializeFromProtobuf

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

Description copied from interface: IRogNode

Deserialize a node's data from a protobuf message.

Specified by:

deserializeFromProtobuf in interface IRogNode

Parameters:

message - The protobuf message

deserializeFromJson

public final AepEnvironmentData deserializeFromJson(String json)

Description copied from interface: MessageView

Deserialize a view's backing message from a json string

Specified by:

deserializeFromJson in interface MessageView

Parameters:

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

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

dispose

public int dispose()

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

Implementation of IRogNode.dispose()

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

Specified by:

dispose in interface IStoreObject

Specified by:

dispose in interface IRogNode

Specified by:

dispose in interface MessageView

Overrides:

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

Returns:

The reference count after the dispose completed.

undispose

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

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

Recuscitate a disposed node.

Overrides:

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

Parameters:

id - The resuscitated node's id.

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

sync

public final void sync()

Description copied from interface: MessageView

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

Specified by:

sync in interface MessageView

getContentEncodingType

public final IStoreObject.EncodingType getContentEncodingType()

Description copied from interface: IStoreObject

Get an object's content data encoding type.

Specified by:

getContentEncodingType in interface IStoreObject

serialize

public final PktPacket serialize()

Description copied from interface: IStoreObject

Serialize an object's data.

Specified by:

serialize in interface IStoreObject

deserialize

public final IStoreObject deserialize(PktPacket object)

Description copied from interface: IStoreObject

Deserialize an object's data.

Specified by:

deserialize in interface IStoreObject

Parameters:

object - The object in serialized form.

Returns:

Returns 'this' object for invocation chaining.

setFieldValue

public final IStoreObject setFieldValue(int id,
                         Object val)

toString

public final String toString()

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

Return a string representation of an ROG node.

Overrides:

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