Package org.infinispan.expiration.impl

Class TouchCommand

java.lang.Object

org.infinispan.commands.read.AbstractDataCommand

org.infinispan.expiration.impl.TouchCommand

All Implemented Interfaces:

DataCommand, FlagAffectedCommand, ReplicableCommand, SegmentSpecificCommand, TopologyAffectedCommand, VisitableCommand

public class TouchCommand
extends org.infinispan.commands.read.AbstractDataCommand

This command updates a cache entry's last access timestamp. If eviction is enabled, it will also update the recency information

This command returns a Boolean that is whether this command was able to touch the value or not.

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.commands.VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields

Modifier and Type	Field	Description
static byte	COMMAND_ID

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

key, segment

Constructor Summary

Constructors

Constructor	Description
TouchCommand()
TouchCommand(Object key, int segment, long flagBitSet, boolean touchEvenIfExpired)

Method Summary

Modifier and Type	Method	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.
boolean	isReturnValueExpected()	If true, a return value will be provided when performed remotely.
boolean	isTouchEvenIfExpired()
VisitableCommand.LoadType	loadType()
void	readFrom(ObjectInput input)	Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
void	writeTo(ObjectOutput output)	Writes this instance to the ObjectOutput.

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

equals, getFlagsBitSet, getKey, getSegment, getTopologyId, hashCode, printFlags, setFlagsBitSet, setKey, setTopologyId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.FlagAffectedCommand

addFlag, addFlags, addFlags, getFlags, hasAllFlags, hasAnyFlag, hasFlag, setFlags

Methods inherited from interface org.infinispan.commands.ReplicableCommand

canBlock, invoke, invokeAsync, isSuccessful, logThrowable, setOrigin

Methods inherited from interface org.infinispan.commands.VisitableCommand

init

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

TouchCommand

public TouchCommand()

TouchCommand

public TouchCommand(Object key,
                    int segment,
                    long flagBitSet,
                    boolean touchEvenIfExpired)

Method Detail

getCommandId

public byte getCommandId()

Description copied from interface: ReplicableCommand

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

Returns:

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

isReturnValueExpected

public boolean isReturnValueExpected()

Description copied from interface: ReplicableCommand

If true, a return value will be provided when performed remotely. Otherwise, a remote ResponseGenerator may choose to simply return null to save on marshalling costs.

Specified by:

isReturnValueExpected in interface ReplicableCommand

Overrides:

isReturnValueExpected in class org.infinispan.commands.read.AbstractDataCommand

Returns:

true or false

writeTo

public void writeTo(ObjectOutput output)
             throws IOException

Description copied from interface: ReplicableCommand

Writes this instance to the ObjectOutput.

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

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.

isTouchEvenIfExpired

public boolean isTouchEvenIfExpired()

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.

Parameters:

ctx - invocation context

visitor - visitor to accept

Returns:

arbitrary return value

Throws:

Throwable - in the event of problems

loadType

public VisitableCommand.LoadType loadType()

Returns:

Nodes on which the command needs to read the previous values of the keys it acts on.