org.infinispan.commands.write

Class InvalidateCommand

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

All Implemented Interfaces:

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

Direct Known Subclasses:

InvalidateL1Command

public class InvalidateCommand
extends RemoveCommand

Removes an entry from memory.

Since:

4.0

Author:

Mircea.Markus@jboss.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMAND_ID
protected Object[]	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
InvalidateCommand()
InvalidateCommand(CacheNotifier notifier, Set<Flag> flags, Collection<Object> keys, CommandInvocationId commandInvocationId)
InvalidateCommand(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.
boolean	equals(Object o)
Set<Object>	getAffectedKeys()
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
Object	getKey()
Object[]	getKeys()
Collection<Object>	getKeysToLock() It returns a Collection with the keys to be lock.
int	hashCode()
boolean	ignoreCommandOnStatus(ComponentStatus status) Similar to VisitableCommand.shouldInvoke(InvocationContext) but evaluated by InvocationContextInterceptor.
protected void	invalidate(InvocationContext ctx, Object keyToInvalidate)
void	notify(InvocationContext ctx, Object removedValue, Metadata removedMetadata, boolean isPre)
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).
boolean	readsExistingValues()
String	toString()
void	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

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

isWriteOnly

Methods inherited from interface org.infinispan.commands.VisitableCommand

alwaysReadsExistingValues, shouldInvoke

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

keys

protected Object[] keys

Constructor Detail

InvalidateCommand

public InvalidateCommand()

InvalidateCommand

public InvalidateCommand(CacheNotifier notifier,
                         Set<Flag> flags,
                         CommandInvocationId commandInvocationId,
                         Object... keys)

InvalidateCommand

public InvalidateCommand(CacheNotifier notifier,
                         Set<Flag> flags,
                         Collection<Object> keys,
                         CommandInvocationId commandInvocationId)

Method Detail

perform

public Object perform(InvocationContext ctx)
               throws Throwable

Performs an invalidation on a specified entry

Specified by:

perform in interface ReplicableCommand

Overrides:

perform in class RemoveCommand

Parameters:

ctx - invocation context

Returns:

null

Throws:

Throwable - in the event of problems.

invalidate

protected void invalidate(InvocationContext ctx,
                          Object keyToInvalidate)
                   throws Throwable

Throws:

Throwable

notify

public void notify(InvocationContext ctx,
                   Object removedValue,
                   Metadata removedMetadata,
                   boolean isPre)

Overrides:

notify in class RemoveCommand

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 RemoveCommand

Returns:

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

toString

public String toString()

Overrides:

toString in class RemoveCommand

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 RemoveCommand

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 RemoveCommand

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 RemoveCommand

Parameters:

ctx - invocation context

visitor - visitor to accept

Returns:

arbitrary return value

Throws:

Throwable - in the event of problems

getKey

public Object getKey()

Specified by:

getKey in interface DataCommand

Overrides:

getKey in class AbstractDataCommand

getKeys

public Object[] getKeys()

getAffectedKeys

public Set<Object> getAffectedKeys()

Specified by:

getAffectedKeys in interface WriteCommand

Overrides:

getAffectedKeys in class AbstractDataWriteCommand

Returns:

a collection of keys affected by this write command. Some commands - such as ClearCommand - may return an empty collection for this method.

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 AbstractDataWriteCommand

Returns:

a Collection of keys to lock.

ignoreCommandOnStatus

public boolean ignoreCommandOnStatus(ComponentStatus status)

Description copied from interface: VisitableCommand

Similar to VisitableCommand.shouldInvoke(InvocationContext) but evaluated by InvocationContextInterceptor. Commands can opt to be discarded in case the cache status is not suited (as InvalidateCommand)

Specified by:

ignoreCommandOnStatus in interface VisitableCommand

Overrides:

ignoreCommandOnStatus in class RemoveCommand

Returns:

true if the command should NOT be invoked.

readsExistingValues

public boolean readsExistingValues()

Specified by:

readsExistingValues in interface VisitableCommand

Overrides:

readsExistingValues in class RemoveCommand

Returns:

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

equals

public boolean equals(Object o)

Overrides:

equals in class RemoveCommand

hashCode

public int hashCode()

Overrides:

hashCode in class RemoveCommand