Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.infinispan.commands.CommandsFactory Maven / Gradle / Ivy
package org.infinispan.commands;
import org.infinispan.Cache;
import org.infinispan.commands.read.EntryRetrievalCommand;
import org.infinispan.container.entries.CacheEntry;
import org.infinispan.commands.remote.GetKeysInGroupCommand;
import org.infinispan.iteration.impl.EntryRequestCommand;
import org.infinispan.iteration.impl.EntryResponseCommand;
import org.infinispan.iteration.impl.EntryRetriever;
import org.infinispan.metadata.Metadata;
import org.infinispan.atomic.Delta;
import org.infinispan.commands.control.LockControlCommand;
import org.infinispan.commands.read.DistributedExecuteCommand;
import org.infinispan.commands.read.EntrySetCommand;
import org.infinispan.commands.read.GetKeyValueCommand;
import org.infinispan.commands.read.KeySetCommand;
import org.infinispan.commands.read.MapCombineCommand;
import org.infinispan.commands.read.ReduceCommand;
import org.infinispan.commands.read.SizeCommand;
import org.infinispan.commands.read.ValuesCommand;
import org.infinispan.commands.remote.ClusteredGetCommand;
import org.infinispan.commands.remote.MultipleRpcCommand;
import org.infinispan.commands.remote.SingleRpcCommand;
import org.infinispan.commands.remote.recovery.CompleteTransactionCommand;
import org.infinispan.commands.remote.recovery.GetInDoubtTransactionsCommand;
import org.infinispan.commands.remote.recovery.GetInDoubtTxInfoCommand;
import org.infinispan.commands.remote.recovery.TxCompletionNotificationCommand;
import org.infinispan.commands.tx.CommitCommand;
import org.infinispan.commands.tx.PrepareCommand;
import org.infinispan.commands.tx.RollbackCommand;
import org.infinispan.commands.tx.VersionedCommitCommand;
import org.infinispan.commands.tx.VersionedPrepareCommand;
import org.infinispan.commands.write.*;
import org.infinispan.commons.CacheException;
import org.infinispan.context.Flag;
import org.infinispan.distexec.mapreduce.Mapper;
import org.infinispan.distexec.mapreduce.Reducer;
import org.infinispan.factories.scopes.Scope;
import org.infinispan.factories.scopes.Scopes;
import org.infinispan.filter.Converter;
import org.infinispan.filter.KeyValueFilter;
import org.infinispan.statetransfer.StateChunk;
import org.infinispan.statetransfer.StateRequestCommand;
import org.infinispan.statetransfer.StateResponseCommand;
import org.infinispan.remoting.transport.Address;
import org.infinispan.transaction.xa.GlobalTransaction;
import org.infinispan.xsite.SingleXSiteRpcCommand;
import org.infinispan.xsite.XSiteAdminCommand;
import org.infinispan.xsite.statetransfer.XSiteState;
import org.infinispan.xsite.statetransfer.XSiteStatePushCommand;
import org.infinispan.xsite.statetransfer.XSiteStateTransferControlCommand;
import javax.transaction.xa.Xid;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.Callable;
import static org.infinispan.xsite.XSiteAdminCommand.*;
import static org.infinispan.xsite.statetransfer.XSiteStateTransferControlCommand.*;
/**
* 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.
*
* @author Manik Surtani
* @author [email protected]
* @author Galder Zamarreño
* @since 4.0
*/
@Scope(Scopes.NAMED_CACHE)
public interface CommandsFactory {
/**
* Builds a PutKeyValueCommand
* @param key key to put
* @param value value to put
* @param metadata metadata of entry
* @param flags Command flags provided by cache
* @return a PutKeyValueCommand
*/
PutKeyValueCommand buildPutKeyValueCommand(Object key, Object value, Metadata metadata, Set flags);
/**
* Builds a RemoveCommand
* @param key key to remove
* @param value value to check for ina conditional remove, or null for an unconditional remove.
* @param flags Command flags provided by cache
* @return a RemoveCommand
*/
RemoveCommand buildRemoveCommand(Object key, Object value, Set flags);
/**
* Builds an InvalidateCommand
* @param flags Command flags provided by cache
* @param keys keys to invalidate
* @return an InvalidateCommand
*/
InvalidateCommand buildInvalidateCommand(Set flags, Object... keys);
/**
* Builds an InvalidateFromL1Command
* @param keys keys to invalidate
* @return an InvalidateFromL1Command
*/
InvalidateCommand buildInvalidateFromL1Command(Set flags, Collection keys);
/**
* @see #buildInvalidateFromL1Command(java.util.Set, java.util.Collection)
*/
InvalidateCommand buildInvalidateFromL1Command(Address origin, Set flags, Collection keys);
/**
* Builds a ReplaceCommand
* @param key key to replace
* @param oldValue existing value to check for if conditional, null if unconditional.
* @param newValue value to replace with
* @param metadata metadata of entry
* @param flags Command flags provided by cache
* @return a ReplaceCommand
*/
ReplaceCommand buildReplaceCommand(Object key, Object oldValue, Object newValue, Metadata metadata, Set flags);
/**
* Builds a SizeCommand
* @param flags Command flags provided by cache
* @return a SizeCommand
*/
SizeCommand buildSizeCommand(Set flags);
/**
* Builds a GetKeyValueCommand
* @param key key to get
* @param flags Command flags provided by cache
* @param returnEntry boolean indicating whether entire cache entry is
* returned, otherwise return just the value part
* @return a GetKeyValueCommand
*/
GetKeyValueCommand buildGetKeyValueCommand(Object key, Set flags, boolean returnEntry);
/**
* Builds a KeySetCommand
* @param flags Command flags provided by cache
* @return a KeySetCommand
*/
KeySetCommand buildKeySetCommand(Set flags);
/**
* Builds a ValuesCommand
* @param flags Command flags provided by cache
* @return a ValuesCommand
*/
ValuesCommand buildValuesCommand(Set flags);
/**
* Builds a EntrySetCommand
* @param flags Command flags provided by cache
* @return a EntrySetCommand
*/
EntrySetCommand buildEntrySetCommand(Set flags);
/**
* Builds a EntryRetrievalCommand
* @param flags Command flags provided by cache
* @param filter The filter used for the iteration process
* @return a EntryRetrievalCommand
*/
EntryRetrievalCommand buildEntryRetrievalCommand(Set flags, KeyValueFilter filter);
/**
* Builds a PutMapCommand
* @param map map containing key/value entries to put
* @param metadata metadata of entry
* @param flags Command flags provided by cache
* @return a PutMapCommand
*/
PutMapCommand buildPutMapCommand(Map map, Metadata metadata, Set flags);
/**
* Builds a ClearCommand
* @param flags Command flags provided by cache
* @return a ClearCommand
*/
ClearCommand buildClearCommand(Set flags);
/**
* Builds an EvictCommand
* @param key key to evict
* @param flags Command flags provided by cache
* @return an EvictCommand
*/
EvictCommand buildEvictCommand(Object key, Set flags);
/**
* Builds a PrepareCommand
* @param gtx global transaction associated with the prepare
* @param modifications list of modifications
* @param onePhaseCommit is this a one-phase or two-phase transaction?
* @return a PrepareCommand
*/
PrepareCommand buildPrepareCommand(GlobalTransaction gtx, List modifications, boolean onePhaseCommit);
/**
* Builds a VersionedPrepareCommand
*
* @param gtx global transaction associated with the prepare
* @param modifications list of modifications
* @param onePhase
* @return a VersionedPrepareCommand
*/
VersionedPrepareCommand buildVersionedPrepareCommand(GlobalTransaction gtx, List modifications, boolean onePhase);
/**
* Builds a CommitCommand
* @param gtx global transaction associated with the commit
* @return a CommitCommand
*/
CommitCommand buildCommitCommand(GlobalTransaction gtx);
/**
* Builds a VersionedCommitCommand
* @param gtx global transaction associated with the commit
* @return a VersionedCommitCommand
*/
VersionedCommitCommand buildVersionedCommitCommand(GlobalTransaction gtx);
/**
* Builds a RollbackCommand
* @param gtx global transaction associated with the rollback
* @return a RollbackCommand
*/
RollbackCommand buildRollbackCommand(GlobalTransaction gtx);
/**
* Initializes a {@link org.infinispan.commands.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.
*
*
* @param command command to initialize. Cannot be null.
* @param isRemote
*/
void initializeReplicableCommand(ReplicableCommand command, boolean isRemote);
/**
* Builds an RpcCommand "envelope" containing multiple ReplicableCommands
* @param toReplicate ReplicableCommands to include in the envelope
* @return a MultipleRpcCommand
*/
MultipleRpcCommand buildReplicateCommand(List toReplicate);
/**
* Builds a SingleRpcCommand "envelope" containing a single ReplicableCommand
* @param call ReplicableCommand to include in the envelope
* @return a SingleRpcCommand
*/
SingleRpcCommand buildSingleRpcCommand(ReplicableCommand call);
/**
* Builds a ClusteredGetCommand, which is a remote lookup command
* @param key key to look up
* @return a ClusteredGetCommand
*/
ClusteredGetCommand buildClusteredGetCommand(Object key, Set flags, boolean acquireRemoteLock, GlobalTransaction gtx);
/**
* Builds a LockControlCommand to control explicit remote locking
*
*
* @param keys keys to lock
* @param gtx
* @return a LockControlCommand
*/
LockControlCommand buildLockControlCommand(Collection keys, Set flags, GlobalTransaction gtx);
/**
* Same as {@link #buildLockControlCommand(Object, java.util.Set, org.infinispan.transaction.xa.GlobalTransaction)}
* but for locking a single key vs a collection of keys.
*/
LockControlCommand buildLockControlCommand(Object key, Set flags, GlobalTransaction gtx);
LockControlCommand buildLockControlCommand(Collection keys, Set flags);
/**
* Builds a StateRequestCommand used for requesting transactions and locks and for starting or canceling transfer of cache entries.
*/
StateRequestCommand buildStateRequestCommand(StateRequestCommand.Type subtype, Address sender, int viewId, Set segments);
/**
* Builds a StateResponseCommand used for pushing cache entries to another node in response to a StateRequestCommand.
*/
StateResponseCommand buildStateResponseCommand(Address sender, int viewId, Collection stateChunks);
/**
* Retrieves the cache name this CommandFactory is set up to construct commands for.
* @return the name of the cache this CommandFactory is set up to construct commands for.
*/
String getCacheName();
/**
* Builds a {@link org.infinispan.commands.remote.recovery.GetInDoubtTransactionsCommand}.
*/
GetInDoubtTransactionsCommand buildGetInDoubtTransactionsCommand();
/**
* Builds a {@link org.infinispan.commands.remote.recovery.TxCompletionNotificationCommand}.
*/
TxCompletionNotificationCommand buildTxCompletionNotificationCommand(Xid xid, GlobalTransaction globalTransaction);
/**
* Builds a DistributedExecuteCommand used for migration and execution of distributed Callables and Runnables.
*
* @param callable the callable task
* @param sender sender's Address
* @param keys keys used in Callable
* @return a DistributedExecuteCommand
*/
DistributedExecuteCommand buildDistributedExecuteCommand(Callable callable, Address sender, Collection keys);
/**
* Builds a MapCombineCommand used for migration and map phase execution of MapReduce tasks.
*
* @param m Mapper for MapReduceTask
* @param r Combiner for MapReduceTask
* @param keys keys used in MapReduceTask
* @return created MapCombineCommand
*/
MapCombineCommand buildMapCombineCommand(
String taskId, Mapper m, Reducer r,
Collection keys);
/**
* Builds a ReduceCommand used for migration and reduce phase execution of MapReduce tasks.
*
* @param r Reducer for MapReduceTask
* @param keys keys used in MapReduceTask
* @return created ReduceCommand
*/
ReduceCommand buildReduceCommand(String taskId,
String destinationCache, Reducer r, Collection keys);
/**
* @see GetInDoubtTxInfoCommand
*/
GetInDoubtTxInfoCommand buildGetInDoubtTxInfoCommand();
/**
* Builds a CompleteTransactionCommand command.
* @param xid the xid identifying the transaction we want to complete.
* @param commit commit(true) or rollback(false)?
*/
CompleteTransactionCommand buildCompleteTransactionCommand(Xid xid, boolean commit);
/**
* @param internalId the internal id identifying the transaction to be removed.
* @see org.infinispan.commands.remote.recovery.TxCompletionNotificationCommand
*/
TxCompletionNotificationCommand buildTxCompletionNotificationCommand(long internalId);
/**
* Builds a ApplyDeltaCommand used for applying Delta objects to DeltaAware containers stored in cache
*
* @return ApplyDeltaCommand instance
* @see ApplyDeltaCommand
*/
ApplyDeltaCommand buildApplyDeltaCommand(Object deltaAwareValueKey, Delta delta, Collection keys);
/**
* Same as {@code buildCreateCacheCommand(cacheName, cacheConfigurationName, false, 0)}.
*/
CreateCacheCommand buildCreateCacheCommand(String cacheName, String cacheConfigurationName);
/**
* Builds a CreateCacheCommand used to create/start cache around Infinispan cluster
*
* @param start if true, then this command also makes sure that the cache is started on all the nodes in the cluster.
* @param size the expected number of nodes where this node runs
*/
CreateCacheCommand buildCreateCacheCommand(String tmpCacheName, String defaultTmpCacheConfigurationName, boolean start, int size);
/**
* Builds CancelCommandCommand used to cancel other commands executing on Infinispan cluster
*
* @param commandUUID UUID for command to cancel
* @return created CancelCommandCommand
*/
CancelCommand buildCancelCommandCommand(UUID commandUUID);
/**
* Builds XSiteStateTransferControlCommand used to control the-cross site state transfer.
*
* @param control the control operation
* @param siteName the site name, needed for some control operations.
* @return the XSiteStateTransferControlCommand created
*/
XSiteStateTransferControlCommand buildXSiteStateTransferControlCommand(StateTransferControl control, String siteName);
/**
* Builds XSiteAdminCommand used to perform system administrator operations.
*
* @return the XSiteAdminCommand created
*/
XSiteAdminCommand buildXSiteAdminCommand(String siteName, AdminOperation op, Integer afterFailures, Long minTimeToWait);
/**
* Builds XSiteStatePushCommand used to transfer a single chunk of data between sites.
*
* @param chunk the data chunk
* @return the XSiteStatePushCommand created
*/
XSiteStatePushCommand buildXSiteStatePushCommand(XSiteState[] chunk);
/**
* Builds SingleRpcCommand used to perform {@link org.infinispan.commands.VisitableCommand} on the backup site,
* @param command the visitable command.
* @return the SingleXSiteRpcCommand created
*/
SingleXSiteRpcCommand buildSingleXSiteRpcCommand(VisitableCommand command);
/**
* Builds {@link org.infinispan.iteration.impl.EntryRequestCommand} used to request entries from a remote node for
* given segments
* @param identifier The unique identifier for this entry retrieval request
* @param segments The segments this request should retrieve
* @param filter The filter to apply to any found values to limit response data
* @param converter The converter to apply to any found values
* @param flags The flags used to modify behavior
* @param The key type of the stored key
* @param The value type of the stored values
* @param The converted type after the value is applied from the converter
* @return the EntryRequestCommand created
*/
EntryRequestCommand buildEntryRequestCommand(UUID identifier, Set segments,
KeyValueFilter filter,
Converter converter, Set flags);
/**
* Builds {@link org.infinispan.iteration.impl.EntryResponseCommand} use to respond with retrieved entries for
* given segments
* @param identifier The unique identifier for this entry retrieval request
* @param completedSegments The segments that are now completed per this response
* @param inDoubtSegments The segements that are now in doubt meaning they must be retrieved again from another
* node due to rehash
* @param values The entries retrieved from the remote node
* @param e If an exception occurred while running the processing on the remote node
* @param The key type of the stored key
* @param The converted type after the value is applied from the converter
* @return The EntryResponseCommand created
*/
EntryResponseCommand buildEntryResponseCommand(UUID identifier, Set completedSegments,
Set inDoubtSegments, Collection> values,
CacheException e);
/**
* Builds {@link org.infinispan.commands.remote.GetKeysInGroupCommand} used to fetch all the keys belonging to a group.
*
* @param flags
* @param groupName the group name.
* @return the GetKeysInGroup created.
*/
GetKeysInGroupCommand buildGetKeysInGroupCommand(Set flags, String groupName);
}
