StorageManager (onos-apps-fwd)

java.lang.Object
- org.onosproject.store.primitives.impl.StorageManager

All Implemented Interfaces:

StorageAdminService, StorageService
```
@Service
public class StorageManager
extends Object
implements StorageService, StorageAdminService
```
Implementation for StorageService and StorageAdminService.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ClusterCommunicationService`	`clusterCommunicator`
`protected ClusterService`	`clusterService`
`protected PartitionAdminService`	`partitionAdminService`
`protected PartitionService`	`partitionService`
`protected PersistenceService`	`persistenceService`

Constructor Summary

Constructors
Constructor and Description

StorageManager()

Constructors
Constructor and Description
`StorageManager()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()`
`AtomicCounterBuilder`	`atomicCounterBuilder()` Creates a new AtomicCounterBuilder.
`<K> AtomicCounterMapBuilder<K>`	`atomicCounterMapBuilder()` Creates a new `AtomicCounterMapBuilder`.
`<V> AtomicValueBuilder<V>`	`atomicValueBuilder()` Creates a new AtomicValueBuilder.
`<K,V> ConsistentMapBuilder<K,V>`	`consistentMapBuilder()` Creates a new ConsistentMapBuilder.
`<K,V> ConsistentMultimapBuilder<K,V>`	`consistentMultimapBuilder()` Creates a new `AsyncConsistentSetMultimapBuilder`.
`<V> ConsistentTreeMapBuilder<V>`	`consistentTreeMapBuilder()` Creates a new `AsyncConsistentTreeMapBuilder`.
`void`	`deactivate()`
`<V> DocumentTreeBuilder<V>`	`documentTreeBuilder()` Creates a new ConsistentMapBuilder.
`<K,V> EventuallyConsistentMapBuilder<K,V>`	`eventuallyConsistentMapBuilder()` Creates a new EventuallyConsistentMapBuilder.
`<K,V> AsyncConsistentMultimap<K,V>`	`getAsyncSetMultimap(String name, Serializer serializer)` Returns a set backed instance of `AsyncConsistentMultimap` with the specified name.
`<V> AsyncConsistentTreeMap<V>`	`getAsyncTreeMap(String name, Serializer serializer)` Returns an instance of `AsyncConsistentTreeMap` with the specified name.
`Map<String,Long>`	`getCounters()` Returns information about all the atomic counters in the system.
`<V> AsyncDocumentTree<V>`	`getDocumentTree(String name, Serializer serializer)` Returns an instance of `AsyncDocumentTree` with specified name.
`List<MapInfo>`	`getMapInfo()` Returns information about all the consistent maps in the system.
`List<PartitionInfo>`	`getPartitionInfo()` Returns information about all partitions in the system.
`Collection<TransactionId>`	`getPendingTransactions()` Returns all pending transactions.
`Map<String,WorkQueueStats>`	`getQueueStats()` Returns statistics for all the work queues in the system.
`<T> Topic<T>`	`getTopic(String name, Serializer serializer)` Returns an instance of `Topic` with specified name.
`<E> WorkQueue<E>`	`getWorkQueue(String name, Serializer serializer)` Returns an instance of `WorkQueue` with specified name.
`LeaderElectorBuilder`	`leaderElectorBuilder()` Creates a new LeaderElectorBuilder.
`<E> DistributedSetBuilder<E>`	`setBuilder()` Creates a new DistributedSetBuilder.
`TransactionContextBuilder`	`transactionContextBuilder()` Creates a new transaction context builder.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.onosproject.store.service.StorageService
getAsyncAtomicCounter, getAtomicCounter

- Field Detail
  - clusterService
```
@Reference(cardinality=MANDATORY_UNARY)
protected ClusterService clusterService
```
  - clusterCommunicator
```
@Reference(cardinality=MANDATORY_UNARY)
protected ClusterCommunicationService clusterCommunicator
```
  - persistenceService
```
@Reference(cardinality=MANDATORY_UNARY)
protected PersistenceService persistenceService
```
  - partitionService
```
@Reference(cardinality=MANDATORY_UNARY)
protected PartitionService partitionService
```
  - partitionAdminService
```
@Reference(cardinality=MANDATORY_UNARY)
protected PartitionAdminService partitionAdminService
```
- Constructor Detail
  - StorageManager
```
public StorageManager()
```
- Method Detail
  - activate
```
@Activate
public void activate()
```
  - deactivate
```
@Deactivate
public void deactivate()
```
  - eventuallyConsistentMapBuilder
```
public <K,V> EventuallyConsistentMapBuilder<K,V> eventuallyConsistentMapBuilder()
```
    Description copied from interface: StorageService
    
    Creates a new EventuallyConsistentMapBuilder.
    
    Specified by:
    
    eventuallyConsistentMapBuilder in interface StorageService
    
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Returns:
    
    builder for an eventually consistent map
  - consistentMapBuilder
```
public <K,V> ConsistentMapBuilder<K,V> consistentMapBuilder()
```
    Description copied from interface: StorageService
    
    Creates a new ConsistentMapBuilder.
    
    Specified by:
    
    consistentMapBuilder in interface StorageService
    
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Returns:
    
    builder for a consistent map
  - documentTreeBuilder
```
public <V> DocumentTreeBuilder<V> documentTreeBuilder()
```
    Description copied from interface: StorageService
    
    Creates a new ConsistentMapBuilder.
    
    Specified by:
    
    documentTreeBuilder in interface StorageService
    
    Type Parameters:
    
    V - value type
    
    Returns:
    
    builder for a consistent map
  - consistentTreeMapBuilder
```
public <V> ConsistentTreeMapBuilder<V> consistentTreeMapBuilder()
```
    Description copied from interface: StorageService
    
    Creates a new AsyncConsistentTreeMapBuilder.
    
    Specified by:
    
    consistentTreeMapBuilder in interface StorageService
    
    Type Parameters:
    
    V - value type
    
    Returns:
    
    builder for a async consistent tree map
  - consistentMultimapBuilder
```
public <K,V> ConsistentMultimapBuilder<K,V> consistentMultimapBuilder()
```
    Description copied from interface: StorageService
    
    Creates a new AsyncConsistentSetMultimapBuilder.
    
    Specified by:
    
    consistentMultimapBuilder in interface StorageService
    
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Returns:
    
    builder for a set based async consistent multimap
  - atomicCounterMapBuilder
```
public <K> AtomicCounterMapBuilder<K> atomicCounterMapBuilder()
```
    Description copied from interface: StorageService
    
    Creates a new AtomicCounterMapBuilder.
    
    Specified by:
    
    atomicCounterMapBuilder in interface StorageService
    
    Type Parameters:
    
    K - key type
    
    Returns:
    
    builder for an atomic counter map
  - setBuilder
```
public <E> DistributedSetBuilder<E> setBuilder()
```
    Description copied from interface: StorageService
    
    Creates a new DistributedSetBuilder.
    
    Specified by:
    
    setBuilder in interface StorageService
    
    Type Parameters:
    
    E - set element type
    
    Returns:
    
    builder for an distributed set
  - atomicCounterBuilder
```
public AtomicCounterBuilder atomicCounterBuilder()
```
    Description copied from interface: StorageService
    
    Creates a new AtomicCounterBuilder.
    
    Specified by:
    
    atomicCounterBuilder in interface StorageService
    
    Returns:
    
    atomic counter builder
  - atomicValueBuilder
```
public <V> AtomicValueBuilder<V> atomicValueBuilder()
```
    Description copied from interface: StorageService
    
    Creates a new AtomicValueBuilder.
    
    Specified by:
    
    atomicValueBuilder in interface StorageService
    
    Type Parameters:
    
    V - atomic value type
    
    Returns:
    
    atomic value builder
  - transactionContextBuilder
```
public TransactionContextBuilder transactionContextBuilder()
```
    Description copied from interface: StorageService
    
    Creates a new transaction context builder.
    
    Specified by:
    
    transactionContextBuilder in interface StorageService
    
    Returns:
    
    a builder for a transaction context.
  - leaderElectorBuilder
```
public LeaderElectorBuilder leaderElectorBuilder()
```
    Description copied from interface: StorageService
    
    Creates a new LeaderElectorBuilder.
    
    Specified by:
    
    leaderElectorBuilder in interface StorageService
    
    Returns:
    
    leader elector builder
  - getWorkQueue
```
public <E> WorkQueue<E> getWorkQueue(String name,
                                     Serializer serializer)
```
    Description copied from interface: StorageService
    
    Returns an instance of WorkQueue with specified name.
    
    Specified by:
    
    getWorkQueue in interface StorageService
    
    Type Parameters:
    
    E - work element type
    
    Parameters:
    
    name - work queue name
    
    serializer - serializer
    
    Returns:
    
    WorkQueue instance
  - getDocumentTree
```
public <V> AsyncDocumentTree<V> getDocumentTree(String name,
                                                Serializer serializer)
```
    Description copied from interface: StorageService
    
    Returns an instance of AsyncDocumentTree with specified name.
    
    Specified by:
    
    getDocumentTree in interface StorageService
    
    Type Parameters:
    
    V - tree node value type
    
    Parameters:
    
    name - document tree name
    
    serializer - serializer
    
    Returns:
    
    AsyncDocumentTree instance
  - getAsyncSetMultimap
```
public <K,V> AsyncConsistentMultimap<K,V> getAsyncSetMultimap(String name,
                                                              Serializer serializer)
```
    Description copied from interface: StorageService
    
    Returns a set backed instance of AsyncConsistentMultimap with the specified name.
    
    Specified by:
    
    getAsyncSetMultimap in interface StorageService
    
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Parameters:
    
    name - the multimap name
    
    serializer - serializer
    
    Returns:
    
    set backed AsyncConsistentMultimap instance
  - getAsyncTreeMap
```
public <V> AsyncConsistentTreeMap<V> getAsyncTreeMap(String name,
                                                     Serializer serializer)
```
    Description copied from interface: StorageService
    
    Returns an instance of AsyncConsistentTreeMap with the specified name.
    
    Specified by:
    
    getAsyncTreeMap in interface StorageService
    
    Type Parameters:
    
    V - value type
    
    Parameters:
    
    name - the treemap name
    
    serializer - serializer
    
    Returns:
    
    set backed AsyncConsistentTreeMap instance
  - getMapInfo
```
public List<MapInfo> getMapInfo()
```
    Description copied from interface: StorageAdminService
    
    Returns information about all the consistent maps in the system.
    
    Specified by:
    
    getMapInfo in interface StorageAdminService
    
    Returns:
    
    list of map information
  - getCounters
```
public Map<String,Long> getCounters()
```
    Description copied from interface: StorageAdminService
    
    Returns information about all the atomic counters in the system.
    
    Specified by:
    
    getCounters in interface StorageAdminService
    
    Returns:
    
    mapping from counter name to that counter's next value
  - getQueueStats
```
public Map<String,WorkQueueStats> getQueueStats()
```
    Description copied from interface: StorageAdminService
    
    Returns statistics for all the work queues in the system.
    
    Specified by:
    
    getQueueStats in interface StorageAdminService
    
    Returns:
    
    mapping from queue name to that queue's stats
  - getPartitionInfo
```
public List<PartitionInfo> getPartitionInfo()
```
    Description copied from interface: StorageAdminService
    
    Returns information about all partitions in the system.
    
    Specified by:
    
    getPartitionInfo in interface StorageAdminService
    
    Returns:
    
    list of partition information
  - getPendingTransactions
```
public Collection<TransactionId> getPendingTransactions()
```
    Description copied from interface: StorageAdminService
    
    Returns all pending transactions.
    
    Specified by:
    
    getPendingTransactions in interface StorageAdminService
    
    Returns:
    
    collection of pending transaction identifiers.
  - getTopic
```
public <T> Topic<T> getTopic(String name,
                             Serializer serializer)
```
    Description copied from interface: StorageService
    
    Returns an instance of Topic with specified name.
    
    Specified by:
    
    getTopic in interface StorageService
    
    Type Parameters:
    
    T - topic message type
    
    Parameters:
    
    name - topic name
    
    serializer - serializer
    
    Returns:
    
    Topic instance

Class StorageManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.onosproject.store.service.StorageService

Field Detail

clusterService

clusterCommunicator

persistenceService

partitionService

partitionAdminService

Constructor Detail

StorageManager

Method Detail

activate

deactivate

eventuallyConsistentMapBuilder

consistentMapBuilder

documentTreeBuilder

consistentTreeMapBuilder

consistentMultimapBuilder

atomicCounterMapBuilder

setBuilder

atomicCounterBuilder

atomicValueBuilder

transactionContextBuilder

leaderElectorBuilder

getWorkQueue

getDocumentTree

getAsyncSetMultimap

getAsyncTreeMap

getMapInfo

getCounters

getQueueStats

getPartitionInfo

getPendingTransactions

getTopic