org.apache.ignite.internal.processors.cache

Class GridCacheMessage

java.lang.Object

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

All Implemented Interfaces:

Serializable, Message

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
extends Object
implements Message

Parent of all cache messages.

See Also:

Serialized Form

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.

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 ctx, ClassLoader ldr) This method is called after the message is deserialized and is responsible for unmarshalling state marshalled in prepareMarshal(GridCacheSharedContext) method.
protected void	finishUnmarshalCacheObjects(Collection<? extends CacheObject> col, GridCacheContext ctx, ClassLoader ldr)
protected void	finishUnmarshalCacheObjects(List<? extends CacheObject> col, GridCacheContext ctx, ClassLoader ldr)
boolean	ignoreClassErrors()
int	lookupIndex() Gets message lookup index.
protected LinkedHashMap<byte[],Boolean>	marshalBooleanLinkedMap(LinkedHashMap<?,Boolean> map, GridCacheSharedContext ctx)
protected List<byte[]>	marshalCollection(Collection<?> col, GridCacheSharedContext ctx)
protected void	marshalInfo(GridCacheEntryInfo info, GridCacheContext ctx)
protected void	marshalInfos(Iterable<? extends GridCacheEntryInfo> infos, GridCacheContext ctx)
protected byte[][]	marshalInvokeArguments(Object[] args, GridCacheSharedContext ctx)
protected void	marshalTx(Iterable<IgniteTxEntry> txEntries, GridCacheSharedContext 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)
void	prepareMarshal(GridCacheSharedContext ctx) This method is called before the whole message is serialized and is responsible for pre-marshalling state.
protected void	prepareMarshalCacheObjects(Collection<? extends CacheObject> col, GridCacheContext ctx)
protected void	prepareMarshalCacheObjects(List<? extends CacheObject> col, GridCacheContext ctx)
protected void	prepareObject(Object o, GridCacheSharedContext ctx)
boolean	readFrom(ByteBuffer buf, MessageReader reader) 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()
protected boolean	transferExpiryPolicy()
protected <K1> LinkedHashMap<K1,Boolean>	unmarshalBooleanLinkedMap(Map<byte[],Boolean> byteMap, GridCacheSharedContext ctx, ClassLoader ldr)
protected <T> List<T>	unmarshalCollection(Collection<byte[]> byteCol, GridCacheSharedContext ctx, ClassLoader ldr)
protected void	unmarshalInfo(GridCacheEntryInfo info, GridCacheContext ctx, ClassLoader ldr)
protected void	unmarshalInfos(Iterable<? extends GridCacheEntryInfo> infos, GridCacheContext ctx, ClassLoader ldr)
protected Object[]	unmarshalInvokeArguments(byte[][] byteCol, GridCacheSharedContext ctx, ClassLoader ldr)
protected void	unmarshalTx(Iterable<IgniteTxEntry> txEntries, boolean near, GridCacheSharedContext ctx, ClassLoader ldr)
boolean	writeTo(ByteBuffer buf, MessageWriter writer) Writes this message to provided byte buffer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ignite.plugin.extensions.communication.Message

directType, fieldsCount

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.

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.

prepareObject

protected final void prepareObject(@Nullable
                 Object o,
                 GridCacheSharedContext ctx)
                            throws IgniteCheckedException

Parameters:

o - Object to prepare for marshalling.

ctx - 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 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 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 info,
               GridCacheContext ctx)
                          throws IgniteCheckedException

Parameters:

info - Entry to marshal.

ctx - Context.

Throws:

IgniteCheckedException - If failed.

unmarshalInfo

protected final void unmarshalInfo(GridCacheEntryInfo info,
                 GridCacheContext 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> infos,
                GridCacheContext ctx)
                           throws IgniteCheckedException

Parameters:

infos - Entries to marshal.

ctx - Context.

Throws:

IgniteCheckedException - If failed.

unmarshalInfos

protected final void unmarshalInfos(Iterable<? extends GridCacheEntryInfo> infos,
                  GridCacheContext 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> txEntries,
             GridCacheSharedContext 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> txEntries,
               boolean near,
               GridCacheSharedContext 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 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 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 ctx)
                                  throws IgniteCheckedException

Parameters:

col - Collection to marshal.

ctx - Context.

Returns:

Marshalled collection.

Throws:

IgniteCheckedException - If failed.

prepareMarshalCacheObjects

protected final void prepareMarshalCacheObjects(@Nullable
                              List<? extends CacheObject> col,
                              GridCacheContext ctx)
                                         throws IgniteCheckedException

Parameters:

col - Collection.

ctx - Cache context.

Throws:

IgniteCheckedException - If failed.

prepareMarshalCacheObjects

protected final void prepareMarshalCacheObjects(@Nullable
                              Collection<? extends CacheObject> col,
                              GridCacheContext ctx)
                                         throws IgniteCheckedException

Parameters:

col - Collection.

ctx - Cache context.

Throws:

IgniteCheckedException - If failed.

finishUnmarshalCacheObjects

protected final void finishUnmarshalCacheObjects(@Nullable
                               List<? extends CacheObject> col,
                               GridCacheContext ctx,
                               ClassLoader ldr)
                                          throws IgniteCheckedException

Parameters:

col - Collection.

ctx - Context.

ldr - Class loader.

Throws:

IgniteCheckedException - If failed.

finishUnmarshalCacheObjects

protected final void finishUnmarshalCacheObjects(@Nullable
                               Collection<? extends CacheObject> col,
                               GridCacheContext ctx,
                               ClassLoader ldr)
                                          throws IgniteCheckedException

Parameters:

col - Collection.

ctx - Context.

ldr - Class loader.

Throws:

IgniteCheckedException - If failed.

unmarshalCollection

@Nullable
protected <T> List<T> unmarshalCollection(@Nullable
                                       Collection<byte[]> byteCol,
                                       GridCacheSharedContext 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 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 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 interface Message

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

Parameters:

buf - Byte buffer.

reader - Reader.

Returns:

Whether message was fully read.

toString

public String toString()

Overrides:

toString in class Object