org.infinispan.commands

Interface CommandsFactory

All Known Implementing Classes:

CommandsFactoryImpl

public interface CommandsFactory

A factory to build commands, initializing and injecting dependencies accordingly. Commands built for a specific, named cache instance cannot be reused on a different cache instance since most commands contain the cache name it was built for along with references to other named-cache scoped components.

Since:

4.0

Author:

Manik Surtani, Mircea.Markus@jboss.com, Galder Zamarreño

Method Summary

Methods

Modifier and Type	Method and Description
ApplyDeltaCommand	buildApplyDeltaCommand(Object deltaAwareValueKey, Delta delta, Collection keys) Builds a ApplyDeltaCommand used for applying Delta objects to DeltaAware containers stored in cache
CancelCommand	buildCancelCommandCommand(UUID commandUUID) Builds CancelCommandCommand used to cancel other commands executing on Infinispan cluster
ClearCommand	buildClearCommand(Set<Flag> flags) Builds a ClearCommand
ClusteredGetCommand	buildClusteredGetCommand(Object key, Set<Flag> flags, boolean acquireRemoteLock, GlobalTransaction gtx) Builds a ClusteredGetCommand, which is a remote lookup command
CommitCommand	buildCommitCommand(GlobalTransaction gtx) Builds a CommitCommand
CompleteTransactionCommand	buildCompleteTransactionCommand(Xid xid, boolean commit) Builds a CompleteTransactionCommand command.
CreateCacheCommand	buildCreateCacheCommand(String cacheName, String cacheConfigurationName) Same as #buildCreateCacheCommand(String, String, false, 0).
CreateCacheCommand	buildCreateCacheCommand(String tmpCacheName, String defaultTmpCacheConfigurationName, boolean start, int size) Builds a CreateCacheCommand used to create/start cache around Infinispan cluster
<T> DistributedExecuteCommand<T>	buildDistributedExecuteCommand(Callable<T> callable, Address sender, Collection keys) Builds a DistributedExecuteCommand used for migration and execution of distributed Callables and Runnables.
EntrySetCommand	buildEntrySetCommand(Set<Flag> flags) Builds a EntrySetCommand
EvictCommand	buildEvictCommand(Object key, Set<Flag> flags) Builds an EvictCommand
GetInDoubtTransactionsCommand	buildGetInDoubtTransactionsCommand() Builds a GetInDoubtTransactionsCommand.
GetInDoubtTxInfoCommand	buildGetInDoubtTxInfoCommand()
GetKeyValueCommand	buildGetKeyValueCommand(Object key, Set<Flag> flags, boolean returnEntry) Builds a GetKeyValueCommand
InvalidateCommand	buildInvalidateCommand(Set<Flag> flags, Object... keys) Builds an InvalidateCommand
InvalidateCommand	buildInvalidateFromL1Command(Address origin, boolean forRehash, Set<Flag> flags, Collection<Object> keys)
InvalidateCommand	buildInvalidateFromL1Command(boolean forRehash, Set<Flag> flags, Collection<Object> keys) Builds an InvalidateFromL1Command
KeySetCommand	buildKeySetCommand(Set<Flag> flags) Builds a KeySetCommand
LockControlCommand	buildLockControlCommand(Collection<Object> keys, Set<Flag> flags, GlobalTransaction gtx) Builds a LockControlCommand to control explicit remote locking
LockControlCommand	buildLockControlCommand(Collection keys, Set<Flag> flags)
LockControlCommand	buildLockControlCommand(Object key, Set<Flag> flags, GlobalTransaction gtx) Same as buildLockControlCommand(Object, java.util.Set, org.infinispan.transaction.xa.GlobalTransaction) but for locking a single key vs a collection of keys.
<KIn,VIn,KOut,VOut> MapCombineCommand<KIn,VIn,KOut,VOut>	buildMapCombineCommand(String taskId, Mapper<KIn,VIn,KOut,VOut> m, Reducer<KOut,VOut> r, Collection<KIn> keys) Builds a MapCombineCommand used for migration and map phase execution of MapReduce tasks.
PrepareCommand	buildPrepareCommand(GlobalTransaction gtx, List<WriteCommand> modifications, boolean onePhaseCommit) Builds a PrepareCommand
PutKeyValueCommand	buildPutKeyValueCommand(Object key, Object value, Metadata metadata, Set<Flag> flags) Builds a PutKeyValueCommand
PutMapCommand	buildPutMapCommand(Map<?,?> map, Metadata metadata, Set<Flag> flags) Builds a PutMapCommand
<KOut,VOut> ReduceCommand<KOut,VOut>	buildReduceCommand(String taskId, String destinationCache, Reducer<KOut,VOut> r, Collection<KOut> keys) Builds a ReduceCommand used for migration and reduce phase execution of MapReduce tasks.
RemoveCommand	buildRemoveCommand(Object key, Object value, Set<Flag> flags) Builds a RemoveCommand
ReplaceCommand	buildReplaceCommand(Object key, Object oldValue, Object newValue, Metadata metadata, Set<Flag> flags) Builds a ReplaceCommand
MultipleRpcCommand	buildReplicateCommand(List<ReplicableCommand> toReplicate) Builds an RpcCommand "envelope" containing multiple ReplicableCommands
RollbackCommand	buildRollbackCommand(GlobalTransaction gtx) Builds a RollbackCommand
SingleRpcCommand	buildSingleRpcCommand(ReplicableCommand call) Builds a SingleRpcCommand "envelope" containing a single ReplicableCommand
SizeCommand	buildSizeCommand(Set<Flag> flags) Builds a SizeCommand
StateRequestCommand	buildStateRequestCommand(StateRequestCommand.Type subtype, Address sender, int viewId, Set<Integer> segments) Builds a StateRequestCommand used for requesting transactions and locks and for starting or canceling transfer of cache entries.
StateResponseCommand	buildStateResponseCommand(Address sender, int viewId, Collection<StateChunk> stateChunks) Builds a StateResponseCommand used for pushing cache entries to another node in response to a StateRequestCommand.
TxCompletionNotificationCommand	buildTxCompletionNotificationCommand(long internalId)
TxCompletionNotificationCommand	buildTxCompletionNotificationCommand(Xid xid, GlobalTransaction globalTransaction) Builds a TxCompletionNotificationCommand.
ValuesCommand	buildValuesCommand(Set<Flag> flags) Builds a ValuesCommand
VersionedCommitCommand	buildVersionedCommitCommand(GlobalTransaction gtx) Builds a VersionedCommitCommand
VersionedPrepareCommand	buildVersionedPrepareCommand(GlobalTransaction gtx, List<WriteCommand> modifications, boolean onePhase) Builds a VersionedPrepareCommand
String	getCacheName() Retrieves the cache name this CommandFactory is set up to construct commands for.
void	initializeReplicableCommand(ReplicableCommand command, boolean isRemote) Initializes a ReplicableCommand read from a data stream with components specific to the target cache instance.

Method Detail

buildPutKeyValueCommand

PutKeyValueCommand buildPutKeyValueCommand(Object key,
                                         Object value,
                                         Metadata metadata,
                                         Set<Flag> flags)

Builds a PutKeyValueCommand

Parameters:

key - key to put

value - value to put

metadata - metadata of entry

flags - Command flags provided by cache

Returns:

a PutKeyValueCommand

buildRemoveCommand

RemoveCommand buildRemoveCommand(Object key,
                               Object value,
                               Set<Flag> flags)

Builds a RemoveCommand

Parameters:

key - key to remove

value - value to check for ina conditional remove, or null for an unconditional remove.

flags - Command flags provided by cache

Returns:

a RemoveCommand

buildInvalidateCommand

InvalidateCommand buildInvalidateCommand(Set<Flag> flags,
                                       Object... keys)

Builds an InvalidateCommand

Parameters:

flags - Command flags provided by cache

keys - keys to invalidate

Returns:

an InvalidateCommand

buildInvalidateFromL1Command

InvalidateCommand buildInvalidateFromL1Command(boolean forRehash,
                                             Set<Flag> flags,
                                             Collection<Object> keys)

Builds an InvalidateFromL1Command

Parameters:

forRehash - set to true if the invalidation is happening due to a new node taking ownership. False if it is due to a write, changing the state of the entry.

keys - keys to invalidate

Returns:

an InvalidateFromL1Command

buildInvalidateFromL1Command

InvalidateCommand buildInvalidateFromL1Command(Address origin,
                                             boolean forRehash,
                                             Set<Flag> flags,
                                             Collection<Object> keys)

See Also:

buildInvalidateFromL1Command(org.infinispan.remoting.transport.Address, boolean, java.util.Set, java.util.Collection)

buildReplaceCommand

ReplaceCommand buildReplaceCommand(Object key,
                                 Object oldValue,
                                 Object newValue,
                                 Metadata metadata,
                                 Set<Flag> flags)

Builds a ReplaceCommand

Parameters:

key - key to replace

oldValue - existing value to check for if conditional, null if unconditional.

newValue - value to replace with

metadata - metadata of entry

flags - Command flags provided by cache

Returns:

a ReplaceCommand

buildSizeCommand

SizeCommand buildSizeCommand(Set<Flag> flags)

Builds a SizeCommand

Parameters:

flags - Command flags provided by cache

Returns:

a SizeCommand

buildGetKeyValueCommand

GetKeyValueCommand buildGetKeyValueCommand(Object key,
                                         Set<Flag> flags,
                                         boolean returnEntry)

Builds a GetKeyValueCommand

Parameters:

key - key to get

flags - Command flags provided by cache

returnEntry - boolean indicating whether entire cache entry is returned, otherwise return just the value part

Returns:

a GetKeyValueCommand

buildKeySetCommand

KeySetCommand buildKeySetCommand(Set<Flag> flags)

Builds a KeySetCommand

Parameters:

flags - Command flags provided by cache

Returns:

a KeySetCommand

buildValuesCommand

ValuesCommand buildValuesCommand(Set<Flag> flags)

Builds a ValuesCommand

Parameters:

flags - Command flags provided by cache

Returns:

a ValuesCommand

buildEntrySetCommand

EntrySetCommand buildEntrySetCommand(Set<Flag> flags)

Builds a EntrySetCommand

Parameters:

flags - Command flags provided by cache

Returns:

a EntrySetCommand

buildPutMapCommand

PutMapCommand buildPutMapCommand(Map<?,?> map,
                               Metadata metadata,
                               Set<Flag> flags)

Builds a PutMapCommand

Parameters:

map - map containing key/value entries to put

metadata - metadata of entry

flags - Command flags provided by cache

Returns:

a PutMapCommand

buildClearCommand

ClearCommand buildClearCommand(Set<Flag> flags)

Builds a ClearCommand

Parameters:

flags - Command flags provided by cache

Returns:

a ClearCommand

buildEvictCommand

EvictCommand buildEvictCommand(Object key,
                             Set<Flag> flags)

Builds an EvictCommand

Parameters:

key - key to evict

flags - Command flags provided by cache

Returns:

an EvictCommand

buildPrepareCommand

PrepareCommand buildPrepareCommand(GlobalTransaction gtx,
                                 List<WriteCommand> modifications,
                                 boolean onePhaseCommit)

Builds a PrepareCommand

Parameters:

gtx - global transaction associated with the prepare

modifications - list of modifications

onePhaseCommit - is this a one-phase or two-phase transaction?

Returns:

a PrepareCommand

buildVersionedPrepareCommand

VersionedPrepareCommand buildVersionedPrepareCommand(GlobalTransaction gtx,
                                                   List<WriteCommand> modifications,
                                                   boolean onePhase)

Builds a VersionedPrepareCommand

Parameters:

gtx - global transaction associated with the prepare

modifications - list of modifications

onePhase -

Returns:

a VersionedPrepareCommand

buildCommitCommand

CommitCommand buildCommitCommand(GlobalTransaction gtx)

Builds a CommitCommand

Parameters:

gtx - global transaction associated with the commit

Returns:

a CommitCommand

buildVersionedCommitCommand

VersionedCommitCommand buildVersionedCommitCommand(GlobalTransaction gtx)

Builds a VersionedCommitCommand

Parameters:

gtx - global transaction associated with the commit

Returns:

a VersionedCommitCommand

buildRollbackCommand

RollbackCommand buildRollbackCommand(GlobalTransaction gtx)

Builds a RollbackCommand

Parameters:

gtx - global transaction associated with the rollback

Returns:

a RollbackCommand

initializeReplicableCommand

void initializeReplicableCommand(ReplicableCommand command,
                               boolean isRemote)

Initializes a ReplicableCommand read from a data stream with components specific to the target cache instance.

Implementations should also be deep, in that if the command contains other commands, these should be recursed into.

Parameters:

command - command to initialize. Cannot be null.

isRemote -

buildReplicateCommand

MultipleRpcCommand buildReplicateCommand(List<ReplicableCommand> toReplicate)

Builds an RpcCommand "envelope" containing multiple ReplicableCommands

Parameters:

toReplicate - ReplicableCommands to include in the envelope

Returns:

a MultipleRpcCommand

buildSingleRpcCommand

SingleRpcCommand buildSingleRpcCommand(ReplicableCommand call)

Builds a SingleRpcCommand "envelope" containing a single ReplicableCommand

Parameters:

call - ReplicableCommand to include in the envelope

Returns:

a SingleRpcCommand

buildClusteredGetCommand

ClusteredGetCommand buildClusteredGetCommand(Object key,
                                           Set<Flag> flags,
                                           boolean acquireRemoteLock,
                                           GlobalTransaction gtx)

Builds a ClusteredGetCommand, which is a remote lookup command

Parameters:

key - key to look up

Returns:

a ClusteredGetCommand

buildLockControlCommand

LockControlCommand buildLockControlCommand(Collection<Object> keys,
                                         Set<Flag> flags,
                                         GlobalTransaction gtx)

Builds a LockControlCommand to control explicit remote locking

Parameters:

keys - keys to lock

gtx -

Returns:

a LockControlCommand

buildLockControlCommand

LockControlCommand buildLockControlCommand(Object key,
                                         Set<Flag> flags,
                                         GlobalTransaction gtx)

Same as buildLockControlCommand(Object, java.util.Set, org.infinispan.transaction.xa.GlobalTransaction) but for locking a single key vs a collection of keys.

buildLockControlCommand

LockControlCommand buildLockControlCommand(Collection keys,
                                         Set<Flag> flags)

buildStateRequestCommand

StateRequestCommand buildStateRequestCommand(StateRequestCommand.Type subtype,
                                           Address sender,
                                           int viewId,
                                           Set<Integer> segments)

Builds a StateRequestCommand used for requesting transactions and locks and for starting or canceling transfer of cache entries.

buildStateResponseCommand

StateResponseCommand buildStateResponseCommand(Address sender,
                                             int viewId,
                                             Collection<StateChunk> stateChunks)

Builds a StateResponseCommand used for pushing cache entries to another node in response to a StateRequestCommand.

getCacheName

String getCacheName()

Retrieves the cache name this CommandFactory is set up to construct commands for.

Returns:

the name of the cache this CommandFactory is set up to construct commands for.

buildGetInDoubtTransactionsCommand

GetInDoubtTransactionsCommand buildGetInDoubtTransactionsCommand()

Builds a GetInDoubtTransactionsCommand.

buildTxCompletionNotificationCommand

TxCompletionNotificationCommand buildTxCompletionNotificationCommand(Xid xid,
                                                                   GlobalTransaction globalTransaction)

Builds a TxCompletionNotificationCommand.

buildDistributedExecuteCommand

<T> DistributedExecuteCommand<T> buildDistributedExecuteCommand(Callable<T> callable,
                                                              Address sender,
                                                              Collection keys)

Builds a DistributedExecuteCommand used for migration and execution of distributed Callables and Runnables.

Parameters:

callable - the callable task

sender - sender's Address

keys - keys used in Callable

Returns:

a DistributedExecuteCommand

buildMapCombineCommand

<KIn,VIn,KOut,VOut> MapCombineCommand<KIn,VIn,KOut,VOut> buildMapCombineCommand(String taskId,
                                                                              Mapper<KIn,VIn,KOut,VOut> m,
                                                                              Reducer<KOut,VOut> r,
                                                                              Collection<KIn> keys)

Builds a MapCombineCommand used for migration and map phase execution of MapReduce tasks.

Parameters:

m - Mapper for MapReduceTask

r - Combiner for MapReduceTask

keys - keys used in MapReduceTask

Returns:

created MapCombineCommand

buildReduceCommand

<KOut,VOut> ReduceCommand<KOut,VOut> buildReduceCommand(String taskId,
                                                      String destinationCache,
                                                      Reducer<KOut,VOut> r,
                                                      Collection<KOut> keys)

Builds a ReduceCommand used for migration and reduce phase execution of MapReduce tasks.

Parameters:

r - Reducer for MapReduceTask

keys - keys used in MapReduceTask

Returns:

created ReduceCommand

buildGetInDoubtTxInfoCommand

GetInDoubtTxInfoCommand buildGetInDoubtTxInfoCommand()

See Also:

GetInDoubtTxInfoCommand

buildCompleteTransactionCommand

CompleteTransactionCommand buildCompleteTransactionCommand(Xid xid,
                                                         boolean commit)

Builds a CompleteTransactionCommand command.

Parameters:

xid - the xid identifying the transaction we want to complete.

commit - commit(true) or rollback(false)?

buildTxCompletionNotificationCommand

TxCompletionNotificationCommand buildTxCompletionNotificationCommand(long internalId)

Parameters:

internalId - the internal id identifying the transaction to be removed.

See Also:

TxCompletionNotificationCommand

buildApplyDeltaCommand

ApplyDeltaCommand buildApplyDeltaCommand(Object deltaAwareValueKey,
                                       Delta delta,
                                       Collection keys)

Builds a ApplyDeltaCommand used for applying Delta objects to DeltaAware containers stored in cache

Returns:

ApplyDeltaCommand instance

See Also:

ApplyDeltaCommand

buildCreateCacheCommand

CreateCacheCommand buildCreateCacheCommand(String cacheName,
                                         String cacheConfigurationName)

Same as #buildCreateCacheCommand(String, String, false, 0).

buildCreateCacheCommand

CreateCacheCommand buildCreateCacheCommand(String tmpCacheName,
                                         String defaultTmpCacheConfigurationName,
                                         boolean start,
                                         int size)

Builds a CreateCacheCommand used to create/start cache around Infinispan cluster

Parameters:

start - if true, then this command also makes sure that the cache is started on all the nodes in the cluster.

size - the expected number of nodes where this node runs

buildCancelCommandCommand

CancelCommand buildCancelCommandCommand(UUID commandUUID)

Builds CancelCommandCommand used to cancel other commands executing on Infinispan cluster

Parameters:

commandUUID - UUID for command to cancel

Returns:

created CancelCommandCommand