DatabaseProxy (onos-core-primitives 1.5.0 API)

All Known Subinterfaces:

Database

All Known Implementing Classes:

DefaultDatabase, PartitionedDatabase
```
public interface DatabaseProxy<K,V>
```
Database proxy.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompletableFuture<CommitResponse>`	`commit(Transaction transaction)` Commit the specified transaction.
`CompletableFuture<Long>`	`counterAddAndGet(String counterName, long delta)` Atomically add the given value to current value of the specified counter.
`CompletableFuture<Boolean>`	`counterCompareAndSet(String counterName, long expectedValue, long update)` Atomically sets the given counter to the specified update value if and only if the current value is equal to the expected value.
`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<Void>`	`counterSet(String counterName, long value)` Atomically sets the given value to current value of the specified counter.
`CompletableFuture<Result<Void>>`	`mapClear(String mapName)` Clears the map.
`CompletableFuture<Boolean>`	`mapContainsKey(String mapName, K key)` Checks whether the map contains a key.
`CompletableFuture<Boolean>`	`mapContainsValue(String mapName, V value)` Checks whether the map contains a value.
`CompletableFuture<Set<Map.Entry<K,org.onosproject.store.service.Versioned<V>>>>`	`mapEntrySet(String mapName)` Gets a set of entries in the map.
`CompletableFuture<org.onosproject.store.service.Versioned<V>>`	`mapGet(String mapName, K key)` Gets a value from the map.
`CompletableFuture<Boolean>`	`mapIsEmpty(String mapName)` Checks whether the map is empty.
`CompletableFuture<Set<K>>`	`mapKeySet(String mapName)` Gets a set of keys in the map.
`CompletableFuture<Set<String>>`	`maps()` Returns a set of all map names.
`CompletableFuture<Integer>`	`mapSize(String mapName)` Returns the number of entries in map.
`CompletableFuture<Result<UpdateResult<K,V>>>`	`mapUpdate(String mapName, K key, org.onlab.util.Match<V> valueMatch, org.onlab.util.Match<Long> versionMatch, V value)` Updates the map.
`CompletableFuture<Collection<org.onosproject.store.service.Versioned<V>>>`	`mapValues(String mapName)` Gets a collection of values in the map.
`CompletableFuture<Boolean>`	`prepare(Transaction transaction)` Prepare the specified transaction for commit.
`CompletableFuture<CommitResponse>`	`prepareAndCommit(Transaction transaction)` Prepare and commit the specified transaction.
`CompletableFuture<byte[]>`	`queuePeek(String queueName)` Returns but does not remove an entry from the queue.
`CompletableFuture<byte[]>`	`queuePop(String queueName)` Removes an entry from the queue if the queue is non-empty.
`CompletableFuture<Void>`	`queuePush(String queueName, byte[] entry)` Inserts an entry into the queue.
`CompletableFuture<Long>`	`queueSize(String queueName)` Returns the size of queue.
`CompletableFuture<Boolean>`	`rollback(Transaction transaction)` Rollback the specified transaction.

- Method Detail
  - maps
```
CompletableFuture<Set<String>> maps()
```
    Returns a set of all map 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.
  - mapSize
```
CompletableFuture<Integer> mapSize(String mapName)
```
    Returns the number of entries in map.
    
    Parameters:
    
    mapName - map name
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - mapIsEmpty
```
CompletableFuture<Boolean> mapIsEmpty(String mapName)
```
    Checks whether the map is empty.
    
    Parameters:
    
    mapName - map name
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - mapContainsKey
```
CompletableFuture<Boolean> mapContainsKey(String mapName,
                                          K key)
```
    Checks whether the map contains a key.
    
    Parameters:
    
    mapName - map name
    
    key - key to check.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - mapContainsValue
```
CompletableFuture<Boolean> mapContainsValue(String mapName,
                                            V value)
```
    Checks whether the map contains a value.
    
    Parameters:
    
    mapName - map name
    
    value - The value to check.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - mapGet
```
CompletableFuture<org.onosproject.store.service.Versioned<V>> mapGet(String mapName,
                                                                     K key)
```
    Gets a value from the map.
    
    Parameters:
    
    mapName - map name
    
    key - The key to get.
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - mapUpdate
```
CompletableFuture<Result<UpdateResult<K,V>>> mapUpdate(String mapName,
                                                       K key,
                                                       org.onlab.util.Match<V> valueMatch,
                                                       org.onlab.util.Match<Long> versionMatch,
                                                       V value)
```
    Updates the map.
    
    Parameters:
    
    mapName - map name
    
    key - The key to set
    
    valueMatch - match for checking existing value
    
    versionMatch - match for checking existing version
    
    value - new value
    
    Returns:
    
    A completable future to be completed with the result once complete
  - mapClear
```
CompletableFuture<Result<Void>> mapClear(String mapName)
```
    Clears the map.
    
    Parameters:
    
    mapName - map name
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - mapKeySet
```
CompletableFuture<Set<K>> mapKeySet(String mapName)
```
    Gets a set of keys in the map.
    
    Parameters:
    
    mapName - map name
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - mapValues
```
CompletableFuture<Collection<org.onosproject.store.service.Versioned<V>>> mapValues(String mapName)
```
    Gets a collection of values in the map.
    
    Parameters:
    
    mapName - map name
    
    Returns:
    
    A completable future to be completed with the result once complete.
  - mapEntrySet
```
CompletableFuture<Set<Map.Entry<K,org.onosproject.store.service.Versioned<V>>>> mapEntrySet(String mapName)
```
    Gets a set of entries in the map.
    
    Parameters:
    
    mapName - map name
    
    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
  - counterSet
```
CompletableFuture<Void> counterSet(String counterName,
                                   long value)
```
    Atomically sets the given value to current value of the specified counter.
    
    Parameters:
    
    counterName - counter name
    
    value - value to set
    
    Returns:
    
    void future
  - counterCompareAndSet
```
CompletableFuture<Boolean> counterCompareAndSet(String counterName,
                                                long expectedValue,
                                                long update)
```
    Atomically sets the given counter to the specified update value if and only if the current value is equal to the expected value.
    
    Parameters:
    
    counterName - counter name
    
    expectedValue - value to use for equivalence check
    
    update - value to set if expected value is current value
    
    Returns:
    
    true if an update occurred, false otherwise
  - counterGet
```
CompletableFuture<Long> counterGet(String counterName)
```
    Returns the current value of the specified atomic counter.
    
    Parameters:
    
    counterName - counter name
    
    Returns:
    
    current value
  - queueSize
```
CompletableFuture<Long> queueSize(String queueName)
```
    Returns the size of queue.
    
    Parameters:
    
    queueName - queue name
    
    Returns:
    
    queue size
  - queuePush
```
CompletableFuture<Void> queuePush(String queueName,
                                  byte[] entry)
```
    Inserts an entry into the queue.
    
    Parameters:
    
    queueName - queue name
    
    entry - queue entry
    
    Returns:
    
    void future
  - queuePop
```
CompletableFuture<byte[]> queuePop(String queueName)
```
    Removes an entry from the queue if the queue is non-empty.
    
    Parameters:
    
    queueName - queue name
    
    Returns:
    
    entry future. Can be completed with null if queue is empty
  - queuePeek
```
CompletableFuture<byte[]> queuePeek(String queueName)
```
    Returns but does not remove an entry from the queue.
    
    Parameters:
    
    queueName - queue name
    
    Returns:
    
    entry. Can be null if queue is empty
  - prepareAndCommit
```
CompletableFuture<CommitResponse> prepareAndCommit(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(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<CommitResponse> commit(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(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

Interface DatabaseProxy<K,V>

Method Summary

Method Detail

maps

counters

mapSize

mapIsEmpty

mapContainsKey

mapContainsValue

mapGet

mapUpdate

mapClear

mapKeySet

mapValues

mapEntrySet

counterAddAndGet

counterGetAndAdd

counterSet

counterCompareAndSet

counterGet

queueSize

queuePush

queuePop

queuePeek

prepareAndCommit

prepare

commit

rollback