org.infinispan.commands.write

Class InvalidateL1Command

java.lang.Object

org.infinispan.commands.AbstractLocalFlagAffectedCommand

org.infinispan.commands.AbstractFlagAffectedCommand

org.infinispan.commands.read.AbstractDataCommand

org.infinispan.commands.write.AbstractDataWriteCommand

org.infinispan.commands.write.RemoveCommand

org.infinispan.commands.write.InvalidateCommand

org.infinispan.commands.write.InvalidateL1Command

All Implemented Interfaces:

DataCommand, FlagAffectedCommand, LocalFlagAffectedCommand, MetadataAwareCommand, ReplicableCommand, TopologyAffectedCommand, VisitableCommand, DataWriteCommand, WriteCommand, RemoteLockCommand

public class InvalidateL1Command
extends InvalidateCommand

Invalidates an entry in a L1 cache (used with DIST mode)

Since:

4.0

Author:

Manik Surtani, Mircea.Markus@jboss.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMAND_ID

Fields inherited from class org.infinispan.commands.write.InvalidateCommand

keys

Fields inherited from class org.infinispan.commands.write.RemoveCommand

notifier, value, valueEquivalence, valueMatcher

Fields inherited from class org.infinispan.commands.write.AbstractDataWriteCommand

commandInvocationId

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
InvalidateL1Command()
InvalidateL1Command(Address writeOrigin, DataContainer dc, DistributionManager dm, CacheNotifier notifier, Set<Flag> flags, Collection<Object> keys, CommandInvocationId commandInvocationId)
InvalidateL1Command(DataContainer dc, DistributionManager dm, CacheNotifier notifier, Set<Flag> flags, Collection<Object> keys, CommandInvocationId commandInvocationId)
InvalidateL1Command(DataContainer dc, DistributionManager dm, CacheNotifier notifier, Set<Flag> flags, CommandInvocationId commandInvocationId, Object... keys)

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.
Collection<Object>	getKeysToLock() It returns a Collection with the keys to be lock.
void	init(Configuration config, DistributionManager dm, CacheNotifier n, DataContainer dc)
boolean	isCausedByALocalWrite(Address address) Returns true if the write that caused the invalidation was performed on this node.
Object	perform(InvocationContext ctx) Performs an invalidation on a specified entry
void	readFrom(ObjectInput input) Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
void	setKeys(Object[] keys)
boolean	shouldInvoke(InvocationContext ctx) Used by the InboundInvocationHandler to determine whether the command should be invoked or not.
String	toString()
void	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

Methods inherited from class org.infinispan.commands.write.InvalidateCommand

equals, getAffectedKeys, getKey, getKeys, hashCode, ignoreCommandOnStatus, invalidate, notify, readsExistingValues

Methods inherited from class org.infinispan.commands.write.RemoveCommand

getValue, getValueMatcher, init, isConditional, isNonExistent, isReturnValueExpected, isSuccessful, performRemove, setValue, setValueMatcher, updateStatusFromRemoteResponse

Methods inherited from class org.infinispan.commands.write.AbstractDataWriteCommand

canBlock, getKeyLockOwner, hasSkipLocking, hasZeroLockAcquisition

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

setKey

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.write.WriteCommand

isWriteOnly

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

getMetadata, setMetadata

Methods inherited from interface org.infinispan.commands.LocalFlagAffectedCommand

addFlag, addFlags, getFlags, hasFlag, setFlags, setFlags

Field Detail

COMMAND_ID

public static final int COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

InvalidateL1Command

public InvalidateL1Command()

InvalidateL1Command

public InvalidateL1Command(DataContainer dc,
                           DistributionManager dm,
                           CacheNotifier notifier,
                           Set<Flag> flags,
                           CommandInvocationId commandInvocationId,
                           Object... keys)

InvalidateL1Command

public InvalidateL1Command(DataContainer dc,
                           DistributionManager dm,
                           CacheNotifier notifier,
                           Set<Flag> flags,
                           Collection<Object> keys,
                           CommandInvocationId commandInvocationId)

InvalidateL1Command

public InvalidateL1Command(Address writeOrigin,
                           DataContainer dc,
                           DistributionManager dm,
                           CacheNotifier notifier,
                           Set<Flag> flags,
                           Collection<Object> keys,
                           CommandInvocationId commandInvocationId)

Method Detail

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

Overrides:

getCommandId in class InvalidateCommand

Returns:

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

init

public void init(Configuration config,
                 DistributionManager dm,
                 CacheNotifier n,
                 DataContainer dc)

perform

public Object perform(InvocationContext ctx)
               throws Throwable

Description copied from class: InvalidateCommand

Performs an invalidation on a specified entry

Specified by:

perform in interface ReplicableCommand

Overrides:

perform in class InvalidateCommand

Parameters:

ctx - invocation context

Returns:

null

Throws:

Throwable - in the event of problems.

setKeys

public void setKeys(Object[] keys)

shouldInvoke

public boolean shouldInvoke(InvocationContext ctx)

Description copied from interface: VisitableCommand

Used by the InboundInvocationHandler to determine whether the command should be invoked or not.

Specified by:

shouldInvoke in interface VisitableCommand

Overrides:

shouldInvoke in class AbstractDataCommand

Returns:

true if the command should be invoked, false otherwise.

getKeysToLock

public Collection<Object> getKeysToLock()

Description copied from interface: RemoteLockCommand

It returns a Collection with the keys to be lock.

It may return an empty collection if no keys needs to be locked independently of the return value of RemoteLockCommand.hasSkipLocking(). It may contains duplicated keys and null is not a valid return value.

Specified by:

getKeysToLock in interface RemoteLockCommand

Overrides:

getKeysToLock in class InvalidateCommand

Returns:

a Collection of keys to lock.

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

Overrides:

writeTo in class InvalidateCommand

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

Overrides:

readFrom in class InvalidateCommand

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.

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

Overrides:

acceptVisitor in class InvalidateCommand

Parameters:

ctx - invocation context

visitor - visitor to accept

Returns:

arbitrary return value

Throws:

Throwable - in the event of problems

toString

public String toString()

Overrides:

toString in class InvalidateCommand

isCausedByALocalWrite

public boolean isCausedByALocalWrite(Address address)

Returns true if the write that caused the invalidation was performed on this node. More formal, if a put(k) happens on node A and ch(A)={B}, then an invalidation message might be multicasted by B to all cluster members including A. This method returns true if and only if the node where it is invoked is A.