com.neeve.ods

Interface IStoreObjectMetadata

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, IStoreObject

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 IStoreObjectMetadata

Represents IStoreObject metadata

Method Summary

Methods

Modifier and Type	Method and Description
com.eaio.uuid.UUID	ensureId() Instructs the object to generate a UUID if not already generated.
IStoreBinding	getBinding() Get the store binding associated with an object.
long	getCheckpointVersion() Get an object's checkpoint version.
int	getCommittedDataSize() Called by an IStoreBinding during commit to determine the previously committed data size.
com.eaio.uuid.UUID	getId() Get an object's id.
short	getOfid() Get an object's factory id
long	getStableTransactionId() Gets the transactionId considered stabilized by the application.
long	getTransactionId() Get the application transaction id.
short	getType() Get the object type.
IStoreObject	setBinding(IStoreBinding binding) Set the store binding associated with an object.
void	setCheckpointVersion(long version) Update checkpoint version of an object
void	setCommittedDataSize(int dataSize) Called by an IStoreBinding during commit to track an object's data size.
void	setId(com.eaio.uuid.UUID id) Set an object'd id.
IStoreObject	setStableTransactionId(long id) Set the the transactionId considered stabilized by the application.
IStoreObject	setTransactionId(long id) Set the application transaction id.

Method Detail

setId

void setId(com.eaio.uuid.UUID id)

Set an object'd id. Each ODS store object is universally identified by a UUID. This method sets an object's id.

Note: This method may copy the uuid into a preallocated uuid instance in the interest of reducing garbage collection, so the caller should not rely on the instance subsequently returned from getId() to be the same instance, just an equivalent one.

Throws:

IllegalStateException - If the node already has an id set.

Threading:

This method can be concurrently invoked by multiple threads.

ensureId

com.eaio.uuid.UUID ensureId()

Instructs the object to generate a UUID if not already generated. After this call a call to getId() must return a non null value;

NOTE:
If the IStoreObject is pooled, the validity of the returned UUID is only valid while the object remains undisposed (see IStoreObject.dispose(). Once the object is returned to its pool the UUID may be wiped and reused. Consequently, callers that plan to use the returned id beyond this objects lifespan should either make a copy of it, or acquire this object to prevent it from be returned to its pool.

Returns:

the object's id.

Threading:

This method is not safe for use by multiple threads ... only one thread can initialize the UUID.

getId

com.eaio.uuid.UUID getId()

Get an object's id.

NOTE:
If this object is pooled, the validity of the returned UUID is only valid while the object remains, undisposed. Once the object is returned to its pool the UUID may be wiped and reused. Consequently, callers that plan to use the returned id beyond this objects lifespan should either make a copy of it, or aquire this object to prevent it from be returned to its pool.

Threading:

This method can be concurrently invoked by multiple threads.

Each ODS store object is universally identified by a UUID. This method returns an object's id.

getOfid

short getOfid()

Get an object's factory id

Threading:

This method can be concurrently invoked by multiple threads.

This method returns the id of the factory used to instantiate the object.

getType

short getType()

Get the object type.

Threading:

This method is safe for concurrent access by multiple threads

An object type uniquely identifies the object within its factory.

setBinding

IStoreObject setBinding(IStoreBinding binding)

Set the store binding associated with an object.

Returns:

Returns this object for invocation chaining.

An object can be stored by one and only one store binding at any point in time. This method sets the binding associated with an object. The binding invokes this method when an object is put and removed from the store.

Threading:

This method can be concurrently invoked by multiple threads.

getBinding

IStoreBinding getBinding()

Get the store binding associated with an object.

Threading:

This method can be concurrently invoked by multiple threads.

setTransactionId

IStoreObject setTransactionId(long id)

Set the application transaction id.

Parameters:

id - The transaction id to set

getTransactionId

long getTransactionId()

Get the application transaction id.

setStableTransactionId

IStoreObject setStableTransactionId(long id)

Set the the transactionId considered stabilized by the application.

Parameters:

id - The stable transaction id to set

getStableTransactionId

long getStableTransactionId()

Gets the transactionId considered stabilized by the application.

Returns:

the stable application transaction id.

setCheckpointVersion

void setCheckpointVersion(long version)

Update checkpoint version of an object

Parameters:

version - The new checkpoint version.

See Also:

Note: May only be called by an {@link IStoreBinding} to update the checkpoint version of the object.

getCheckpointVersion

long getCheckpointVersion()

Get an object's checkpoint version.

When an IStoreObject is added to a store or mutated its checkpoint modification counter is set to its IStoreBinding's next checkpoint number. This field can be used to perform 'change data capture' or CDC on stores that are checkpointed to see if a node has changed since a given store checkpoint.

• A negative value indicates that the object has not been added to a store or has not been checkpointed.
• A value greater than or equal to 0 indicates when the node was last modified relative to store checkpoints.

When an object is removed for a store the store must set the checkpoint version of the object back to -1.

Returns:

The last checkpoint modification for the node.

setCommittedDataSize

void setCommittedDataSize(int dataSize)

Called by an IStoreBinding during commit to track an object's data size.

Implementors must store this value and return it unaltered to the store via getCommittedDataSize()

Parameters:

dataSize - The committed data size.

getCommittedDataSize

int getCommittedDataSize()

Called by an IStoreBinding during commit to determine the previously committed data size.

This

Returns:

The last committed store data size.