Package org.onosproject.store.service

Interface StorageService

All Superinterfaces:

PrimitiveService

public interface StorageService
extends PrimitiveService

Storage service.

This service provides builders for various distributed primitives.

It is expected that services and applications will leverage the primitives indirectly provided by this service for their distributed state management and coordination.

Method Summary

Modifier and Type	Method	Description
AtomicCounterBuilder	atomicCounterBuilder()	Creates a new AtomicCounterBuilder.
<K> AtomicCounterMapBuilder<K>	atomicCounterMapBuilder()	Creates a new AtomicCounterMapBuilder.
AtomicIdGeneratorBuilder	atomicIdGeneratorBuilder()	Creates a new AtomicIdGeneratorBuilder.
<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.
<V> DocumentTreeBuilder<V>	documentTreeBuilder()	Creates a new ConsistentMapBuilder.
<K,V> EventuallyConsistentMapBuilder<K,V>	eventuallyConsistentMapBuilder()	Creates a new EventuallyConsistentMapBuilder.
default AsyncAtomicCounter	getAsyncAtomicCounter(java.lang.String name)	Returns an instance of AsyncAtomicCounter with specified name.
default AsyncAtomicIdGenerator	getAsyncAtomicIdGenerator(java.lang.String name)	Returns an instance of AsyncAtomicIdGenerator with specified name.
<K,V> AsyncConsistentMultimap<K,V>	getAsyncSetMultimap(java.lang.String name, Serializer serializer)	Returns a set backed instance of AsyncConsistentMultimap with the specified name.
<V> AsyncConsistentTreeMap<V>	getAsyncTreeMap(java.lang.String name, Serializer serializer)	Returns an instance of AsyncConsistentTreeMap with the specified name.
default AtomicCounter	getAtomicCounter(java.lang.String name)	Returns an instance of AtomicCounter with specified name.
default AtomicIdGenerator	getAtomicIdGenerator(java.lang.String name)	Returns an instance of AtomicIdGenerator with specified name.
<V> AsyncDocumentTree<V>	getDocumentTree(java.lang.String name, Serializer serializer)	Returns an instance of AsyncDocumentTree with specified name.
<T> Topic<T>	getTopic(java.lang.String name, Serializer serializer)	Returns an instance of Topic with specified name.
<E> WorkQueue<E>	getWorkQueue(java.lang.String name, Serializer serializer)	Returns an instance of WorkQueue with specified name.
LeaderElectorBuilder	leaderElectorBuilder()	Creates a new LeaderElectorBuilder.
DistributedLockBuilder	lockBuilder()	Creates a new DistributedLockBuilder.
<E> DistributedSetBuilder<E>	setBuilder()	Creates a new DistributedSetBuilder.
<T> TopicBuilder<T>	topicBuilder()	Creates a new TopicBuilder.
TransactionContextBuilder	transactionContextBuilder()	Creates a new transaction context builder.

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

workQueueBuilder

Method Detail

eventuallyConsistentMapBuilder

<K,V> EventuallyConsistentMapBuilder<K,V> eventuallyConsistentMapBuilder()

Creates a new EventuallyConsistentMapBuilder.

Specified by:

eventuallyConsistentMapBuilder in interface PrimitiveService

Type Parameters:

K - key type

V - value type

Returns:

builder for an eventually consistent map

consistentMapBuilder

<K,V> ConsistentMapBuilder<K,V> consistentMapBuilder()

Creates a new ConsistentMapBuilder.

Specified by:

consistentMapBuilder in interface PrimitiveService

Type Parameters:

K - key type

V - value type

Returns:

builder for a consistent map

documentTreeBuilder

<V> DocumentTreeBuilder<V> documentTreeBuilder()

Creates a new ConsistentMapBuilder.

Specified by:

documentTreeBuilder in interface PrimitiveService

Type Parameters:

V - value type

Returns:

builder for a consistent map

consistentTreeMapBuilder

<V> ConsistentTreeMapBuilder<V> consistentTreeMapBuilder()

Creates a new AsyncConsistentTreeMapBuilder.

Specified by:

consistentTreeMapBuilder in interface PrimitiveService

Type Parameters:

V - value type

Returns:

builder for a async consistent tree map

consistentMultimapBuilder

<K,V> ConsistentMultimapBuilder<K,V> consistentMultimapBuilder()

Creates a new AsyncConsistentSetMultimapBuilder.

Specified by:

consistentMultimapBuilder in interface PrimitiveService

Type Parameters:

K - key type

V - value type

Returns:

builder for a set based async consistent multimap

atomicCounterMapBuilder

<K> AtomicCounterMapBuilder<K> atomicCounterMapBuilder()

Creates a new AtomicCounterMapBuilder.

Specified by:

atomicCounterMapBuilder in interface PrimitiveService

Type Parameters:

K - key type

Returns:

builder for an atomic counter map

setBuilder

<E> DistributedSetBuilder<E> setBuilder()

Creates a new DistributedSetBuilder.

Specified by:

setBuilder in interface PrimitiveService

Type Parameters:

E - set element type

Returns:

builder for an distributed set

atomicCounterBuilder

AtomicCounterBuilder atomicCounterBuilder()

Creates a new AtomicCounterBuilder.

Specified by:

atomicCounterBuilder in interface PrimitiveService

Returns:

atomic counter builder

atomicIdGeneratorBuilder

AtomicIdGeneratorBuilder atomicIdGeneratorBuilder()

Creates a new AtomicIdGeneratorBuilder.

Specified by:

atomicIdGeneratorBuilder in interface PrimitiveService

Returns:

atomic ID generator builder

atomicValueBuilder

<V> AtomicValueBuilder<V> atomicValueBuilder()

Creates a new AtomicValueBuilder.

Specified by:

atomicValueBuilder in interface PrimitiveService

Type Parameters:

V - atomic value type

Returns:

atomic value builder

lockBuilder

DistributedLockBuilder lockBuilder()

Creates a new DistributedLockBuilder.

Returns:

lock builder

leaderElectorBuilder

LeaderElectorBuilder leaderElectorBuilder()

Creates a new LeaderElectorBuilder.

Specified by:

leaderElectorBuilder in interface PrimitiveService

Returns:

leader elector builder

topicBuilder

<T> TopicBuilder<T> topicBuilder()

Creates a new TopicBuilder.

Specified by:

topicBuilder in interface PrimitiveService

Type Parameters:

T - topic value type

Returns:

topic builder

transactionContextBuilder

TransactionContextBuilder transactionContextBuilder()

Creates a new transaction context builder.

Specified by:

transactionContextBuilder in interface PrimitiveService

Returns:

a builder for a transaction context.

getAsyncAtomicCounter

default AsyncAtomicCounter getAsyncAtomicCounter(java.lang.String name)

Returns an instance of AsyncAtomicCounter with specified name.

Specified by:

getAsyncAtomicCounter in interface PrimitiveService

Parameters:

name - counter name

Returns:

AsyncAtomicCounter instance

getAsyncAtomicIdGenerator

default AsyncAtomicIdGenerator getAsyncAtomicIdGenerator(java.lang.String name)

Returns an instance of AsyncAtomicIdGenerator with specified name.

Specified by:

getAsyncAtomicIdGenerator in interface PrimitiveService

Parameters:

name - ID generator name

Returns:

AsyncAtomicIdGenerator instance

getAtomicCounter

default AtomicCounter getAtomicCounter(java.lang.String name)

Returns an instance of AtomicCounter with specified name.

Specified by:

getAtomicCounter in interface PrimitiveService

Parameters:

name - counter name

Returns:

AtomicCounter instance

getAtomicIdGenerator

default AtomicIdGenerator getAtomicIdGenerator(java.lang.String name)

Returns an instance of AtomicIdGenerator with specified name.

Specified by:

getAtomicIdGenerator in interface PrimitiveService

Parameters:

name - ID generator name

Returns:

AtomicIdGenerator instance

getWorkQueue

<E> WorkQueue<E> getWorkQueue(java.lang.String name,
                              Serializer serializer)

Returns an instance of WorkQueue with specified name.

Specified by:

getWorkQueue in interface PrimitiveService

Type Parameters:

E - work element type

Parameters:

name - work queue name

serializer - serializer

Returns:

WorkQueue instance

getDocumentTree

<V> AsyncDocumentTree<V> getDocumentTree(java.lang.String name,
                                         Serializer serializer)

Returns an instance of AsyncDocumentTree with specified name.

Specified by:

getDocumentTree in interface PrimitiveService

Type Parameters:

V - tree node value type

Parameters:

name - document tree name

serializer - serializer

Returns:

AsyncDocumentTree instance

getAsyncSetMultimap

<K,V> AsyncConsistentMultimap<K,V> getAsyncSetMultimap(java.lang.String name,
                                                                   Serializer serializer)

Returns a set backed instance of AsyncConsistentMultimap with the specified name.

Specified by:

getAsyncSetMultimap in interface PrimitiveService

Type Parameters:

K - key type

V - value type

Parameters:

name - the multimap name

serializer - serializer

Returns:

set backed AsyncConsistentMultimap instance

getAsyncTreeMap

<V> AsyncConsistentTreeMap<V> getAsyncTreeMap(java.lang.String name,
                                              Serializer serializer)

Returns an instance of AsyncConsistentTreeMap with the specified name.

Specified by:

getAsyncTreeMap in interface PrimitiveService

Type Parameters:

V - value type

Parameters:

name - the treemap name

serializer - serializer

Returns:

set backed AsyncConsistentTreeMap instance

getTopic

<T> Topic<T> getTopic(java.lang.String name,
                      Serializer serializer)

Returns an instance of Topic with specified name.

Specified by:

getTopic in interface PrimitiveService

Type Parameters:

T - topic message type

Parameters:

name - topic name

serializer - serializer

Returns:

Topic instance