org.infinispan.commands.read

Class AbstractDataCommand

java.lang.Object

org.infinispan.commands.AbstractLocalFlagAffectedCommand

org.infinispan.commands.AbstractFlagAffectedCommand

org.infinispan.commands.read.AbstractDataCommand

All Implemented Interfaces:

DataCommand, FlagAffectedCommand, LocalFlagAffectedCommand, MetadataAwareCommand, ReplicableCommand, TopologyAffectedCommand, VisitableCommand

Direct Known Subclasses:

AbstractDataWriteCommand, GetCacheEntryCommand, GetKeyValueCommand, ReadOnlyKeyCommand, ReadOnlyManyCommand

public abstract class AbstractDataCommand
extends AbstractFlagAffectedCommand
implements DataCommand

Since:

4.0

Author:

Mircea.Markus@jboss.com, Sanne Grinovero (C) 2011 Red Hat Inc.

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	key

Fields inherited from class org.infinispan.commands.AbstractLocalFlagAffectedCommand

flags

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDataCommand()
protected	AbstractDataCommand(Object key, Set<Flag> flags)

Method Summary

Modifier and Type	Method and Description
boolean	canBlock() If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool.
boolean	equals(Object obj)
Object	getKey()
int	hashCode()
boolean	ignoreCommandOnStatus(ComponentStatus status) Similar to VisitableCommand.shouldInvoke(InvocationContext) but evaluated by InvocationContextInterceptor.
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
void	setKey(Object key)
boolean	shouldInvoke(InvocationContext ctx) Used by the InboundInvocationHandler to determine whether the command should be invoked or not.
String	toString()

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

acceptVisitor, alwaysReadsExistingValues, readsExistingValues

Methods inherited from interface org.infinispan.commands.TopologyAffectedCommand

getTopologyId, setTopologyId

Methods inherited from interface org.infinispan.commands.ReplicableCommand

getCommandId, getParameters, perform, readFrom, setParameters, writeTo

Methods inherited from interface org.infinispan.commands.LocalFlagAffectedCommand

addFlag, addFlags, getFlags, hasFlag, setFlags, setFlags

Field Detail

key

protected Object key

Constructor Detail

AbstractDataCommand

protected AbstractDataCommand(Object key,
                              Set<Flag> flags)

AbstractDataCommand

protected AbstractDataCommand()

Method Detail

getKey

public Object getKey()

Specified by:

getKey in interface DataCommand

setKey

public void setKey(Object key)

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

Returns:

true if the command should be invoked, false otherwise.

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

Returns:

true if the command should NOT be invoked.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

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

Returns:

true or false

canBlock

public boolean canBlock()

Description copied from interface: ReplicableCommand

If true, the command is processed asynchronously in a thread provided by an Infinispan thread pool. Otherwise, the command is processed directly in the JGroups thread.

This feature allows to avoid keep a JGroups thread busy that can originate discard of messages and retransmissions. So, the commands that can block (waiting for some state, acquiring locks, etc.) should return true.

Specified by:

canBlock in interface ReplicableCommand

Returns:

true if the command can block/wait, false otherwise