org.apache.ignite.internal.processors.cache

Class GridCacheMessage<K,V>

java.lang.Object

org.apache.ignite.plugin.extensions.communication.MessageAdapter

org.apache.ignite.internal.processors.cache.GridCacheMessage<K,V>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GridCacheEvictionRequest, GridCacheEvictionResponse, GridCacheQueryRequest, GridCacheQueryResponse, GridCacheTtlUpdateRequest, GridDhtAffinityAssignmentRequest, GridDhtAffinityAssignmentResponse, GridDhtAtomicDeferredUpdateResponse, GridDhtAtomicUpdateRequest, GridDhtAtomicUpdateResponse, GridDhtForceKeysRequest, GridDhtForceKeysResponse, GridDhtPartitionDemandMessage, GridDhtPartitionsFullMessage, GridDhtPartitionsSingleMessage, GridDhtPartitionsSingleRequest, GridDhtPartitionSupplyMessage, GridDistributedBaseMessage, GridDistributedTxFinishResponse, GridNearAtomicUpdateRequest, GridNearAtomicUpdateResponse, GridNearGetRequest, GridNearGetResponse

public abstract class GridCacheMessage<K,V>
extends MessageAdapter

Parent of all cache messages.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ignite.plugin.extensions.communication.MessageAdapter

MessageAdapter.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_MSG_INDEX_FIELD_NAME Cache message index field name.
protected int	cacheId Cache ID.
static int	MAX_CACHE_MSG_LOOKUP_INDEX Maximum number of cache lookup indexes.

Fields inherited from class org.apache.ignite.plugin.extensions.communication.MessageAdapter

reader, readState

Constructor Summary

Constructors

Constructor and Description
GridCacheMessage()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowForStartup()
int	cacheId()
void	cacheId(int cacheId)
Exception	classError()
GridDeploymentInfo	deployInfo()
void	finishUnmarshal(GridCacheSharedContext<K,V> ctx, ClassLoader ldr) This method is called after the message is deserialized and is responsible for unmarshalling state marshalled in prepareMarshal(GridCacheSharedContext) method.
boolean	ignoreClassErrors()
int	lookupIndex() Gets message lookup index.
protected LinkedHashMap<byte[],Boolean>	marshalBooleanLinkedMap(LinkedHashMap<?,Boolean> map, GridCacheSharedContext<K,V> ctx)
protected List<byte[]>	marshalCollection(Collection<?> col, GridCacheSharedContext<K,V> ctx)
protected <T> byte[][]	marshalFilter(IgnitePredicate<javax.cache.Cache.Entry<K,V>>[] filter, GridCacheSharedContext<K,V> ctx)
protected void	marshalInfo(GridCacheEntryInfo<K,V> info, GridCacheSharedContext<K,V> ctx)
protected void	marshalInfos(Iterable<? extends GridCacheEntryInfo<K,V>> infos, GridCacheSharedContext<K,V> ctx)
protected byte[][]	marshalInvokeArguments(Object[] args, GridCacheSharedContext<K,V> ctx)
protected void	marshalTx(Iterable<IgniteTxEntry<K,V>> txEntries, GridCacheSharedContext<K,V> ctx)
protected List<GridCacheValueBytes>	marshalValuesCollection(Collection<?> col, GridCacheSharedContext<K,V> ctx)
long	messageId()
static int	nextIndexId() Gets next ID for indexed message ID.
void	onClassError(Exception err) If class loading error occurred during unmarshalling and ignoreClassErrors() is set to true, then the error will be passed into this method.
void	prepare(GridDeploymentInfo depInfo)
protected void	prepareFilter(IgnitePredicate<javax.cache.Cache.Entry<K,V>>[] filters, GridCacheSharedContext<K,V> ctx)
void	prepareMarshal(GridCacheSharedContext<K,V> ctx) This method is called before the whole message is serialized and is responsible for pre-marshalling state.
protected void	prepareObject(Object o, GridCacheSharedContext<K,V> ctx)
protected void	prepareObjects(Iterable<?> col, GridCacheSharedContext<K,V> ctx)
boolean	readFrom(ByteBuffer buf) Reads this message from provided byte buffer.
long	topologyVersion() Gets topology version or -1 in case of topology version is not required for this message.
String	toString()
boolean	transactional()
protected boolean	transferExpiryPolicy()
protected <K1> LinkedHashMap<K1,Boolean>	unmarshalBooleanLinkedMap(Map<byte[],Boolean> byteMap, GridCacheSharedContext<K,V> ctx, ClassLoader ldr)
protected <T> List<T>	unmarshalCollection(Collection<byte[]> byteCol, GridCacheSharedContext<K,V> ctx, ClassLoader ldr)
protected <T> IgnitePredicate<javax.cache.Cache.Entry<K,V>>[]	unmarshalFilter(byte[][] byteCol, GridCacheSharedContext<K,V> ctx, ClassLoader ldr)
protected void	unmarshalInfo(GridCacheEntryInfo<K,V> info, GridCacheContext<K,V> ctx, ClassLoader ldr)
protected void	unmarshalInfos(Iterable<? extends GridCacheEntryInfo<K,V>> infos, GridCacheContext<K,V> ctx, ClassLoader ldr)
protected Object[]	unmarshalInvokeArguments(byte[][] byteCol, GridCacheSharedContext<K,V> ctx, ClassLoader ldr)
protected void	unmarshalTx(Iterable<IgniteTxEntry<K,V>> txEntries, boolean near, GridCacheSharedContext<K,V> ctx, ClassLoader ldr)
protected <T> List<T>	unmarshalValueBytesCollection(Collection<GridCacheValueBytes> byteCol, GridCacheSharedContext<K,V> ctx, ClassLoader ldr)
boolean	writeTo(ByteBuffer buf, MessageWriter writer) Writes this message to provided byte buffer.

Methods inherited from class org.apache.ignite.plugin.extensions.communication.MessageAdapter

directType, setReader, skipRecovery

Methods inherited from class java.lang.Object

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

Field Detail

MAX_CACHE_MSG_LOOKUP_INDEX

public static final int MAX_CACHE_MSG_LOOKUP_INDEX

Maximum number of cache lookup indexes.

See Also:

Constant Field Values

CACHE_MSG_INDEX_FIELD_NAME

public static final String CACHE_MSG_INDEX_FIELD_NAME

Cache message index field name.

See Also:

Constant Field Values

cacheId

protected int cacheId

Cache ID.

Constructor Detail

GridCacheMessage

public GridCacheMessage()

Method Detail

nextIndexId

public static int nextIndexId()

Gets next ID for indexed message ID.

Returns:

Message ID.

allowForStartup

public boolean allowForStartup()

Returns:

True if this message is preloader message.

transactional

public boolean transactional()

Returns:

If this is a transactional message.

ignoreClassErrors

public boolean ignoreClassErrors()

Returns:

True if class loading errors should be ignored, false otherwise.

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 MAX_CACHE_MSG_LOOKUP_INDEX.

Returns:

Message lookup index.

onClassError

public void onClassError(Exception err)

If class loading error occurred during unmarshalling and ignoreClassErrors() is set to true, then the error will be passed into this method.

Parameters:

err - Error.

classError

public Exception classError()

Returns:

Error set via onClassError(Exception) method.

messageId

public long messageId()

Returns:

Message ID.

cacheId

public int cacheId()

Returns:

Cache ID.

cacheId

public void cacheId(int cacheId)

Parameters:

cacheId - Cache ID.

topologyVersion

public long topologyVersion()

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

Returns:

Topology version.

prepareFilter

protected final void prepareFilter(@Nullable
                 IgnitePredicate<javax.cache.Cache.Entry<K,V>>[] filters,
                 GridCacheSharedContext<K,V> ctx)
                            throws IgniteCheckedException

Parameters:

filters - Predicate filters.

ctx - Context.

Throws:

IgniteCheckedException - If failed.

prepareObject

protected final void prepareObject(@Nullable
                 Object o,
                 GridCacheSharedContext<K,V> ctx)
                            throws IgniteCheckedException

Parameters:

o - Object to prepare for marshalling.

ctx - Context.

Throws:

IgniteCheckedException - If failed.

prepareObjects

protected final void prepareObjects(@Nullable
                  Iterable<?> col,
                  GridCacheSharedContext<K,V> ctx)
                             throws IgniteCheckedException

Parameters:

col - Collection of objects to prepare for marshalling.

ctx - Cache context.

Throws:

IgniteCheckedException - If failed.

prepare

public final void prepare(GridDeploymentInfo depInfo)

Parameters:

depInfo - Deployment to set.

See Also:

GridCacheDeployable.prepare(GridDeploymentInfo)

deployInfo

public GridDeploymentInfo deployInfo()

Returns:

Preset deployment info.

See Also:

GridCacheDeployable.deployInfo()

prepareMarshal

public void prepareMarshal(GridCacheSharedContext<K,V> ctx)
                    throws IgniteCheckedException

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

Parameters:

ctx - Cache context.

Throws:

IgniteCheckedException - If failed.

finishUnmarshal

public void finishUnmarshal(GridCacheSharedContext<K,V> ctx,
                   ClassLoader ldr)
                     throws IgniteCheckedException

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

Parameters:

ctx - Context.

ldr - Class loader.

Throws:

IgniteCheckedException - If failed.

marshalInfo

protected final void marshalInfo(GridCacheEntryInfo<K,V> info,
               GridCacheSharedContext<K,V> ctx)
                          throws IgniteCheckedException

Parameters:

info - Entry to marshal.

ctx - Context.

Throws:

IgniteCheckedException - If failed.

unmarshalInfo

protected final void unmarshalInfo(GridCacheEntryInfo<K,V> info,
                 GridCacheContext<K,V> ctx,
                 ClassLoader ldr)
                            throws IgniteCheckedException

Parameters:

info - Entry to unmarshal.

ctx - Context.

ldr - Loader.

Throws:

IgniteCheckedException - If failed.

marshalInfos

protected final void marshalInfos(Iterable<? extends GridCacheEntryInfo<K,V>> infos,
                GridCacheSharedContext<K,V> ctx)
                           throws IgniteCheckedException

Parameters:

infos - Entries to marshal.

ctx - Context.

Throws:

IgniteCheckedException - If failed.

unmarshalInfos

protected final void unmarshalInfos(Iterable<? extends GridCacheEntryInfo<K,V>> infos,
                  GridCacheContext<K,V> ctx,
                  ClassLoader ldr)
                             throws IgniteCheckedException

Parameters:

infos - Entries to unmarshal.

ctx - Context.

ldr - Loader.

Throws:

IgniteCheckedException - If failed.

marshalTx

protected final void marshalTx(Iterable<IgniteTxEntry<K,V>> txEntries,
             GridCacheSharedContext<K,V> ctx)
                        throws IgniteCheckedException

Parameters:

txEntries - Entries to marshal.

ctx - Context.

Throws:

IgniteCheckedException - If failed.

transferExpiryPolicy

protected boolean transferExpiryPolicy()

Returns:

True if entries expire policy should be marshalled.

unmarshalTx

protected final void unmarshalTx(Iterable<IgniteTxEntry<K,V>> txEntries,
               boolean near,
               GridCacheSharedContext<K,V> ctx,
               ClassLoader ldr)
                          throws IgniteCheckedException

Parameters:

txEntries - Entries to unmarshal.

ctx - Context.

ldr - Loader.

Throws:

IgniteCheckedException - If failed.

marshalInvokeArguments

@Nullable
protected final byte[][] marshalInvokeArguments(@Nullable
                                       Object[] args,
                                       GridCacheSharedContext<K,V> ctx)
                                         throws IgniteCheckedException

Parameters:

args - Arguments to marshal.

ctx - Context.

Returns:

Marshalled collection.

Throws:

IgniteCheckedException - If failed.

unmarshalInvokeArguments

@Nullable
protected final Object[] unmarshalInvokeArguments(@Nullable
                                         byte[][] byteCol,
                                         GridCacheSharedContext<K,V> ctx,
                                         ClassLoader ldr)
                                           throws IgniteCheckedException

Parameters:

byteCol - Collection to unmarshal.

ctx - Context.

ldr - Loader.

Returns:

Unmarshalled collection.

Throws:

IgniteCheckedException - If failed.

marshalFilter

@Nullable
protected final <T> byte[][] marshalFilter(@Nullable
                                  IgnitePredicate<javax.cache.Cache.Entry<K,V>>[] filter,
                                  GridCacheSharedContext<K,V> ctx)
                                throws IgniteCheckedException

Parameters:

filter - Collection to marshal.

ctx - Context.

Returns:

Marshalled collection.

Throws:

IgniteCheckedException - If failed.

unmarshalFilter

@Nullable
protected final <T> IgnitePredicate<javax.cache.Cache.Entry<K,V>>[] unmarshalFilter(@Nullable
                                                                           byte[][] byteCol,
                                                                           GridCacheSharedContext<K,V> ctx,
                                                                           ClassLoader ldr)
                                                                         throws IgniteCheckedException

Parameters:

byteCol - Collection to unmarshal.

ctx - Context.

ldr - Loader.

Returns:

Unmarshalled collection.

Throws:

IgniteCheckedException - If failed.

marshalValuesCollection

@Nullable
protected List<GridCacheValueBytes> marshalValuesCollection(@Nullable
                                                         Collection<?> col,
                                                         GridCacheSharedContext<K,V> ctx)
                                                     throws IgniteCheckedException

Parameters:

col - Values collection to marshal.

ctx - Context.

Returns:

Marshaled collection.

Throws:

IgniteCheckedException - If failed.

unmarshalValueBytesCollection

@Nullable
protected <T> List<T> unmarshalValueBytesCollection(@Nullable
                                                 Collection<GridCacheValueBytes> byteCol,
                                                 GridCacheSharedContext<K,V> ctx,
                                                 ClassLoader ldr)
                                         throws IgniteCheckedException

Parameters:

byteCol - Collection to unmarshal.

ctx - Context.

ldr - Loader.

Returns:

Unmarshalled collection.

Throws:

IgniteCheckedException - If failed.

marshalCollection

@Nullable
protected List<byte[]> marshalCollection(@Nullable
                                      Collection<?> col,
                                      GridCacheSharedContext<K,V> ctx)
                                  throws IgniteCheckedException

Parameters:

col - Collection to marshal.

ctx - Context.

Returns:

Marshalled collection.

Throws:

IgniteCheckedException - If failed.

unmarshalCollection

@Nullable
protected <T> List<T> unmarshalCollection(@Nullable
                                       Collection<byte[]> byteCol,
                                       GridCacheSharedContext<K,V> ctx,
                                       ClassLoader ldr)
                               throws IgniteCheckedException

Parameters:

byteCol - Collection to unmarshal.

ctx - Context.

ldr - Loader.

Returns:

Unmarshalled collection.

Throws:

IgniteCheckedException - If failed.

marshalBooleanLinkedMap

@Nullable
protected final LinkedHashMap<byte[],Boolean> marshalBooleanLinkedMap(@Nullable
                                                             LinkedHashMap<?,Boolean> map,
                                                             GridCacheSharedContext<K,V> ctx)
                                                               throws IgniteCheckedException

Parameters:

map - Map to marshal.

ctx - Context.

Returns:

Marshalled map.

Throws:

IgniteCheckedException - If failed.

unmarshalBooleanLinkedMap

@Nullable
protected final <K1> LinkedHashMap<K1,Boolean> unmarshalBooleanLinkedMap(@Nullable
                                                                Map<byte[],Boolean> byteMap,
                                                                GridCacheSharedContext<K,V> ctx,
                                                                ClassLoader ldr)
                                                             throws IgniteCheckedException

Parameters:

byteMap - Map to unmarshal.

ctx - Context.

ldr - Loader.

Returns:

Unmarshalled map.

Throws:

IgniteCheckedException - If failed.

writeTo

public boolean writeTo(ByteBuffer buf,
              MessageWriter writer)

Writes this message to provided byte buffer.

Specified by:

writeTo in class MessageAdapter

Parameters:

buf - Byte buffer.

writer - Writer.

Returns:

Whether message was fully written.

readFrom

public boolean readFrom(ByteBuffer buf)

Reads this message from provided byte buffer.

Specified by:

readFrom in class MessageAdapter

Parameters:

buf - Byte buffer.

Returns:

Whether message was fully read.

toString

public String toString()

Overrides:

toString in class Object