Class AbstractDataCommand

java.lang.Object

org.infinispan.commands.read.AbstractDataCommand

All Implemented Interfaces:

DataCommand, FlagAffectedCommand, CacheRpcCommand, ReplicableCommand, SegmentSpecificCommand, TopologyAffectedCommand, TracedCommand, VisitableCommand, VersionAware

Direct Known Subclasses:

AbstractDataWriteCommand, GetCacheEntryCommand, GetKeyValueCommand, ReadOnlyKeyCommand, TouchCommand

public abstract class AbstractDataCommand
extends Object
implements DataCommand, SegmentSpecificCommand

Since:

4.0

Author:

Mircea.Markus@jboss.com, Sanne Grinovero <sanne@hibernate.org> (C) 2011 Red Hat Inc.

Nested Class Summary

Nested classes/interfaces inherited from interface VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields

Modifier and Type	Field	Description
protected final ByteString	cacheName
protected Object	key
protected Address	origin
protected int	segment
protected InfinispanSpanAttributes	spanAttributes
protected int	topologyId

Fields inherited from interface VisitableCommand

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDataCommand(ByteString cacheName, Object key, int segment, long flagsBitSet)
protected	AbstractDataCommand(ByteString cacheName, MarshallableObject<?> wrappedKey, long flagsWithoutRemote, int topologyId, int segment)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
ByteString	getCacheName()
long	getFlagsBitSet()
long	getFlagsWithoutRemote()
Object	getKey()
Address	getOrigin()	Get the origin of the command
int	getSegment()	Returns the segment that this key maps to.
InfinispanSpanAttributes	getSpanAttributes()
int	getTopologyId()
MarshallableObject<?>	getWrappedKey()
int	hashCode()
boolean	isReturnValueExpected()	If true, a return value will be provided when performed remotely.
protected final String	printFlags()
void	setFlagsBitSet(long bitSet)	Set the flags, replacing any existing flags.
void	setKey(Object key)
void	setOrigin(Address origin)	Set the origin of the command
void	setSpanAttributes(InfinispanSpanAttributes attributes)
void	setTopologyId(int topologyId)
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface FlagAffectedCommand

addFlags, getFlags, hasAllFlags, hasAnyFlag

Methods inherited from interface ReplicableCommand

getCommandId, isSuccessful, logThrowable, readFrom, supportedSince, writeTo

Methods inherited from interface TracedCommand

getOperationName

Methods inherited from interface VisitableCommand

acceptVisitor, init, invokeAsync, loadType

Field Details

cacheName

protected final ByteString cacheName

origin

protected Address origin

key

protected Object key

topologyId

protected int topologyId

segment

protected int segment

spanAttributes

protected InfinispanSpanAttributes spanAttributes

Constructor Details

AbstractDataCommand

protected AbstractDataCommand(ByteString cacheName,
 MarshallableObject<?> wrappedKey,
 long flagsWithoutRemote,
 int topologyId,
 int segment)

AbstractDataCommand

protected AbstractDataCommand(ByteString cacheName,
 Object key,
 int segment,
 long flagsBitSet)

Method Details

getCacheName

@ProtoField(1)
public ByteString getCacheName()

Specified by:

getCacheName in interface CacheRpcCommand

Returns:

the name of the cache that produced this command. This will also be the name of the cache this command is intended for.

getWrappedKey

@ProtoField(number=2,
            name="key")
public MarshallableObject<?> getWrappedKey()

getSegment

@ProtoField(3)
public int getSegment()

Description copied from interface: SegmentSpecificCommand

Returns the segment that this key maps to. This must always return a number 0 or larger.

Specified by:

getSegment in interface SegmentSpecificCommand

Returns:

the segment of the key

getTopologyId

@ProtoField(4)
public int getTopologyId()

Specified by:

getTopologyId in interface TopologyAffectedCommand

setTopologyId

public void setTopologyId(int topologyId)

Specified by:

setTopologyId in interface TopologyAffectedCommand

getFlagsWithoutRemote

@ProtoField(number=5,
            name="flags")
public long getFlagsWithoutRemote()

getFlagsBitSet

public long getFlagsBitSet()

Specified by:

getFlagsBitSet in interface FlagAffectedCommand

Returns:

The command flags. Flags can be modified with FlagAffectedCommand.setFlagsBitSet(long), FlagAffectedCommand.addFlags(long) and FlagAffectedCommand.addFlags(long) methods.

setFlagsBitSet

public void setFlagsBitSet(long bitSet)

Description copied from interface: FlagAffectedCommand

Set the flags, replacing any existing flags.

Specified by:

setFlagsBitSet in interface FlagAffectedCommand

getOrigin

public Address getOrigin()

Description copied from interface: CacheRpcCommand

Get the origin of the command

Specified by:

getOrigin in interface CacheRpcCommand

setOrigin

public void setOrigin(Address origin)

Description copied from interface: CacheRpcCommand

Set the origin of the command

Specified by:

setOrigin in interface CacheRpcCommand

Specified by:

setOrigin in interface ReplicableCommand

Parameters:

origin - the sender's Address

getKey

public Object getKey()

Specified by:

getKey in interface DataCommand

setKey

public void setKey(Object key)

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

printFlags

protected final String printFlags()

setSpanAttributes

public void setSpanAttributes(InfinispanSpanAttributes attributes)

Specified by:

setSpanAttributes in interface TracedCommand

getSpanAttributes

public InfinispanSpanAttributes getSpanAttributes()

Specified by:

getSpanAttributes in interface TracedCommand