org.infinispan.commands.read

Class GetCacheEntryCommand

java.lang.Object

org.infinispan.commands.AbstractLocalFlagAffectedCommand

org.infinispan.commands.AbstractFlagAffectedCommand

org.infinispan.commands.read.AbstractDataCommand

org.infinispan.commands.read.GetCacheEntryCommand

All Implemented Interfaces:

DataCommand, FlagAffectedCommand, LocalFlagAffectedCommand, MetadataAwareCommand, RemoteFetchingCommand, ReplicableCommand, TopologyAffectedCommand, VisitableCommand

public final class GetCacheEntryCommand
extends AbstractDataCommand
implements RemoteFetchingCommand

Used to fetch a full CacheEntry rather than just the value. This functionality was originally incorporated into GetKeyValueCommand.

Since:

7.1

Author:

Sanne Grinovero (C) 2014 Red Hat Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMAND_ID

Fields inherited from class org.infinispan.commands.read.AbstractDataCommand

key

Fields inherited from class org.infinispan.commands.AbstractLocalFlagAffectedCommand

flags

Constructor Summary

Constructors

Constructor and Description
GetCacheEntryCommand()
GetCacheEntryCommand(Object key, Set<Flag> flags, InternalEntryFactory entryFactory)

Method Summary

Modifier and Type	Method and Description
Object	acceptVisitor(InvocationContext ctx, Visitor visitor) Accept a visitor, and return the result of accepting this visitor.
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
InternalCacheEntry	getRemotelyFetchedValue() If the cache needs to go remotely in order to obtain the value associated to this key, then the remote value is stored in this field.
Object	perform(InvocationContext ctx) Performs the primary function of the command.
void	readFrom(ObjectInput input) Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
boolean	readsExistingValues()
void	setRemotelyFetchedValue(InternalCacheEntry remotelyFetchedValue)
String	toString()
void	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

Methods inherited from class org.infinispan.commands.read.AbstractDataCommand

canBlock, equals, getKey, hashCode, ignoreCommandOnStatus, isReturnValueExpected, setKey, shouldInvoke

Methods inherited from class org.infinispan.commands.AbstractFlagAffectedCommand

getMetadata, getTopologyId, setMetadata, setTopologyId

Methods inherited from class org.infinispan.commands.AbstractLocalFlagAffectedCommand

getFlags, setFlags

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.commands.VisitableCommand

alwaysReadsExistingValues

Methods inherited from interface org.infinispan.commands.TopologyAffectedCommand

getTopologyId, setTopologyId

Methods inherited from interface org.infinispan.commands.ReplicableCommand

getParameters, setParameters

Methods inherited from interface org.infinispan.commands.LocalFlagAffectedCommand

addFlag, addFlags, getFlags, hasFlag, setFlags, setFlags

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

GetCacheEntryCommand

public GetCacheEntryCommand(Object key,
                            Set<Flag> flags,
                            InternalEntryFactory entryFactory)

GetCacheEntryCommand

public GetCacheEntryCommand()

Method Detail

acceptVisitor

public Object acceptVisitor(InvocationContext ctx,
                            Visitor visitor)
                     throws Throwable

Description copied from interface: VisitableCommand

Accept a visitor, and return the result of accepting this visitor.

Specified by:

acceptVisitor in interface VisitableCommand

Parameters:

ctx - invocation context

visitor - visitor to accept

Returns:

arbitrary return value

Throws:

Throwable - in the event of problems

readsExistingValues

public boolean readsExistingValues()

Specified by:

readsExistingValues in interface VisitableCommand

Returns:

true if the command needs to read the previous values of the keys it acts on.

perform

public Object perform(InvocationContext ctx)
               throws Throwable

Description copied from interface: ReplicableCommand

Performs the primary function of the command. Please see specific implementation classes for details on what is performed as well as return types. Important: this method will be invoked at the end of interceptors chain. It should never be called directly from a custom interceptor.

Specified by:

perform in interface ReplicableCommand

Parameters:

ctx - invocation context

Returns:

arbitrary return value generated by performing this command

Throws:

Throwable - in the event of problems.

getCommandId

public byte getCommandId()

Description copied from interface: ReplicableCommand

Used by marshallers to convert this command into an id for streaming.

Specified by:

getCommandId in interface ReplicableCommand

Returns:

the method id of this command. This is compatible with pre-2.2.0 MethodCall ids.

setRemotelyFetchedValue

public void setRemotelyFetchedValue(InternalCacheEntry remotelyFetchedValue)

Specified by:

setRemotelyFetchedValue in interface RemoteFetchingCommand

See Also:

getRemotelyFetchedValue()

getRemotelyFetchedValue

public InternalCacheEntry getRemotelyFetchedValue()

If the cache needs to go remotely in order to obtain the value associated to this key, then the remote value is stored in this field. TODO: this method should be able to removed with the refactoring from ISPN-2177

Specified by:

getRemotelyFetchedValue in interface RemoteFetchingCommand

writeTo

public void writeTo(ObjectOutput output)
             throws IOException

Description copied from interface: ReplicableCommand

Writes this instance to the ObjectOutput.

Specified by:

writeTo in interface ReplicableCommand

Parameters:

output - the stream.

Throws:

IOException - if an error occurred during the I/O.

readFrom

public void readFrom(ObjectInput input)
              throws IOException,
                     ClassNotFoundException

Description copied from interface: ReplicableCommand

Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).

Specified by:

readFrom in interface ReplicableCommand

Parameters:

input - the stream to read.

Throws:

IOException - if an error occurred during the I/O.

ClassNotFoundException - if it tries to load an undefined class.

toString

public String toString()

Overrides:

toString in class AbstractDataCommand