Module datarush.commons

Package com.pervasive.datarush.cal

Provides interfaces the define the "cluster abstraction layer".

NOTE: the interfaces in this package should be considered unstable.

The cluster abstraction layer allows the DataRush engine to be implemented on any cluster. In order to provide an implementation for a new type of cluster one needs to register a new ClusterProvider and, optionally, a StorageManagerProvider.

Interface Summary

Interface	Description
ClusterProvider	Extension point to register cluster providers for new schemes.
DistributedCallable<T>	A distributed equivalent of a Callable.
DistributedCallableBatch<R>	A distributed equivalent of a Callable.
DistributedCallableContext	Distributed context passed to DistributedCallable.init(DistributedCallableContext).
DistributedCallableContextBatch	Distributed context passed to DistributedCallableBatch.init(DistributedCallableContextBatch).
DistributedExecutorService	Distributed equivalent of the ExecutorService concept.
JobCallable<T>
JobContext	Context available to job.
JobExecutorService	Client-side API for submitting units of work to the job master.
JobHistoryService
MonitoredCallable<T>	Extension of Callable that provides a way to get its current status prior to execution completion.
MonitoredFuture<T>	Extension of Future that allows the client to query for the partial status.
PseudoDistributedExecutorService	Subinterface of DistributedExecutorService for running in pseudo-distributed mode.
ResultMerger<R>
StorageManager	A manager of intermediate storage.
StorageManagerProvider	Extension point to register a new StorageManager type.

Class Summary

Class	Description
AttributeScope	A session qualifier to provide uniqueness of session attributes.
ClasspathSpecifier	The classpath specifies for a job.
ClasspathSpecifier.Element	An element of a classpath.
ClusterProviderManager	Facade to lookup providers from META-INF/services.
ClusterSpecifier	A "URL-like" entity that identifies a cluster.
DistributedCommand<T>	Convenient base class for DistributedCallable's that do not support monitoring/partial results.
DistributedCommandBatch<T>	Convenient base class for DistributedCallableBatch's that do not support monitoring/partial results.
ExecutionOptions	Miscellaneous execution options.
ExecutionUtil	Miscellaneous utilities related to DistributedExecutorService and its subordinate classes.
JobExecutorServiceFactory	Factory for creating new JobExecutorService's.
JobInformation	Basic job information that contains the job name, id, and the user that submitted the job.
JobLogInfo
JobLogInfo.LogInfo
JobServerInformation
JobSpecifier	Rollup of all parameters needed to launch a job
NodeAllocationPlan	Represents the initial node allocation.
NodeAllocationPlan.AssignmentPlan	Assignment details for a particular node ID.
NodeAllocationState	Reflects the current state of node allocation, which takes into account failed nodes.
NodeAllocationState.AssignmentState	Assignment details for a particular node ID.
NodeInformation	Contains node and host information
NodeInformationMapping	Contains host information associated with the nodes in the cluster that the current job is running on.
OSGIOptions	Extra options for an OSGI classpath element
PartitionInstanceInfo	Information pertaining to an instance of a partitioning operation.
ResourceAllocation	Describes the resource allocation for a job server process.
ResourceSpecifier	Resource specifier for the resources needed by a job.
SessionAttribute<T>	Provides a key for a session attribute and, optionally, an initial value
StorageBucket	Convenient pairing of StorageBucketId and it's associated StorageManager.
StorageBucketId	A storage bucket represents one unit of work to be exchanged by nodes in the cluster.
StorageManagers	Utilities for creating storage managers
StorageManagerSpecifier	Rollup of the various parameters needed to create a StorageManager.
StoragePlanner	An allocator of StorageBucketId's.
VirtualNodeID	Identifies a "virtual node" in a cluster.

Enum Summary

Enum	Description
CacheScopeSpecifier	Enumeration of possible caches for Element's.
JobStatus
VirtualNodeType	Enumeration of non-parallel locations
WorkerRole

Exception Summary

Exception	Description
BatchExecutionException	Subclass of DistributedExecutionException that contains all the exceptions that occurred in one batch.
DistributedExecutionException	An ExecutionException in a distributed context.