org.infinispan.commands.write

Class RemoveExpiredCommand

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

All Implemented Interfaces:

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

public class RemoveExpiredCommand
extends RemoveCommand

Removes an entry that is expired from memory

Since:

8.0

Author:

William Burns

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMAND_ID
protected Long	lifespan
protected TimeService	timeService

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
RemoveExpiredCommand()
RemoveExpiredCommand(Object key, Object value, Long lifespan, CacheNotifier notifier, Equivalence valueEquivalence, TimeService timeService, CommandInvocationId commandInvocationId)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
Set<Flag>	getFlags()
boolean	hasFlag(Flag flag) Check whether a particular flag is present in the command
int	hashCode()
boolean	ignoreCommandOnStatus(ComponentStatus status) Similar to VisitableCommand.shouldInvoke(InvocationContext) but evaluated by InvocationContextInterceptor.
void	init(CacheNotifier notifier, Configuration configuration, TimeService timeService)
boolean	isConditional() Certain commands only work based on a certain condition or state of the cache.
void	notify(InvocationContext ctx, Object removedValue, Metadata removedMetadata, boolean isPre)
Object	perform(InvocationContext ctx) Performs an expiration on a specified entry
void	readFrom(ObjectInput input) Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
String	toString()
void	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

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

acceptVisitor, getValue, getValueMatcher, init, isNonExistent, isReturnValueExpected, isSuccessful, performRemove, readsExistingValues, setValue, setValueMatcher, updateStatusFromRemoteResponse

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

canBlock, getAffectedKeys, getKeyLockOwner, getKeysToLock, hasSkipLocking, hasZeroLockAcquisition

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

getKey, setKey, shouldInvoke

Methods inherited from class org.infinispan.commands.AbstractFlagAffectedCommand

getMetadata, getTopologyId, setMetadata, setTopologyId

Methods inherited from class org.infinispan.commands.AbstractLocalFlagAffectedCommand

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, setFlags, setFlags

Methods inherited from interface org.infinispan.commands.DataCommand

getKey

Field Detail

COMMAND_ID

public static final int COMMAND_ID

See Also:

Constant Field Values

lifespan

protected Long lifespan

timeService

protected TimeService timeService

Constructor Detail

RemoveExpiredCommand

public RemoveExpiredCommand()

RemoveExpiredCommand

public RemoveExpiredCommand(Object key,
                            Object value,
                            Long lifespan,
                            CacheNotifier notifier,
                            Equivalence valueEquivalence,
                            TimeService timeService,
                            CommandInvocationId commandInvocationId)

Method Detail

init

public void init(CacheNotifier notifier,
                 Configuration configuration,
                 TimeService timeService)

perform

public Object perform(InvocationContext ctx)
               throws Throwable

Performs an expiration 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.

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 interface WriteCommand

Overrides:

isConditional in class RemoveCommand

Returns:

true if the command is conditional, false otherwise

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.

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.

equals

public boolean equals(Object o)

Overrides:

equals in class RemoveCommand

hashCode

public int hashCode()

Overrides:

hashCode in class RemoveCommand

getFlags

public Set<Flag> getFlags()

Specified by:

getFlags in interface LocalFlagAffectedCommand

Overrides:

getFlags in class AbstractLocalFlagAffectedCommand

Returns:

The command flags - only valid to invoke after LocalFlagAffectedCommand.setFlags(java.util.Set). The set should not be modified directly, only via the LocalFlagAffectedCommand.setFlags(Set), LocalFlagAffectedCommand.addFlag(Flag) and LocalFlagAffectedCommand.addFlags(Set) methods.

hasFlag

public boolean hasFlag(Flag flag)

Description copied from interface: LocalFlagAffectedCommand

Check whether a particular flag is present in the command

Parameters:

flag - to lookup in the command

Returns:

true if the flag is present