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

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
ClusteredGetAllCommand	buildClusteredGetAllCommand(List<?> keys, Set<Flag> flags, GlobalTransaction gtx) Builds a ClusteredGetAllCommand, which is a remote lookup command
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(cacheName, cacheConfigurationName, false, 0).
CreateCacheCommand	buildCreateCacheCommand(String tmpCacheName, String defaultTmpCacheConfigurationName, 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.
<K,V,C> EntryRequestCommand<K,V,C>	buildEntryRequestCommand(UUID identifier, Set<Integer> segments, Set<K> keysToFilter, KeyValueFilter<? super K,? super V> filter, Converter<? super K,? super V,C> converter, Set<Flag> flags) Builds EntryRequestCommand used to request entries from a remote node for given segments
<K,C> EntryResponseCommand<K,C>	buildEntryResponseCommand(UUID identifier, Set<Integer> completedSegments, Set<Integer> inDoubtSegments, Collection<CacheEntry<K,C>> values, CacheException e) Builds EntryResponseCommand use to respond with retrieved entries for given segments
EntrySetCommand	buildEntrySetCommand(Set<Flag> flags) Builds a EntrySetCommand
EvictCommand	buildEvictCommand(Object key, Set<Flag> flags) Builds an EvictCommand
GetAllCommand	buildGetAllCommand(Collection<?> keys, Set<Flag> flags, boolean returnEntries) Builds a GetAllCommand
GetCacheEntryCommand	buildGetCacheEntryCommand(Object key, Set<Flag> explicitFlags) Builds a GetCacheEntryCommand
GetInDoubtTransactionsCommand	buildGetInDoubtTransactionsCommand() Builds a GetInDoubtTransactionsCommand.
GetInDoubtTxInfoCommand	buildGetInDoubtTxInfoCommand()
GetKeysInGroupCommand	buildGetKeysInGroupCommand(Set<Flag> flags, String groupName) Builds GetKeysInGroupCommand used to fetch all the keys belonging to a group.
GetKeyValueCommand	buildGetKeyValueCommand(Object key, Set<Flag> flags) Builds a GetKeyValueCommand
InvalidateCommand	buildInvalidateCommand(Set<Flag> flags, Object... keys) Builds an InvalidateCommand
InvalidateCommand	buildInvalidateFromL1Command(Address origin, Set<Flag> flags, Collection<Object> keys)
InvalidateCommand	buildInvalidateFromL1Command(Set<Flag> flags, Collection<Object> keys) Builds an InvalidateFromL1Command
KeySetCommand	buildKeySetCommand(Set<Flag> flags) Builds a KeySetCommand
LockControlCommand	buildLockControlCommand(Collection<?> keys, Set<Flag> flags)
LockControlCommand	buildLockControlCommand(Collection<?> keys, Set<Flag> flags, GlobalTransaction gtx) Builds a LockControlCommand to control explicit remote locking
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
<K,V,R> ReadOnlyKeyCommand<K,V,R>	buildReadOnlyKeyCommand(K key, Function<EntryView.ReadEntryView<K,V>,R> f)
<K,V,R> ReadOnlyManyCommand<K,V,R>	buildReadOnlyManyCommand(Set<? extends K> keys, Function<EntryView.ReadEntryView<K,V>,R> f)
<K,V,R> ReadWriteKeyCommand<K,V,R>	buildReadWriteKeyCommand(K key, Function<EntryView.ReadWriteEntryView<K,V>,R> f, Params params)
<K,V,R> ReadWriteKeyValueCommand<K,V,R>	buildReadWriteKeyValueCommand(K key, V value, BiFunction<V,EntryView.ReadWriteEntryView<K,V>,R> f, Params params)
<K,V,R> ReadWriteManyCommand<K,V,R>	buildReadWriteManyCommand(Set<? extends K> keys, Function<EntryView.ReadWriteEntryView<K,V>,R> f, Params params)
<K,V,R> ReadWriteManyEntriesCommand<K,V,R>	buildReadWriteManyEntriesCommand(Map<? extends K,? extends V> entries, BiFunction<V,EntryView.ReadWriteEntryView<K,V>,R> f, Params params)
<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
RemoveExpiredCommand	buildRemoveExpiredCommand(Object key, Object value, Long lifespan) Builds an expired remove command that is used to remove only a specific expired entry
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
SingleXSiteRpcCommand	buildSingleXSiteRpcCommand(VisitableCommand command) Builds SingleRpcCommand used to perform VisitableCommand on the backup site,
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.
<K> StreamRequestCommand<K>	buildStreamRequestCommand(Object id, boolean parallelStream, StreamRequestCommand.Type type, Set<Integer> segments, Set<K> keys, Set<K> excludedKeys, boolean includeLoader, Object terminalOperation)
<R> StreamResponseCommand<R>	buildStreamResponseCommand(Object identifier, boolean complete, Set<Integer> lostSegments, R response) Builds StreamResponseCommand used to send back a response either intermediate or complete to the originating node with the information for the stream request.
TxCompletionNotificationCommand	buildTxCompletionNotificationCommand(long internalId)
TxCompletionNotificationCommand	buildTxCompletionNotificationCommand(Xid xid, GlobalTransaction globalTransaction) Builds a TxCompletionNotificationCommand.
VersionedCommitCommand	buildVersionedCommitCommand(GlobalTransaction gtx) Builds a VersionedCommitCommand
VersionedPrepareCommand	buildVersionedPrepareCommand(GlobalTransaction gtx, List<WriteCommand> modifications, boolean onePhase) Builds a VersionedPrepareCommand
<K,V> WriteOnlyKeyCommand<K,V>	buildWriteOnlyKeyCommand(K key, Consumer<EntryView.WriteEntryView<V>> f, Params params)
<K,V> WriteOnlyKeyValueCommand<K,V>	buildWriteOnlyKeyValueCommand(K key, V value, BiConsumer<V,EntryView.WriteEntryView<V>> f, Params params)
<K,V> WriteOnlyManyCommand<K,V>	buildWriteOnlyManyCommand(Set<? extends K> keys, Consumer<EntryView.WriteEntryView<V>> f, Params params)
<K,V> WriteOnlyManyEntriesCommand<K,V>	buildWriteOnlyManyEntriesCommand(Map<? extends K,? extends V> entries, BiConsumer<V,EntryView.WriteEntryView<V>> f, Params params)
XSiteAdminCommand	buildXSiteAdminCommand(String siteName, XSiteAdminCommand.AdminOperation op, Integer afterFailures, Long minTimeToWait) Builds XSiteAdminCommand used to perform system administrator operations.
XSiteStatePushCommand	buildXSiteStatePushCommand(XSiteState[] chunk, long timeoutMillis) Builds XSiteStatePushCommand used to transfer a single chunk of data between sites.
XSiteStateTransferControlCommand	buildXSiteStateTransferControlCommand(XSiteStateTransferControlCommand.StateTransferControl control, String siteName) Builds XSiteStateTransferControlCommand used to control the-cross site state transfer.
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(Set<Flag> flags,
                                               Collection<Object> keys)

Builds an InvalidateFromL1Command

Parameters:

keys - keys to invalidate

Returns:

an InvalidateFromL1Command

buildInvalidateFromL1Command

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

See Also:

buildInvalidateFromL1Command(java.util.Set, java.util.Collection)

buildRemoveExpiredCommand

RemoveExpiredCommand buildRemoveExpiredCommand(Object key,
                                               Object value,
                                               Long lifespan)

Builds an expired remove command that is used to remove only a specific expired entry

Parameters:

key - the key of the expired entry

value - the value of the entry when it was expired

lifespan - the lifespan that expired from the command

Returns:

a RemovedExpiredCommand

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)

Builds a GetKeyValueCommand

Parameters:

key - key to get

flags - Command flags provided by cache

Returns:

a GetKeyValueCommand

buildGetCacheEntryCommand

GetCacheEntryCommand buildGetCacheEntryCommand(Object key,
                                               Set<Flag> explicitFlags)

Builds a GetCacheEntryCommand

Parameters:

key - key to get

explicitFlags - Command flags provided by cache

Returns:

a GetCacheEntryCommand

buildGetAllCommand

GetAllCommand buildGetAllCommand(Collection<?> keys,
                                 Set<Flag> flags,
                                 boolean returnEntries)

Builds a GetAllCommand

Parameters:

keys - keys to get

flags - Command flags provided by cache

returnEntries - boolean indicating whether entire cache entries are returned, otherwise return just the value parts

Returns:

a GetKeyValueCommand

buildKeySetCommand

KeySetCommand buildKeySetCommand(Set<Flag> flags)

Builds a KeySetCommand

Parameters:

flags - Command flags provided by cache

Returns:

a KeySetCommand

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

buildClusteredGetAllCommand

ClusteredGetAllCommand buildClusteredGetAllCommand(List<?> keys,
                                                   Set<Flag> flags,
                                                   GlobalTransaction gtx)

Builds a ClusteredGetAllCommand, which is a remote lookup command

Parameters:

keys - key to look up

Returns:

a ClusteredGetAllCommand

buildLockControlCommand

LockControlCommand buildLockControlCommand(Collection<?> 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(cacheName, cacheConfigurationName, false, 0).

buildCreateCacheCommand

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

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

Parameters:

size - If size > 0, the command will wait until the cache runs on at least size nodes.

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

buildXSiteStateTransferControlCommand

XSiteStateTransferControlCommand buildXSiteStateTransferControlCommand(XSiteStateTransferControlCommand.StateTransferControl control,
                                                                       String siteName)

Builds XSiteStateTransferControlCommand used to control the-cross site state transfer.

Parameters:

control - the control operation

siteName - the site name, needed for some control operations.

Returns:

the XSiteStateTransferControlCommand created

buildXSiteAdminCommand

XSiteAdminCommand buildXSiteAdminCommand(String siteName,
                                         XSiteAdminCommand.AdminOperation op,
                                         Integer afterFailures,
                                         Long minTimeToWait)

Builds XSiteAdminCommand used to perform system administrator operations.

Returns:

the XSiteAdminCommand created

buildXSiteStatePushCommand

XSiteStatePushCommand buildXSiteStatePushCommand(XSiteState[] chunk,
                                                 long timeoutMillis)

Builds XSiteStatePushCommand used to transfer a single chunk of data between sites.

Parameters:

chunk - the data chunk

timeoutMillis - timeout in milliseconds, for the retries in the receiver site.

Returns:

the XSiteStatePushCommand created

buildSingleXSiteRpcCommand

SingleXSiteRpcCommand buildSingleXSiteRpcCommand(VisitableCommand command)

Builds SingleRpcCommand used to perform VisitableCommand on the backup site,

Parameters:

command - the visitable command.

Returns:

the SingleXSiteRpcCommand created

buildEntryRequestCommand

<K,V,C> EntryRequestCommand<K,V,C> buildEntryRequestCommand(UUID identifier,
                                                            Set<Integer> segments,
                                                            Set<K> keysToFilter,
                                                            KeyValueFilter<? super K,? super V> filter,
                                                            Converter<? super K,? super V,C> converter,
                                                            Set<Flag> flags)

Builds EntryRequestCommand used to request entries from a remote node for given segments

Type Parameters:

K - The key type of the stored key

V - The value type of the stored values

C - The converted type after the value is applied from the converter

Parameters:

identifier - The unique identifier for this entry retrieval request

segments - The segments this request should retrieve

filter - The filter to apply to any found values to limit response data

converter - The converter to apply to any found values

flags - The flags used to modify behavior

Returns:

the EntryRequestCommand created

buildEntryResponseCommand

<K,C> EntryResponseCommand<K,C> buildEntryResponseCommand(UUID identifier,
                                                          Set<Integer> completedSegments,
                                                          Set<Integer> inDoubtSegments,
                                                          Collection<CacheEntry<K,C>> values,
                                                          CacheException e)

Builds EntryResponseCommand use to respond with retrieved entries for given segments

Type Parameters:

K - The key type of the stored key

C - The converted type after the value is applied from the converter

Parameters:

identifier - The unique identifier for this entry retrieval request

completedSegments - The segments that are now completed per this response

inDoubtSegments - The segements that are now in doubt meaning they must be retrieved again from another node due to rehash

values - The entries retrieved from the remote node

e - If an exception occurred while running the processing on the remote node

Returns:

The EntryResponseCommand created

buildGetKeysInGroupCommand

GetKeysInGroupCommand buildGetKeysInGroupCommand(Set<Flag> flags,
                                                 String groupName)

Builds GetKeysInGroupCommand used to fetch all the keys belonging to a group.

Parameters:

flags -

groupName - the group name.

Returns:

the GetKeysInGroup created.

buildStreamRequestCommand

<K> StreamRequestCommand<K> buildStreamRequestCommand(Object id,
                                                      boolean parallelStream,
                                                      StreamRequestCommand.Type type,
                                                      Set<Integer> segments,
                                                      Set<K> keys,
                                                      Set<K> excludedKeys,
                                                      boolean includeLoader,
                                                      Object terminalOperation)

buildStreamResponseCommand

<R> StreamResponseCommand<R> buildStreamResponseCommand(Object identifier,
                                                        boolean complete,
                                                        Set<Integer> lostSegments,
                                                        R response)

Builds StreamResponseCommand used to send back a response either intermediate or complete to the originating node with the information for the stream request.

Type Parameters:

R - type of response

Parameters:

identifier - the unique identifier for the stream request

complete - whether or not this is an intermediate or final response from this node for the given id

lostSegments - what segments that were lost during processing

response - the actual response

Returns:

the command to send back the response

buildReadOnlyKeyCommand

<K,V,R> ReadOnlyKeyCommand<K,V,R> buildReadOnlyKeyCommand(K key,
                                                          Function<EntryView.ReadEntryView<K,V>,R> f)

buildReadOnlyManyCommand

<K,V,R> ReadOnlyManyCommand<K,V,R> buildReadOnlyManyCommand(Set<? extends K> keys,
                                                            Function<EntryView.ReadEntryView<K,V>,R> f)

buildWriteOnlyKeyCommand

<K,V> WriteOnlyKeyCommand<K,V> buildWriteOnlyKeyCommand(K key,
                                                        Consumer<EntryView.WriteEntryView<V>> f,
                                                        Params params)

buildReadWriteKeyValueCommand

<K,V,R> ReadWriteKeyValueCommand<K,V,R> buildReadWriteKeyValueCommand(K key,
                                                                      V value,
                                                                      BiFunction<V,EntryView.ReadWriteEntryView<K,V>,R> f,
                                                                      Params params)

buildReadWriteKeyCommand

<K,V,R> ReadWriteKeyCommand<K,V,R> buildReadWriteKeyCommand(K key,
                                                            Function<EntryView.ReadWriteEntryView<K,V>,R> f,
                                                            Params params)

buildWriteOnlyManyEntriesCommand

<K,V> WriteOnlyManyEntriesCommand<K,V> buildWriteOnlyManyEntriesCommand(Map<? extends K,? extends V> entries,
                                                                        BiConsumer<V,EntryView.WriteEntryView<V>> f,
                                                                        Params params)

buildWriteOnlyKeyValueCommand

<K,V> WriteOnlyKeyValueCommand<K,V> buildWriteOnlyKeyValueCommand(K key,
                                                                  V value,
                                                                  BiConsumer<V,EntryView.WriteEntryView<V>> f,
                                                                  Params params)

buildWriteOnlyManyCommand

<K,V> WriteOnlyManyCommand<K,V> buildWriteOnlyManyCommand(Set<? extends K> keys,
                                                          Consumer<EntryView.WriteEntryView<V>> f,
                                                          Params params)

buildReadWriteManyCommand

<K,V,R> ReadWriteManyCommand<K,V,R> buildReadWriteManyCommand(Set<? extends K> keys,
                                                              Function<EntryView.ReadWriteEntryView<K,V>,R> f,
                                                              Params params)

buildReadWriteManyEntriesCommand

<K,V,R> ReadWriteManyEntriesCommand<K,V,R> buildReadWriteManyEntriesCommand(Map<? extends K,? extends V> entries,
                                                                            BiFunction<V,EntryView.ReadWriteEntryView<K,V>,R> f,
                                                                            Params params)