org.onosproject.store.consistent.impl

Interface DatabaseProxy<K,V>

All Known Subinterfaces:

Database

All Known Implementing Classes:

DefaultDatabase, PartitionedDatabase

public interface DatabaseProxy<K,V>

Database proxy.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Result<Void>>	clear(String tableName) Clears the table.
CompletableFuture<Boolean>	commit(org.onosproject.store.service.Transaction transaction) Commit the specified transaction.
CompletableFuture<Boolean>	containsKey(String tableName, K key) Checks whether the table contains a key.
CompletableFuture<Boolean>	containsValue(String tableName, V value) Checks whether the table contains a value.
CompletableFuture<Long>	counterAddAndGet(String counterName, long delta) Atomically add the given value to current value of the specified counter.
CompletableFuture<Long>	counterGet(String counterName) Returns the current value of the specified atomic counter.
CompletableFuture<Long>	counterGetAndAdd(String counterName, long delta) Atomically add the given value to current value of the specified counter.
CompletableFuture<Map<String,Long>>	counters() Returns a mapping from counter name to next value.
CompletableFuture<Set<Map.Entry<K,org.onosproject.store.service.Versioned<V>>>>	entrySet(String tableName) Gets a set of entries in the table.
CompletableFuture<org.onosproject.store.service.Versioned<V>>	get(String tableName, K key) Gets a value from the table.
CompletableFuture<Boolean>	isEmpty(String tableName) Checks whether the table is empty.
CompletableFuture<Set<K>>	keySet(String tableName) Gets a set of keys in the table.
CompletableFuture<Boolean>	prepare(org.onosproject.store.service.Transaction transaction) Prepare the specified transaction for commit.
CompletableFuture<Boolean>	prepareAndCommit(org.onosproject.store.service.Transaction transaction) Prepare and commit the specified transaction.
CompletableFuture<Result<org.onosproject.store.service.Versioned<V>>>	put(String tableName, K key, V value) Puts a value in the table.
CompletableFuture<Result<UpdateResult<org.onosproject.store.service.Versioned<V>>>>	putAndGet(String tableName, K key, V value) Puts a value in the table.
CompletableFuture<Result<org.onosproject.store.service.Versioned<V>>>	putIfAbsent(String tableName, K key, V value) Puts a value in the table if the given key does not exist.
CompletableFuture<Result<UpdateResult<org.onosproject.store.service.Versioned<V>>>>	putIfAbsentAndGet(String tableName, K key, V value) Puts a value in the table.
CompletableFuture<Result<org.onosproject.store.service.Versioned<V>>>	remove(String tableName, K key) Removes a value from the table.
CompletableFuture<Result<Boolean>>	remove(String tableName, K key, long version) Removes a key and if the existing version for that key matches the specified version.
CompletableFuture<Result<Boolean>>	remove(String tableName, K key, V value) Removes a key and if the existing value for that key matches the specified value.
CompletableFuture<Result<Boolean>>	replace(String tableName, K key, long oldVersion, V newValue) Replaces the entry for the specified key only if currently mapped to the specified version.
CompletableFuture<Result<Boolean>>	replace(String tableName, K key, V oldValue, V newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
CompletableFuture<Result<UpdateResult<org.onosproject.store.service.Versioned<V>>>>	replaceAndGet(String tableName, K key, long oldVersion, V newValue) Replaces the entry for the specified key only if currently mapped to the specified version.
CompletableFuture<Boolean>	rollback(org.onosproject.store.service.Transaction transaction) Rollback the specified transaction.
CompletableFuture<Integer>	size(String tableName) Gets the table size.
CompletableFuture<Set<String>>	tableNames() Returns a set of all tables names.
CompletableFuture<Collection<org.onosproject.store.service.Versioned<V>>>	values(String tableName) Gets a collection of values in the table.

Method Detail

tableNames

CompletableFuture<Set<String>> tableNames()

Returns a set of all tables names.

Returns:

A completable future to be completed with the result once complete.

counters

CompletableFuture<Map<String,Long>> counters()

Returns a mapping from counter name to next value.

Returns:

A completable future to be completed with the result once complete.

size

CompletableFuture<Integer> size(String tableName)

Gets the table size.

Parameters:

tableName - table name

Returns:

A completable future to be completed with the result once complete.

isEmpty

CompletableFuture<Boolean> isEmpty(String tableName)

Checks whether the table is empty.

Parameters:

tableName - table name

Returns:

A completable future to be completed with the result once complete.

containsKey

CompletableFuture<Boolean> containsKey(String tableName,
                                       K key)

Checks whether the table contains a key.

Parameters:

tableName - table name

key - The key to check.

Returns:

A completable future to be completed with the result once complete.

containsValue

CompletableFuture<Boolean> containsValue(String tableName,
                                         V value)

Checks whether the table contains a value.

Parameters:

tableName - table name

value - The value to check.

Returns:

A completable future to be completed with the result once complete.

get

CompletableFuture<org.onosproject.store.service.Versioned<V>> get(String tableName,
                                                                  K key)

Gets a value from the table.

Parameters:

tableName - table name

key - The key to get.

Returns:

A completable future to be completed with the result once complete.

put

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

Puts a value in the table.

Parameters:

tableName - table name

key - The key to set.

value - The value to set.

Returns:

A completable future to be completed with the result once complete.

putAndGet

CompletableFuture<Result<UpdateResult<org.onosproject.store.service.Versioned<V>>>> putAndGet(String tableName,
                                                                                              K key,
                                                                                              V value)

Puts a value in the table.

Parameters:

tableName - table name

key - The key to set.

value - The value to set.

Returns:

A completable future to be completed with the result once complete.

putIfAbsentAndGet

CompletableFuture<Result<UpdateResult<org.onosproject.store.service.Versioned<V>>>> putIfAbsentAndGet(String tableName,
                                                                                                      K key,
                                                                                                      V value)

Puts a value in the table.

Parameters:

tableName - table name

key - The key to set.

value - The value to set.

Returns:

A completable future to be completed with the result once complete.

remove

CompletableFuture<Result<org.onosproject.store.service.Versioned<V>>> remove(String tableName,
                                                                             K key)

Removes a value from the table.

Parameters:

tableName - table name

key - The key to remove.

Returns:

A completable future to be completed with the result once complete.

clear

CompletableFuture<Result<Void>> clear(String tableName)

Clears the table.

Parameters:

tableName - table name

Returns:

A completable future to be completed with the result once complete.

keySet

CompletableFuture<Set<K>> keySet(String tableName)

Gets a set of keys in the table.

Parameters:

tableName - table name

Returns:

A completable future to be completed with the result once complete.

values

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

Gets a collection of values in the table.

Parameters:

tableName - table name

Returns:

A completable future to be completed with the result once complete.

entrySet

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

Gets a set of entries in the table.

Parameters:

tableName - table name

Returns:

A completable future to be completed with the result once complete.

putIfAbsent

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

Puts a value in the table if the given key does not exist.

Parameters:

tableName - table name

key - The key to set.

value - The value to set if the given key does not exist.

Returns:

A completable future to be completed with the result once complete.

remove

CompletableFuture<Result<Boolean>> remove(String tableName,
                                          K key,
                                          V value)

Removes a key and if the existing value for that key matches the specified value.

Parameters:

tableName - table name

key - The key to remove.

value - The value to remove.

Returns:

A completable future to be completed with the result once complete.

remove

CompletableFuture<Result<Boolean>> remove(String tableName,
                                          K key,
                                          long version)

Removes a key and if the existing version for that key matches the specified version.

Parameters:

tableName - table name

key - The key to remove.

version - The expected version.

Returns:

A completable future to be completed with the result once complete.

replace

CompletableFuture<Result<Boolean>> replace(String tableName,
                                           K key,
                                           V oldValue,
                                           V newValue)

Replaces the entry for the specified key only if currently mapped to the specified value.

Parameters:

tableName - table name

key - The key to replace.

oldValue - The value to replace.

newValue - The value with which to replace the given key and value.

Returns:

A completable future to be completed with the result once complete.

replace

CompletableFuture<Result<Boolean>> replace(String tableName,
                                           K key,
                                           long oldVersion,
                                           V newValue)

Replaces the entry for the specified key only if currently mapped to the specified version.

Parameters:

tableName - table name

key - The key to update

oldVersion - existing version in the map for this replace to succeed.

newValue - The value with which to replace the given key and version.

Returns:

A completable future to be completed with the result once complete.

replaceAndGet

CompletableFuture<Result<UpdateResult<org.onosproject.store.service.Versioned<V>>>> replaceAndGet(String tableName,
                                                                                                  K key,
                                                                                                  long oldVersion,
                                                                                                  V newValue)

Replaces the entry for the specified key only if currently mapped to the specified version.

Parameters:

tableName - table name

key - The key to update

oldVersion - existing version in the map for this replace to succeed.

newValue - The value with which to replace the given key and version.

Returns:

A completable future to be completed with the result once complete.

counterAddAndGet

CompletableFuture<Long> counterAddAndGet(String counterName,
                                         long delta)

Atomically add the given value to current value of the specified counter.

Parameters:

counterName - counter name

delta - value to add

Returns:

updated value

counterGetAndAdd

CompletableFuture<Long> counterGetAndAdd(String counterName,
                                         long delta)

Atomically add the given value to current value of the specified counter.

Parameters:

counterName - counter name

delta - value to add

Returns:

previous value

counterGet

CompletableFuture<Long> counterGet(String counterName)

Returns the current value of the specified atomic counter.

Parameters:

counterName - counter name

Returns:

current value

prepareAndCommit

CompletableFuture<Boolean> prepareAndCommit(org.onosproject.store.service.Transaction transaction)

Prepare and commit the specified transaction.

Parameters:

transaction - transaction to commit (after preparation)

Returns:

A completable future to be completed with the result once complete

prepare

CompletableFuture<Boolean> prepare(org.onosproject.store.service.Transaction transaction)

Prepare the specified transaction for commit. A successful prepare implies all the affected resources are locked thus ensuring no concurrent updates can interfere.

Parameters:

transaction - transaction to prepare (for commit)

Returns:

A completable future to be completed with the result once complete. The future is completed with true if the transaction is successfully prepared i.e. all pre-conditions are met and applicable resources locked.

commit

CompletableFuture<Boolean> commit(org.onosproject.store.service.Transaction transaction)

Commit the specified transaction. A successful commit implies all the updates are applied, are now durable and are now visible externally.

Parameters:

transaction - transaction to commit

Returns:

A completable future to be completed with the result once complete

rollback

CompletableFuture<Boolean> rollback(org.onosproject.store.service.Transaction transaction)

Rollback the specified transaction. A successful rollback implies all previously acquired locks for the affected resources are released.

Parameters:

transaction - transaction to rollback

Returns:

A completable future to be completed with the result once complete