Package org.infinispan.commands.write
Class InvalidateCommand
java.lang.Object
org.infinispan.commands.AbstractFlagAffectedCommand
org.infinispan.commands.AbstractTopologyAffectedCommand
org.infinispan.commands.write.InvalidateCommand
- All Implemented Interfaces:
FlagAffectedCommand
,ReplicableCommand
,TopologyAffectedCommand
,VisitableCommand
,WriteCommand
,RemoteLockCommand
- Direct Known Subclasses:
InvalidateL1Command
public class InvalidateCommand
extends AbstractTopologyAffectedCommand
implements WriteCommand, RemoteLockCommand
Removes an entry from memory.
- Since:
- 4.0
- Author:
- [email protected]
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.infinispan.commands.VisitableCommand
VisitableCommand.LoadType
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
protected CommandInvocationId
protected Object[]
-
Constructor Summary
ConstructorDescriptionInvalidateCommand
(long flagsBitSet, Collection<Object> keys, CommandInvocationId commandInvocationId) InvalidateCommand
(long flagsBitSet, CommandInvocationId commandInvocationId, Object... keys) -
Method Summary
Modifier and TypeMethodDescriptionacceptVisitor
(InvocationContext ctx, Visitor visitor) Accept a visitor, and return the result of accepting this visitor.boolean
void
fail()
Make subsequent invocations ofWriteCommand.isSuccessful()
returnfalse
.Collection
<?> byte
Used by marshallers to convert this command into an id for streaming.It returns the lock owner of the key.Object[]
getKeys()
Collection
<?> It returns aCollection
with the keys to be lock.int
hashCode()
boolean
It checks if this command should acquire locks.boolean
boolean
Certain commands only work based on a certain condition or state of the cache.boolean
If true, a return value will be provided when performed remotely.boolean
Some commands may want to provide information on whether the command was successful or not.loadType()
void
readFrom
(ObjectInput input) Reads this instance from the stream written byReplicableCommand.writeTo(ObjectOutput)
.void
setInternalMetadata
(Object key, PrivateMetadata internalMetadata) void
setValueMatcher
(ValueMatcher valueMatcher) toString()
void
writeTo
(ObjectOutput output) Writes this instance to theObjectOutput
.Methods inherited from class org.infinispan.commands.AbstractTopologyAffectedCommand
getTopologyId, setTopologyId
Methods inherited from class org.infinispan.commands.AbstractFlagAffectedCommand
getFlagsBitSet, hasSameFlags, printFlags, setFlagsBitSet
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, getFlagsBitSet, hasAllFlags, hasAnyFlag, hasFlag, setFlags, setFlagsBitSet
Methods inherited from interface org.infinispan.commands.ReplicableCommand
canBlock, invoke, invokeAsync, logThrowable, setOrigin
Methods inherited from interface org.infinispan.commands.TopologyAffectedCommand
getTopologyId, setTopologyId
Methods inherited from interface org.infinispan.commands.VisitableCommand
init
Methods inherited from interface org.infinispan.commands.write.WriteCommand
isWriteOnly, updateStatusFromRemoteResponse
-
Field Details
-
COMMAND_ID
public static final int COMMAND_ID- See Also:
-
keys
-
commandInvocationId
-
-
Constructor Details
-
InvalidateCommand
public InvalidateCommand() -
InvalidateCommand
-
InvalidateCommand
public InvalidateCommand(long flagsBitSet, Collection<Object> keys, CommandInvocationId commandInvocationId)
-
-
Method Details
-
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 interfaceReplicableCommand
- 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 remoteResponseGenerator
may choose to simply return null to save on marshalling costs.- Specified by:
isReturnValueExpected
in interfaceReplicableCommand
- Returns:
- true or false
-
toString
-
writeTo
Description copied from interface:ReplicableCommand
Writes this instance to theObjectOutput
.- Specified by:
writeTo
in interfaceReplicableCommand
- Parameters:
output
- the stream.- Throws:
IOException
- if an error occurred during the I/O.
-
readFrom
Description copied from interface:ReplicableCommand
Reads this instance from the stream written byReplicableCommand.writeTo(ObjectOutput)
.- Specified by:
readFrom
in interfaceReplicableCommand
- 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
Description copied from interface:VisitableCommand
Accept a visitor, and return the result of accepting this visitor.- Specified by:
acceptVisitor
in interfaceVisitableCommand
- Parameters:
ctx
- invocation contextvisitor
- visitor to accept- Returns:
- arbitrary return value
- Throws:
Throwable
- in the event of problems
-
getKeys
-
isSuccessful
public boolean isSuccessful()Description copied from interface:WriteCommand
Some commands may want to provide information on whether the command was successful or not. This is different from a failure, which usually would result in an exception being thrown. An example is a putIfAbsent() not doing anything because the key in question was present. This would result in a isSuccessful() call returning false.- Specified by:
isSuccessful
in interfaceReplicableCommand
- Specified by:
isSuccessful
in interfaceWriteCommand
- Returns:
- true if the command completed successfully, false otherwise.
-
isConditional
public boolean isConditional()Description copied from interface:WriteCommand
Certain commands only work based on a certain condition or state of the cache. For example,ConcurrentMap.putIfAbsent(Object, Object)
only does anything if a condition is met, i.e., the entry in question is not already present. This method tests whether the command in question is conditional or not.- Specified by:
isConditional
in interfaceWriteCommand
- Returns:
- true if the command is conditional, false otherwise
-
getValueMatcher
- Specified by:
getValueMatcher
in interfaceWriteCommand
- Returns:
- The current value matching policy.
-
setValueMatcher
- Specified by:
setValueMatcher
in interfaceWriteCommand
- Parameters:
valueMatcher
- The new value matching policy.
-
getAffectedKeys
- Specified by:
getAffectedKeys
in interfaceWriteCommand
- Returns:
- a collection of keys affected by this write command. Some commands - such as ClearCommand - may return an empty collection for this method.
-
fail
public void fail()Description copied from interface:WriteCommand
Make subsequent invocations ofWriteCommand.isSuccessful()
returnfalse
.- Specified by:
fail
in interfaceWriteCommand
-
getCommandInvocationId
- Specified by:
getCommandInvocationId
in interfaceWriteCommand
- Returns:
- the
CommandInvocationId
associated to the command.
-
getInternalMetadata
- Specified by:
getInternalMetadata
in interfaceWriteCommand
-
setInternalMetadata
- Specified by:
setInternalMetadata
in interfaceWriteCommand
-
getKeysToLock
Description copied from interface:RemoteLockCommand
It returns aCollection
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 andnull
is not a valid return value.- Specified by:
getKeysToLock
in interfaceRemoteLockCommand
- Returns:
- a
Collection
of keys to lock.
-
getKeyLockOwner
Description copied from interface:RemoteLockCommand
It returns the lock owner of the key.Usually, in transaction caches it is the
GlobalTransaction
and in non-transactional caches theCommandInvocationId
.- Specified by:
getKeyLockOwner
in interfaceRemoteLockCommand
- Returns:
- the lock owner of the key.
-
hasZeroLockAcquisition
public boolean hasZeroLockAcquisition()- Specified by:
hasZeroLockAcquisition
in interfaceRemoteLockCommand
- Returns:
- it the locks should be acquire with 0 (zero) acquisition timeout.
-
hasSkipLocking
public boolean hasSkipLocking()Description copied from interface:RemoteLockCommand
It checks if this command should acquire locks.- Specified by:
hasSkipLocking
in interfaceRemoteLockCommand
- Returns:
true
if locks should be acquired for the keys inRemoteLockCommand.getKeysToLock()
.
-
loadType
- Specified by:
loadType
in interfaceVisitableCommand
- Returns:
- Nodes on which the command needs to read the previous values of the keys it acts on.
-
equals
-
hashCode
public int hashCode()
-