org.infinispan.commands.irac

Class IracCleanupKeyCommand

java.lang.Object

org.infinispan.commands.irac.IracCleanupKeyCommand

All Implemented Interfaces:

CacheRpcCommand, ReplicableCommand

public class IracCleanupKeyCommand
extends Object
implements CacheRpcCommand

Sends a cleanup request from primary owner to backup owners.

Sent after a successfully update of all remote sites.

Since:

11.0

Author:

Pedro Ruivo

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMAND_ID

Constructor Summary

Constructors

Constructor and Description
IracCleanupKeyCommand()
IracCleanupKeyCommand(ByteString cacheName)
IracCleanupKeyCommand(ByteString cacheName, Object key, Object lockOwner, IracMetadata tombstone)

Method Summary

Modifier and Type	Method and Description
ByteString	getCacheName()
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
Address	getOrigin() Get the origin of the command
CompletableFuture<Object>	invokeAsync(ComponentRegistry componentRegistry) Invoke the command asynchronously.
boolean	isReturnValueExpected() If true, a return value will be provided when performed remotely.
void	readFrom(ObjectInput input) Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
void	setOrigin(Address origin) Set the origin of the command
String	toString()
void	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.commands.ReplicableCommand

canBlock, invoke, invokeAsync, isSuccessful

Field Detail

COMMAND_ID

public static final byte COMMAND_ID

See Also:

Constant Field Values

Constructor Detail

IracCleanupKeyCommand

public IracCleanupKeyCommand()

IracCleanupKeyCommand

public IracCleanupKeyCommand(ByteString cacheName)

IracCleanupKeyCommand

public IracCleanupKeyCommand(ByteString cacheName,
                             Object key,
                             Object lockOwner,
                             IracMetadata tombstone)

Method Detail

getCacheName

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.

invokeAsync

public CompletableFuture<Object> invokeAsync(ComponentRegistry componentRegistry)

Description copied from interface: CacheRpcCommand

Invoke the command asynchronously.

This method replaces ReplicableCommand.invoke() for remote execution. The default implementation and ReplicableCommand.invoke() will be removed in future versions.

Specified by:

invokeAsync in interface CacheRpcCommand

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

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 remote ResponseGenerator may choose to simply return null to save on marshalling costs.

Specified by:

isReturnValueExpected in interface ReplicableCommand

Returns:

true or false

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

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

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.

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

toString

public String toString()

Overrides:

toString in class Object