com.neeve.ods

Interface IStoreObject

All Superinterfaces:

IStoreObjectMetadata, UtlReferenceTracker.HasReferenceTracker

All Known Subinterfaces:

IRogBooleanMap<T>, IRogByteMap<T>, IRogCharMap<T>, IRogCollectionNode<T>, IRogCollectionNodeElement, IRogContainerNode, IRogCopyableNode<T>, IRogDoubleMap<T>, IRogDoubleMapElement, IRogFloatMap<T>, IRogIntMap<T>, IRogIntMapElement, IRogList<T>, IRogListElement, IRogLongMap<T>, IRogLongMapElement, IRogMessage, IRogNode, IRogPojoShadowNode<T>, IRogQuarkStringMapElement, IRogQueue<T>, IRogQueueElement, IRogRawMessage, IRogSet<T>, IRogShortMap<T>, IRogStringMap<T>, IRogStringMapElement, ISrvMonAppBusBindingCreatedMessage, ISrvMonAppBusBindingCreateFailedMessage, ISrvMonAppBusBindingCreateMessage, ISrvMonAppBusBindingDestroyedMessage, ISrvMonAppBusBindingDestroyMessage, ISrvMonAppBusBindingDownMessage, ISrvMonAppBusBindingOpenedMessage, ISrvMonAppBusBindingOpenFailedMessage, ISrvMonAppBusBindingOpeningMessage, ISrvMonAppBusBindingStateChangeMessage, ISrvMonAppBusBindingStateChangeMessage, ISrvMonAppBusBindingUpMessage, ISrvMonAppBusChannelClosedMessage, ISrvMonAppBusChannelOpenedMessage, ISrvMonAppChannelDownMessage, ISrvMonAppChannelUpMessage, ISrvMonAppClientConnectMessage, ISrvMonAppClientConnectMessage, ISrvMonAppClientDisconnectMessage, ISrvMonAppClientDisconnectMessage, ISrvMonAppDuplicateAcknowledgementAlertMessage, ISrvMonAppEngineActiveMessage, ISrvMonAppEngineCreatedMessage, ISrvMonAppEngineStartedMessage, ISrvMonAppEngineStoppedMessage, ISrvMonAppEngineStoppingMessage, ISrvMonAppExceptionMessage, ISrvMonAppFlowCreateMessage, ISrvMonAppFlowCreateMessage, ISrvMonAppInboundLogExceptionMessage, ISrvMonAppLoadedMessage, ISrvMonAppLoadedMessage, ISrvMonAppMessagingFailedMessage, ISrvMonAppMessagingPrestartMessage, ISrvMonAppMessagingStartedMessage, ISrvMonAppMessagingStartFailedMessage, ISrvMonAppOutboundLogExceptionMessage, ISrvMonAppOutOfOrderSendCommitCompletionAlertMessage, ISrvMonAppSendExceptionMessage, ISrvMonAppStateChangeMessage, ISrvMonAppStateChangeMessage, ISrvMonAppStatsAlertMessage, ISrvMonAppStoreBindingFailedMessage, ISrvMonAppStoreBindingRoleChangedMessage, ISrvMonAppStoreMemberDownMessage, ISrvMonAppStoreMemberInitCompleteMessage, ISrvMonAppStoreMemberUpMessage, ISrvMonAppStoreTransactionLogRepairedMessage, ISrvMonAppStuckAlertMessage, ISrvMonAppUnhandledMessageMessage, ISrvMonAppUnloadedMessage, ISrvMonAppUnloadedMessage, ISrvMonGetLoadedAppsRequest, ISrvMonGetLoadedAppsResponse, ISrvMonGetTraceHistoryRequest, ISrvMonGetTraceHistoryResponse, ISrvMonHeartbeatMessage, ISrvMonInvokeCommandRequest, ISrvMonInvokeCommandResponse, ISrvMonListCommandsRequest, ISrvMonListCommandsResponse, ISrvMonMessageBusBindingReconnectedMessage, ISrvMonMessageBusBindingReconnectingMessage, ISrvMonMessageTraceLoggingExceptionMessage, ISrvMonStartAppWatchCommand, ISrvMonStartTraceWatchRequest, ISrvMonStartTraceWatchResponse, ISrvMonStopAppWatchCommand, ISrvMonStopTraceWatchRequest, ISrvMonStopTraceWatchResponse, ISrvMonTraceRecord, ISrvMonUnhandledMessageMessage, ISrvMonXvmInfoRequest, ISrvMonXvmInfoResponse

All Known Implementing Classes:

AepEnvironmentData, com.neeve.rog.impl.RogNode, SrvMonAppBusBindingCreatedMessage, SrvMonAppBusBindingCreateFailedMessage, SrvMonAppBusBindingCreateMessage, SrvMonAppBusBindingDestroyedMessage, SrvMonAppBusBindingDestroyMessage, SrvMonAppBusBindingDownMessage, SrvMonAppBusBindingOpenedMessage, SrvMonAppBusBindingOpenFailedMessage, SrvMonAppBusBindingOpeningMessage, SrvMonAppBusBindingStateChangeMessage, SrvMonAppBusBindingStateChangeMessage, SrvMonAppBusBindingUpMessage, SrvMonAppBusChannelClosedMessage, SrvMonAppBusChannelOpenedMessage, SrvMonAppChannelDownMessage, SrvMonAppChannelUpMessage, SrvMonAppClientConnectMessage, SrvMonAppClientConnectMessage, SrvMonAppClientDisconnectMessage, SrvMonAppClientDisconnectMessage, SrvMonAppDuplicateAcknowledgementAlertMessage, SrvMonAppEngineActiveMessage, SrvMonAppEngineCreatedMessage, SrvMonAppEngineStartedMessage, SrvMonAppEngineStoppedMessage, SrvMonAppEngineStoppingMessage, SrvMonAppExceptionMessage, SrvMonAppFlowCreateMessage, SrvMonAppFlowCreateMessage, SrvMonAppInboundLogExceptionMessage, SrvMonAppLoadedMessage, SrvMonAppLoadedMessage, SrvMonAppMessagingFailedMessage, SrvMonAppMessagingPrestartMessage, SrvMonAppMessagingStartedMessage, SrvMonAppMessagingStartFailedMessage, SrvMonAppOutboundLogExceptionMessage, SrvMonAppOutOfOrderSendCommitCompletionAlertMessage, SrvMonAppSendExceptionMessage, SrvMonAppStateChangeMessage, SrvMonAppStateChangeMessage, SrvMonAppStatsAlertMessage, SrvMonAppStoreBindingFailedMessage, SrvMonAppStoreBindingRoleChangedMessage, SrvMonAppStoreMemberDownMessage, SrvMonAppStoreMemberInitCompleteMessage, SrvMonAppStoreMemberUpMessage, SrvMonAppStoreTransactionLogRepairedMessage, SrvMonAppStuckAlertMessage, SrvMonAppUnhandledMessageMessage, SrvMonAppUnloadedMessage, SrvMonAppUnloadedMessage, SrvMonGetLoadedAppsRequest, SrvMonGetLoadedAppsResponse, SrvMonGetTraceHistoryRequest, SrvMonGetTraceHistoryResponse, SrvMonHeartbeatMessage, SrvMonInvokeCommandRequest, SrvMonInvokeCommandResponse, SrvMonListCommandsRequest, SrvMonListCommandsResponse, SrvMonMessageBusBindingReconnectedMessage, SrvMonMessageBusBindingReconnectingMessage, SrvMonMessageTraceLoggingExceptionMessage, SrvMonStartAppWatchCommand, SrvMonStartTraceWatchRequest, SrvMonStartTraceWatchResponse, SrvMonStopAppWatchCommand, SrvMonStopTraceWatchRequest, SrvMonStopTraceWatchResponse, SrvMonTraceRecord, SrvMonUnhandledMessageMessage, SrvMonXvmInfoRequest, SrvMonXvmInfoResponse

public interface IStoreObject
extends UtlReferenceTracker.HasReferenceTracker, IStoreObjectMetadata

Represents an ODS store object.

This interface defines the behavior of objects stored in ODSstores. An object can be stored in an ODS store if and only if it implements this interface.

Threading:

A store object is not safe for concurrent access by multiple threads.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IStoreObject.EncodingType Defines the various supported encoding types.

Method Summary

Methods

Modifier and Type	Method and Description
void	acquire() Increase a store object's ownership count.
IStoreObject	deserialize(PktPacket serializedObject) Deserialize an object's data.
IStoreObject	deserializeMetadata(PktBuffer metadata) Deserialize an object's metadata from its serialized form.
IStoreObject	deserializeMetadata(PktBuffer metadata, boolean copyDeserialize) Deserialize an object's metadata from its serialized form.
int	dispose() Dispose a store object.
IStoreObject.EncodingType	getContentEncodingType() Get an object's content data encoding type.
boolean	getIsReadOnly() Get whether a object is read only
int	getOwnershipCount() Get a store object's ownership count.
int	getSerializedMetadataLength() Get the length of an object's serialized metadata length
IStoreObjectMetadata	getStoreMetadata() Gets the store metadata associated with this object.
PktPacket	serialize() Serialize an object's data.
int	serializeMetadata(com.neeve.io.IOElasticBuffer buffer, int offset) Serialize an object's metadata.
IStoreObject	setFieldValue(long fieldId, Object fieldVal) Set the value of an object field.

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

referenceTracker

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata

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

Method Detail

getStoreMetadata

IStoreObjectMetadata getStoreMetadata()

Gets the store metadata associated with this object.

Returns:

the store metadata associated with this object.

getIsReadOnly

boolean getIsReadOnly()

Get whether a object is read only

setFieldValue

IStoreObject setFieldValue(long fieldId,
                         Object fieldVal)

Set the value of an object field.

Parameters:

fieldId - The field id

fieldVal - The field value

Returns:

Returns this object for invocation chaining.

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

Threading:

This method will never be concurrently invoked by multiple threads.

getContentEncodingType

IStoreObject.EncodingType getContentEncodingType()

Get an object's content data encoding type.

getSerializedMetadataLength

int getSerializedMetadataLength()

Get the length of an object's serialized metadata length

Returns:

Returns the length, in bytes, of the serialzied metadata.

Threading:

This method will never be concurrently invoked by multiple threads.

serializeMetadata

int serializeMetadata(com.neeve.io.IOElasticBuffer buffer,
                    int offset)

Serialize an object's metadata.

Parameters:

buffer - The buffer to serialize the metadata to

offset - The offset within the buffer to serialize the metadata to.

Returns:

Returns the number of bytes serialized.

Threading:

This method will never be concurrently invoked by multiple threads.

This method is invoked during the commit process to serialize an object's metadata.

serialize

PktPacket serialize()

Serialize an object's data.

Threading:

This method will never be concurrently invoked by multiple threads.

This method is invoked during the commit process to serialize an object for replication and/or persistence and/or ICR send.

deserializeMetadata

IStoreObject deserializeMetadata(PktBuffer metadata)

Deserialize an object's metadata from its serialized form.

Parameters:

metadata - The metadata in serialized form.

Returns:

Returns 'this' object for invocation chaining.

Threading:

This method will never be concurrently invoked by multiple threads.

deserializeMetadata

IStoreObject deserializeMetadata(PktBuffer metadata,
                               boolean copyDeserialize)

Deserialize an object's metadata from its serialized form.

Parameters:

metadata - The metadata in serialized form.

copyDeserialize - Whether the deserialization process should copy fields out of the serialized form into private members. A value of false could result in the metadata object holding onto the IOBuffer underlying the supplied metadata beyond the scope of this call.

Returns:

Returns 'this' object for invocation chaining.

Threading:

This method will never be concurrently invoked by multiple threads.

deserialize

IStoreObject deserialize(PktPacket serializedObject)

Deserialize an object's data.

Parameters:

serializedObject - The object in serialized form.

Returns:

Returns 'this' object for invocation chaining.

Threading:

This method will never be concurrently invoked by multiple threads.

acquire

void acquire()

Increase a store object's ownership count.

An object's ownership count starts at 1.

getOwnershipCount

int getOwnershipCount()

Get a store object's ownership count.

dispose

int dispose()

Dispose a store object.

This method should be invoked by the user when done with a store object. This allows the object implementation to track the lifetime of an object allow it to potentially implement faclities (such as object pooling) to improve performance. It is guaranteed however that not invoking this method will still cause the system to run correctly and in a stable fashion. However, in such a case, the performance may not be optimal.

Once disposed, all references to the disposed object should be discarded.

Returns:

The reference count after the dispose completed.