Package org.onosproject.store.service
Distributed core state management services.
-
Interface Summary Interface Description AsyncAtomicCounter An async atomic counter dispenses monotonically increasing values.AsyncAtomicCounterMap<K> An async atomic counter map dispenses monotonically increasing values associated with key.AsyncAtomicIdGenerator An async ID generator for generating globally unique numbers.AsyncAtomicValue<V> Distributed version of java.util.concurrent.atomic.AtomicReference.AsyncConsistentMap<K,V> A distributed, strongly consistent map whose methods are all executed asynchronously.AsyncConsistentMultimap<K,V> Interface for a distributed multimap.AsyncConsistentTreeMap<V> API for a distributed tree map implementation.AsyncDistributedLock Asynchronous lock primitive.AsyncDistributedSet<E> A distributed collection designed for holding unique elements.AsyncDocumentTree<V> A hierarchical document tree data structure.AsyncIterable<T> Asynchronously iterable object.AsyncIterator<T> Asynchronous iterator.AsyncLeaderElector Distributed mutual exclusion primitive.AtomicCounter Distributed version of java.util.concurrent.atomic.AtomicLong.AtomicCounterMap<K> Distributed version of com.google.common.util.concurrent.AtomicLongMap.AtomicIdGenerator Generator for globally unique numeric identifiers.AtomicValue<V> Distributed version of java.util.concurrent.atomic.AtomicReference.AtomicValueEventListener<V> Listener to be notified about updates to a AtomicValue.ConsistentMap<K,V> ConsistentMap
provides the same functionality asAsyncConsistentMap
with the only difference that all its methods block until the corresponding operation completes.ConsistentMultimap<K,V> This provides a synchronous version of the functionality provided byAsyncConsistentMultimap
.ConsistentTreeMap<V> Tree map interface counterpart toAsyncConsistentTreeMap
.CoordinationService Cross-version storage/coordination service.DistributedLock Asynchronous lock primitive.DistributedPrimitive Interface for all distributed primitives.DistributedSet<E> A distributed collection designed for holding unique elements.DocumentTree<V> A hierarchical document tree data structure.DocumentTreeListener<V> A listener forDocumentTreeEvent
.DocumentTreeNode<V> ADocumentTree
node.EventuallyConsistentMap<K,V> A distributed, eventually consistent map.EventuallyConsistentMapBuilder<K,V> Builder for eventually consistent maps.EventuallyConsistentMapListener<K,V> Listener to be notified about updates to a EventuallyConsistentMap.LeaderElector LeaderElector
provides the same functionality asAsyncLeaderElector
with the only difference that all its methods block until the corresponding operation completes.LogicalClockService Service that issues logical timestamps.MapEventListener<K,V> Listener to be notified about updates to a ConsistentMap.MultimapEventListener<K,V> Listener to be notified about updates to a ConsistentMultimap.MutexTask The MutexTask interface should be implemented by any class whose instances distributed across controllers are intended to be executed in a mutually exclusive fashion.PrimitiveService Primitive service.Serializer Interface for serialization of store artifacts.SetEventListener<E> Listener to be notified about updates to a DistributedSet.StorageAdminService Service for administering storage instances.StorageService Storage service.Topic<T> A distributed publish subscribe primitive.Transactional<T> Interface for transactional primitives.TransactionalMap<K,V> Transactional Map data structure.TransactionalSet<E> Transactional Set data structure.TransactionContext Provides a context for transactional operations.WorkQueue<E> Distributed Work Queue primitive. -
Class Summary Class Description AtomicCounterBuilder Builder for AtomicCounter.AtomicCounterMapBuilder<K> Builder for AtomicCounterMap.AtomicCounterMapOptions<O extends AtomicCounterMapOptions<O,K>,K> Builder for AtomicCounterMap.AtomicCounterOptions<O extends AtomicCounterOptions<O>> Options for AtomicCounter.AtomicIdGeneratorBuilder Builder for AtomicIdGenerator.AtomicIdGeneratorOptions<O extends AtomicIdGeneratorOptions<O>> Options for AtomicIdGenerator.AtomicValueBuilder<V> Builder for constructing new AtomicValue instances.AtomicValueEvent<V> Representation of a AtomicValue update notification.AtomicValueOptions<O extends AtomicValueOptions<O,V>,V> Builder for constructing new AtomicValue instances.ConsistentMapBuilder<K,V> Builder forConsistentMap
instances.ConsistentMapOptions<O extends ConsistentMapOptions<O,K,V>,K,V> Builder forConsistentMap
instances.ConsistentMultimapBuilder<K,V> A builder class forAsyncConsistentMultimap
.ConsistentMultimapOptions<O extends ConsistentMultimapOptions<O,K,V>,K,V> A builder class forAsyncConsistentMultimap
.ConsistentTreeMapBuilder<V> Builder forConsistentTreeMap
.ConsistentTreeMapOptions<O extends ConsistentTreeMapOptions<O,V>,V> Builder forConsistentTreeMap
.DistributedLockBuilder Builder for DistributedLock.DistributedLockOptions<O extends DistributedLockOptions<O>> Builder for DistributedLock.DistributedSetBuilder<E> Builder for distributed set.DistributedSetOptions<O extends DistributedSetOptions<O,E>,E> Builder for distributed set.DocumentPath Unique key for nodes in theDocumentTree
.DocumentTreeBuilder<V> Builder forDocumentTree
.DocumentTreeEvent<V> A document tree modification event.DocumentTreeOptions<O extends DocumentTreeOptions<O,V>,V> Builder forDocumentTree
.EventuallyConsistentMapEvent<K,V> Representation of a EventuallyConsistentMap update notification.LeaderElectorBuilder Builder for constructing newAsyncLeaderElector
instances.LeaderElectorOptions<O extends LeaderElectorOptions<O>> Builder for constructing newAsyncLeaderElector
instances.MapEvent<K,V> Representation of a ConsistentMap update notification.MapInfo Metadata information for a consistent map.MultimapEvent<K,V> Representation of a ConsistentMultimap update notification.MultiValuedTimestamp<T extends java.lang.Comparable<T>,U extends java.lang.Comparable<U>> A logical timestamp that derives its value from two input values.PartitionClientInfo Contains information about a database partition client.PartitionInfo Contains information about a database partition.SetEvent<E> Representation of a DistributedSet update notification.Synchronous<T extends DistributedPrimitive> DistributedPrimitive that is a synchronous (blocking) version of another.Task<E> WorkQueue
task.TopicBuilder<T> Builder forTopic
instances.TopicOptions<O extends TopicOptions<O,T>,T> Builder forTopic
instances.TransactionContextBuilder Abstract base class for a transaction context builder.TransactionContextOptions<O extends TransactionContextOptions<O>> Abstract base class for a transaction context builder.TransactionLog<T> Collection of transaction updates to be applied atomically.Version Logical timestamp for versions.Versioned<V> Versioned value.WallClockTimestamp A Timestamp that derives its value from the prevailing wallclock time on the controller where it is generated.WorkQueueBuilder<E> Builder for WorkQueue.WorkQueueOptions<O extends WorkQueueOptions<O,E>,E> Builder for WorkQueue.WorkQueueStats Statistics for aWorkQueue
.WorkQueueStats.Builder -
Enum Summary Enum Description AtomicValueEvent.Type AtomicValueEvent type.CommitStatus Completion status of transaction.DistributedPrimitive.Status Status of distributed primitive.DistributedPrimitive.Type Type of distributed primitive.DocumentTreeEvent.Type Nature of document tree node change.EventuallyConsistentMapEvent.Type MapEvent.Type MapEvent type.MultimapEvent.Type MultimapEvent type.Ordering Describes the order of a primitive data structure.RevisionType Distributed primitive revision types.SetEvent.Type SetEvent type. -
Exception Summary Exception Description ConsistentMapException Top level exception for ConsistentMap failures.ConsistentMapException.ConcurrentModification ConsistentMap update conflicts with an in flight transaction.ConsistentMapException.Interrupted ConsistentMap operation interrupted.ConsistentMapException.Timeout ConsistentMap operation timeout.DocumentException Exceptions for use by theDocumentTree
andDocumentPath
.DocumentException.Interrupted DocumentTree operation interrupted.DocumentException.Timeout DocumentTree operation timeout.IllegalDocumentModificationException An exception to be thrown when a node cannot be removed normally because it does not exist or because it is not a leaf node.IllegalDocumentNameException An exception thrown when an illegally named node is submitted.NoSuchDocumentPathException An exception to be thrown when an invalid path is passed to theDocumentTree
.StorageException Top level exception for Store failures.StorageException.ConcurrentModification Store update conflicts with an in flight transaction.StorageException.Interrupted Store operation interrupted.StorageException.Timeout Store operation timeout.StorageException.Unavailable Store is temporarily unavailable.TransactionException Top level exception for Transaction failures.TransactionException.ConcurrentModification Transaction failure due to a conflicting transaction in progress.TransactionException.Interrupted Transaction interrupted.TransactionException.OptimisticConcurrencyFailure Transaction failure due to optimistic concurrency violation.TransactionException.Timeout Transaction timeout.