org.onosproject.store.consistent.impl

Class DefaultAsyncConsistentMap<K,V>

java.lang.Object

org.onosproject.store.consistent.impl.DefaultAsyncConsistentMap<K,V>

Type Parameters:

K - type of key.

V - type of value.

All Implemented Interfaces:

org.onosproject.store.service.AsyncConsistentMap<K,V>

Direct Known Subclasses:

AsyncCachingConsistentMap

public class DefaultAsyncConsistentMap<K,V>
extends Object
implements org.onosproject.store.service.AsyncConsistentMap<K,V>

AsyncConsistentMap implementation that is backed by a Raft consensus based database.

Constructor Summary

Constructors

Constructor and Description
DefaultAsyncConsistentMap(String name, org.onosproject.core.ApplicationId applicationId, Database database, org.onosproject.store.service.Serializer serializer, boolean readOnly, boolean purgeOnUninstall, boolean meteringEnabled)

Method Summary

Modifier and Type	Method and Description
void	addListener(org.onosproject.store.service.MapEventListener<K,V> listener)
org.onosproject.core.ApplicationId	applicationId() Returns the applicationId owning this map.
protected void	beforeUpdate(K key) Pre-update hook for performing required checks/actions before going forward with an update operation.
CompletableFuture<Void>	clear()
CompletableFuture<org.onosproject.store.service.Versioned<V>>	compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
CompletableFuture<org.onosproject.store.service.Versioned<V>>	computeIf(K key, Predicate<? super V> condition, BiFunction<? super K,? super V,? extends V> remappingFunction)
CompletableFuture<org.onosproject.store.service.Versioned<V>>	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)
CompletableFuture<org.onosproject.store.service.Versioned<V>>	computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)
CompletableFuture<Boolean>	containsKey(K key)
CompletableFuture<Boolean>	containsValue(V value)
protected K	dK(String key)
CompletableFuture<Set<Map.Entry<K,org.onosproject.store.service.Versioned<V>>>>	entrySet()
CompletableFuture<org.onosproject.store.service.Versioned<V>>	get(K key)
CompletableFuture<Boolean>	isEmpty()
CompletableFuture<Set<K>>	keySet()
String	name() Returns this map name.
protected void	notifyListeners(org.onosproject.store.service.MapEvent<K,V> event)
boolean	purgeOnUninstall() Returns whether the map entries should be purged when the application owning it is uninstalled.
CompletableFuture<org.onosproject.store.service.Versioned<V>>	put(K key, V value)
CompletableFuture<org.onosproject.store.service.Versioned<V>>	putAndGet(K key, V value)
CompletableFuture<org.onosproject.store.service.Versioned<V>>	putIfAbsent(K key, V value)
CompletableFuture<org.onosproject.store.service.Versioned<V>>	remove(K key)
CompletableFuture<Boolean>	remove(K key, long version)
CompletableFuture<Boolean>	remove(K key, V value)
void	removeListener(org.onosproject.store.service.MapEventListener<K,V> listener)
CompletableFuture<Boolean>	replace(K key, long oldVersion, V newValue)
CompletableFuture<Boolean>	replace(K key, V oldValue, V newValue)
org.onosproject.store.service.Serializer	serializer() Returns the serializer for map entries.
CompletableFuture<Integer>	size()
protected String	sK(K key)
CompletableFuture<Collection<org.onosproject.store.service.Versioned<V>>>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultAsyncConsistentMap

public DefaultAsyncConsistentMap(String name,
                                 org.onosproject.core.ApplicationId applicationId,
                                 Database database,
                                 org.onosproject.store.service.Serializer serializer,
                                 boolean readOnly,
                                 boolean purgeOnUninstall,
                                 boolean meteringEnabled)

Method Detail

sK

protected String sK(K key)

dK

protected K dK(String key)

name

public String name()

Returns this map name.

Returns:

map name

serializer

public org.onosproject.store.service.Serializer serializer()

Returns the serializer for map entries.

Returns:

map entry serializer

applicationId

public org.onosproject.core.ApplicationId applicationId()

Returns the applicationId owning this map.

Returns:

application Id

purgeOnUninstall

public boolean purgeOnUninstall()

Returns whether the map entries should be purged when the application owning it is uninstalled.

Returns:

true is map needs to cleared on app uninstall; false otherwise

size

public CompletableFuture<Integer> size()

Specified by:

size in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

isEmpty

public CompletableFuture<Boolean> isEmpty()

Specified by:

isEmpty in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

containsKey

public CompletableFuture<Boolean> containsKey(K key)

Specified by:

containsKey in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

containsValue

public CompletableFuture<Boolean> containsValue(V value)

Specified by:

containsValue in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

get

public CompletableFuture<org.onosproject.store.service.Versioned<V>> get(K key)

Specified by:

get in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

computeIfAbsent

public CompletableFuture<org.onosproject.store.service.Versioned<V>> computeIfAbsent(K key,
                                                                                     Function<? super K,? extends V> mappingFunction)

Specified by:

computeIfAbsent in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

computeIfPresent

public CompletableFuture<org.onosproject.store.service.Versioned<V>> computeIfPresent(K key,
                                                                                      BiFunction<? super K,? super V,? extends V> remappingFunction)

Specified by:

computeIfPresent in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

compute

public CompletableFuture<org.onosproject.store.service.Versioned<V>> compute(K key,
                                                                             BiFunction<? super K,? super V,? extends V> remappingFunction)

Specified by:

compute in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

computeIf

public CompletableFuture<org.onosproject.store.service.Versioned<V>> computeIf(K key,
                                                                               Predicate<? super V> condition,
                                                                               BiFunction<? super K,? super V,? extends V> remappingFunction)

Specified by:

computeIf in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

put

public CompletableFuture<org.onosproject.store.service.Versioned<V>> put(K key,
                                                                         V value)

Specified by:

put in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

putAndGet

public CompletableFuture<org.onosproject.store.service.Versioned<V>> putAndGet(K key,
                                                                               V value)

Specified by:

putAndGet in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

remove

public CompletableFuture<org.onosproject.store.service.Versioned<V>> remove(K key)

Specified by:

remove in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

clear

public CompletableFuture<Void> clear()

Specified by:

clear in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

keySet

public CompletableFuture<Set<K>> keySet()

Specified by:

keySet in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

values

public CompletableFuture<Collection<org.onosproject.store.service.Versioned<V>>> values()

Specified by:

values in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

entrySet

public CompletableFuture<Set<Map.Entry<K,org.onosproject.store.service.Versioned<V>>>> entrySet()

Specified by:

entrySet in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

putIfAbsent

public CompletableFuture<org.onosproject.store.service.Versioned<V>> putIfAbsent(K key,
                                                                                 V value)

Specified by:

putIfAbsent in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

remove

public CompletableFuture<Boolean> remove(K key,
                                         V value)

Specified by:

remove in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

remove

public CompletableFuture<Boolean> remove(K key,
                                         long version)

Specified by:

remove in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

replace

public CompletableFuture<Boolean> replace(K key,
                                          V oldValue,
                                          V newValue)

Specified by:

replace in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

replace

public CompletableFuture<Boolean> replace(K key,
                                          long oldVersion,
                                          V newValue)

Specified by:

replace in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

beforeUpdate

protected void beforeUpdate(K key)

Pre-update hook for performing required checks/actions before going forward with an update operation.

Parameters:

key - map key.

addListener

public void addListener(org.onosproject.store.service.MapEventListener<K,V> listener)

Specified by:

addListener in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

removeListener

public void removeListener(org.onosproject.store.service.MapEventListener<K,V> listener)

Specified by:

removeListener in interface org.onosproject.store.service.AsyncConsistentMap<K,V>

notifyListeners

protected void notifyListeners(org.onosproject.store.service.MapEvent<K,V> event)