org.apache.ignite.internal.processors.cache.distributed.dht.atomic

Class GridNearAtomicUpdateRequest

java.lang.Object

org.apache.ignite.internal.processors.cache.GridCacheMessage

org.apache.ignite.internal.processors.cache.distributed.dht.atomic.GridNearAtomicUpdateRequest

All Implemented Interfaces:

Serializable, GridCacheDeployable, Message

public class GridNearAtomicUpdateRequest
extends GridCacheMessage
implements GridCacheDeployable

Lite DHT cache update request sent from near node to primary node.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CACHE_MSG_IDX Message index.

Fields inherited from class org.apache.ignite.internal.processors.cache.GridCacheMessage

addDepInfo, CACHE_MSG_INDEX_FIELD_NAME, cacheId, forceAddDepInfo, MAX_CACHE_MSG_LOOKUP_INDEX

Constructor Summary

Constructors

Constructor and Description
GridNearAtomicUpdateRequest() Empty constructor required by Externalizable.
GridNearAtomicUpdateRequest(int cacheId, UUID nodeId, GridCacheVersion futVer, boolean fastMap, GridCacheVersion updateVer, AffinityTopologyVersion topVer, boolean topLocked, CacheWriteSynchronizationMode syncMode, GridCacheOperation op, boolean retval, javax.cache.expiry.ExpiryPolicy expiryPlc, Object[] invokeArgs, CacheEntryPredicate[] filter, UUID subjId, int taskNameHash, boolean skipStore, boolean keepBinary, boolean clientReq, boolean addDepInfo, int maxEntryCnt) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addDeploymentInfo() Deployment enabled flag indicates whether deployment info has to be added to this message.
void	addUpdateEntry(KeyCacheObject key, Object val, long conflictTtl, long conflictExpireTime, GridCacheVersion conflictVer, boolean primary)
void	cleanup(boolean clearKeys) Cleanup values.
boolean	clientRequest()
long	conflictExpireTime(int idx)
long	conflictTtl(int idx)
GridCacheVersion	conflictVersion(int idx)
List<GridCacheVersion>	conflictVersions()
byte	directType() Gets message type.
javax.cache.processor.EntryProcessor<Object,Object,Object>	entryProcessor(int idx)
javax.cache.expiry.ExpiryPolicy	expiry()
boolean	fastMap()
byte	fieldsCount() Gets fields count.
CacheEntryPredicate[]	filter()
void	finishUnmarshal(GridCacheSharedContext ctx, ClassLoader ldr) This method is called after the message is deserialized and is responsible for unmarshalling state marshalled in GridCacheMessage.prepareMarshal(GridCacheSharedContext) method.
GridCacheVersion	futureVersion()
boolean	hasPrimary()
Object[]	invokeArguments()
boolean	keepBinary()
List<KeyCacheObject>	keys()
int	lookupIndex() Gets message lookup index.
UUID	nodeId()
void	nodeId(UUID nodeId)
boolean	onResponse(GridNearAtomicUpdateResponse res)
GridCacheOperation	operation()
void	prepareMarshal(GridCacheSharedContext ctx) This method is called before the whole message is serialized and is responsible for pre-marshalling state.
boolean	readFrom(ByteBuffer buf, MessageReader reader) Reads this message from provided byte buffer.
GridNearAtomicUpdateResponse	response()
boolean	returnValue()
boolean	skipStore()
UUID	subjectId()
int	taskNameHash()
boolean	topologyLocked()
AffinityTopologyVersion	topologyVersion() Gets topology version or -1 in case of topology version is not required for this message.
String	toString()
GridCacheVersion	updateVersion()
CacheObject	value(int idx)
List<?>	values()
CacheWriteSynchronizationMode	writeSynchronizationMode()
boolean	writeTo(ByteBuffer buf, MessageWriter writer) Writes this message to provided byte buffer.
CacheObject	writeValue(int idx)

Methods inherited from class org.apache.ignite.internal.processors.cache.GridCacheMessage

cacheId, cacheId, classError, deployInfo, error, finishUnmarshalCacheObjects, finishUnmarshalCacheObjects, ignoreClassErrors, marshalCollection, marshalInfo, marshalInfos, marshalInvokeArguments, marshalTx, messageId, nextIndexId, onAckReceived, onClassError, partitionExchangeMessage, prepare, prepareMarshalCacheObject, prepareMarshalCacheObjects, prepareMarshalCacheObjects, prepareObject, transferExpiryPolicy, unmarshalCollection, unmarshalInfo, unmarshalInfos, unmarshalInvokeArguments, unmarshalTx

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.ignite.internal.processors.cache.GridCacheDeployable

deployInfo, prepare

Field Detail

CACHE_MSG_IDX

public static final int CACHE_MSG_IDX

Message index.

Constructor Detail

GridNearAtomicUpdateRequest

public GridNearAtomicUpdateRequest()

Empty constructor required by Externalizable.

GridNearAtomicUpdateRequest

public GridNearAtomicUpdateRequest(int cacheId,
                           UUID nodeId,
                           GridCacheVersion futVer,
                           boolean fastMap,
                           @Nullable
                           GridCacheVersion updateVer,
                           @NotNull
                           AffinityTopologyVersion topVer,
                           boolean topLocked,
                           CacheWriteSynchronizationMode syncMode,
                           GridCacheOperation op,
                           boolean retval,
                           @Nullable
                           javax.cache.expiry.ExpiryPolicy expiryPlc,
                           @Nullable
                           Object[] invokeArgs,
                           @Nullable
                           CacheEntryPredicate[] filter,
                           @Nullable
                           UUID subjId,
                           int taskNameHash,
                           boolean skipStore,
                           boolean keepBinary,
                           boolean clientReq,
                           boolean addDepInfo,
                           int maxEntryCnt)

Constructor.

Parameters:

cacheId - Cache ID.

nodeId - Node ID.

futVer - Future version.

fastMap - Fast map scheme flag.

updateVer - Update version set if fast map is performed.

topVer - Topology version.

topLocked - Topology locked flag.

syncMode - Synchronization mode.

op - Cache update operation.

retval - Return value required flag.

expiryPlc - Expiry policy.

invokeArgs - Optional arguments for entry processor.

filter - Optional filter for atomic check.

subjId - Subject ID.

taskNameHash - Task name hash code.

skipStore - Skip write-through to a persistent storage.

keepBinary - Keep binary flag.

clientReq - Client node request flag.

addDepInfo - Deployment info flag.

maxEntryCnt - Maximum entries count.

Method Detail

lookupIndex

public int lookupIndex()

Gets message lookup index. All messages that does not return -1 in this method must return a unique number in range from 0 to GridCacheMessage.MAX_CACHE_MSG_LOOKUP_INDEX.

Overrides:

lookupIndex in class GridCacheMessage

Returns:

Message lookup index.

nodeId

public UUID nodeId()

Returns:

Mapped node ID.

nodeId

public void nodeId(UUID nodeId)

Parameters:

nodeId - Node ID.

subjectId

public UUID subjectId()

Returns:

Subject ID.

taskNameHash

public int taskNameHash()

Returns:

Task name hash.

futureVersion

public GridCacheVersion futureVersion()

Returns:

Future version.

fastMap

public boolean fastMap()

Returns:

Flag indicating whether this is fast-map udpate.

updateVersion

public GridCacheVersion updateVersion()

Returns:

Update version for fast-map request.

topologyVersion

public AffinityTopologyVersion topologyVersion()

Description copied from class: GridCacheMessage

Gets topology version or -1 in case of topology version is not required for this message.

Overrides:

topologyVersion in class GridCacheMessage

Returns:

Topology version.

topologyLocked

public boolean topologyLocked()

Returns:

Topology locked flag.

clientRequest

public boolean clientRequest()

Returns:

True if request sent from client node.

writeSynchronizationMode

public CacheWriteSynchronizationMode writeSynchronizationMode()

Returns:

Cache write synchronization mode.

expiry

public javax.cache.expiry.ExpiryPolicy expiry()

Returns:

Expiry policy.

returnValue

public boolean returnValue()

Returns:

Return value flag.

filter

@Nullable
public CacheEntryPredicate[] filter()

Returns:

Filter.

skipStore

public boolean skipStore()

Returns:

Skip write-through to a persistent storage.

keepBinary

public boolean keepBinary()

Returns:

Keep binary flag.

addUpdateEntry

public void addUpdateEntry(KeyCacheObject key,
                  @Nullable
                  Object val,
                  long conflictTtl,
                  long conflictExpireTime,
                  @Nullable
                  GridCacheVersion conflictVer,
                  boolean primary)

Parameters:

key - Key to add.

val - Optional update value.

conflictTtl - Conflict TTL (optional).

conflictExpireTime - Conflict expire time (optional).

conflictVer - Conflict version (optional).

primary - If given key is primary on this mapping.

keys

public List<KeyCacheObject> keys()

Returns:

Keys for this update request.

values

public List<?> values()

Returns:

Values for this update request.

operation

public GridCacheOperation operation()

Returns:

Update operation.

invokeArguments

@Nullable
public Object[] invokeArguments()

Returns:

Optional arguments for entry processor.

value

public CacheObject value(int idx)

Parameters:

idx - Key index.

Returns:

Value.

entryProcessor

public javax.cache.processor.EntryProcessor<Object,Object,Object> entryProcessor(int idx)

Parameters:

idx - Key index.

Returns:

Entry processor.

writeValue

public CacheObject writeValue(int idx)

Parameters:

idx - Index to get.

Returns:

Write value - either value, or transform closure.

conflictVersions

@Nullable
public List<GridCacheVersion> conflictVersions()

Returns:

Conflict versions.

conflictVersion

@Nullable
public GridCacheVersion conflictVersion(int idx)

Parameters:

idx - Index.

Returns:

Conflict version.

conflictTtl

public long conflictTtl(int idx)

Parameters:

idx - Index.

Returns:

Conflict TTL.

conflictExpireTime

public long conflictExpireTime(int idx)

Parameters:

idx - Index.

Returns:

Conflict expire time.

hasPrimary

public boolean hasPrimary()

Returns:

Flag indicating whether this request contains primary keys.

onResponse

public boolean onResponse(GridNearAtomicUpdateResponse res)

Parameters:

res - Response.

Returns:

True if current response was null.

response

@Nullable
public GridNearAtomicUpdateResponse response()

Returns:

Response.

prepareMarshal

public void prepareMarshal(GridCacheSharedContext ctx)
                    throws IgniteCheckedException

This method is called before the whole message is serialized and is responsible for pre-marshalling state.

Overrides:

prepareMarshal in class GridCacheMessage

Parameters:

ctx -

Throws:

IgniteCheckedException - If failed.

finishUnmarshal

public void finishUnmarshal(GridCacheSharedContext ctx,
                   ClassLoader ldr)
                     throws IgniteCheckedException

This method is called after the message is deserialized and is responsible for unmarshalling state marshalled in GridCacheMessage.prepareMarshal(GridCacheSharedContext) method.

Overrides:

finishUnmarshal in class GridCacheMessage

Parameters:

ctx - Context.

ldr - Class loader.

Throws:

IgniteCheckedException - If failed.

addDeploymentInfo

public boolean addDeploymentInfo()

Deployment enabled flag indicates whether deployment info has to be added to this message.

Specified by:

addDeploymentInfo in class GridCacheMessage

Returns:

true or if deployment info must be added to the the message, false otherwise.

writeTo

public boolean writeTo(ByteBuffer buf,
              MessageWriter writer)

Writes this message to provided byte buffer.

Specified by:

writeTo in interface Message

Overrides:

writeTo in class GridCacheMessage

Parameters:

buf - Byte buffer.

writer - Writer.

Returns:

Whether message was fully written.

readFrom

public boolean readFrom(ByteBuffer buf,
               MessageReader reader)

Reads this message from provided byte buffer.

Specified by:

readFrom in interface Message

Overrides:

readFrom in class GridCacheMessage

Parameters:

buf - Byte buffer.

reader - Reader.

Returns:

Whether message was fully read.

cleanup

public void cleanup(boolean clearKeys)

Cleanup values.

Parameters:

clearKeys - If true clears keys.

directType

public byte directType()

Gets message type.

Specified by:

directType in interface Message

Returns:

Message type.

fieldsCount

public byte fieldsCount()

Gets fields count.

Specified by:

fieldsCount in interface Message

Returns:

Fields count.

toString

public String toString()

Overrides:

toString in class GridCacheMessage