org.onosproject.store.consistent.impl

Class DefaultDatabase

java.lang.Object

net.kuujo.copycat.resource.internal.AbstractResource<Database>

org.onosproject.store.consistent.impl.DefaultDatabase

All Implemented Interfaces:

net.kuujo.copycat.resource.Resource<Database>, net.kuujo.copycat.util.Managed<Database>, Database, DatabaseProxy<String,byte[]>

public class DefaultDatabase
extends net.kuujo.copycat.resource.internal.AbstractResource<Database>
implements Database

Default database.

Field Summary

Fields inherited from class net.kuujo.copycat.resource.internal.AbstractResource

context, executor, serializer

Constructor Summary

Constructors

Constructor and Description
DefaultDatabase(net.kuujo.copycat.resource.internal.ResourceManager context)

Method Summary

Modifier and Type	Method and Description
protected <T> CompletableFuture<T>	checkOpen(Supplier<CompletableFuture<T>> supplier) If the database is closed, returning a failed CompletableFuture.
CompletableFuture<Void>	close()
CompletableFuture<CommitResponse>	commit(org.onosproject.store.service.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.
boolean	equals(Object other)
int	hashCode()
CompletableFuture<Result<Void>>	mapClear(String mapName) Clears the map.
CompletableFuture<Boolean>	mapContainsKey(String mapName, String key) Checks whether the map contains a key.
CompletableFuture<Boolean>	mapContainsValue(String mapName, byte[] value) Checks whether the map contains a value.
CompletableFuture<Set<Map.Entry<String,org.onosproject.store.service.Versioned<byte[]>>>>	mapEntrySet(String mapName) Gets a set of entries in the map.
CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>	mapGet(String mapName, String key) Gets a value from the map.
CompletableFuture<Boolean>	mapIsEmpty(String mapName) Checks whether the map is empty.
CompletableFuture<Set<String>>	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<String,byte[]>>>	mapUpdate(String mapName, String key, Match<byte[]> valueMatch, Match<Long> versionMatch, byte[] value) Updates the map.
CompletableFuture<Collection<org.onosproject.store.service.Versioned<byte[]>>>	mapValues(String mapName) Gets a collection of values in the map.
CompletableFuture<Database>	open()
CompletableFuture<Boolean>	prepare(org.onosproject.store.service.Transaction transaction) Prepare the specified transaction for commit.
CompletableFuture<CommitResponse>	prepareAndCommit(org.onosproject.store.service.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.
void	registerConsumer(Consumer<StateMachineUpdate> consumer) Registers a new consumer of StateMachineUpdates.
CompletableFuture<Boolean>	rollback(org.onosproject.store.service.Transaction transaction) Rollback the specified transaction.
void	unregisterConsumer(Consumer<StateMachineUpdate> consumer) Unregisters a consumer of StateMachineUpdates.

Methods inherited from class net.kuujo.copycat.resource.internal.AbstractResource

addShutdownTask, addStartupTask, cluster, isClosed, isOpen, name, runShutdownTasks, runStartupTasks, state

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.store.consistent.impl.Database

create, create, create, hasChangeNotificationSupport

Methods inherited from interface net.kuujo.copycat.resource.Resource

addShutdownTask, addStartupTask, cluster, name, state

Methods inherited from interface net.kuujo.copycat.util.Managed

isClosed, isOpen

Constructor Detail

DefaultDatabase

public DefaultDatabase(net.kuujo.copycat.resource.internal.ResourceManager context)

Method Detail

checkOpen

protected <T> CompletableFuture<T> checkOpen(Supplier<CompletableFuture<T>> supplier)

If the database is closed, returning a failed CompletableFuture. Otherwise, calls the given supplier to return the completed future result.

Type Parameters:

T - The future result type.

Parameters:

supplier - The supplier to call if the database is open.

Returns:

A completable future that if this database is closed is immediately failed.

maps

public CompletableFuture<Set<String>> maps()

Description copied from interface: DatabaseProxy

Returns a set of all map names.

Specified by:

maps in interface DatabaseProxy<String,byte[]>

Returns:

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

counters

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

Description copied from interface: DatabaseProxy

Returns a mapping from counter name to next value.

Specified by:

counters in interface DatabaseProxy<String,byte[]>

Returns:

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

mapSize

public CompletableFuture<Integer> mapSize(String mapName)

Description copied from interface: DatabaseProxy

Returns the number of entries in map.

Specified by:

mapSize in interface DatabaseProxy<String,byte[]>

Parameters:

mapName - map name

Returns:

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

mapIsEmpty

public CompletableFuture<Boolean> mapIsEmpty(String mapName)

Description copied from interface: DatabaseProxy

Checks whether the map is empty.

Specified by:

mapIsEmpty in interface DatabaseProxy<String,byte[]>

Parameters:

mapName - map name

Returns:

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

mapContainsKey

public CompletableFuture<Boolean> mapContainsKey(String mapName,
                                                 String key)

Description copied from interface: DatabaseProxy

Checks whether the map contains a key.

Specified by:

mapContainsKey in interface DatabaseProxy<String,byte[]>

Parameters:

mapName - map name

key - key to check.

Returns:

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

mapContainsValue

public CompletableFuture<Boolean> mapContainsValue(String mapName,
                                                   byte[] value)

Description copied from interface: DatabaseProxy

Checks whether the map contains a value.

Specified by:

mapContainsValue in interface DatabaseProxy<String,byte[]>

Parameters:

mapName - map name

value - The value to check.

Returns:

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

mapGet

public CompletableFuture<org.onosproject.store.service.Versioned<byte[]>> mapGet(String mapName,
                                                                                 String key)

Description copied from interface: DatabaseProxy

Gets a value from the map.

Specified by:

mapGet in interface DatabaseProxy<String,byte[]>

Parameters:

mapName - map name

key - The key to get.

Returns:

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

mapUpdate

public CompletableFuture<Result<UpdateResult<String,byte[]>>> mapUpdate(String mapName,
                                                                        String key,
                                                                        Match<byte[]> valueMatch,
                                                                        Match<Long> versionMatch,
                                                                        byte[] value)

Description copied from interface: DatabaseProxy

Updates the map.

Specified by:

mapUpdate in interface DatabaseProxy<String,byte[]>

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

public CompletableFuture<Result<Void>> mapClear(String mapName)

Description copied from interface: DatabaseProxy

Clears the map.

Specified by:

mapClear in interface DatabaseProxy<String,byte[]>

Parameters:

mapName - map name

Returns:

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

mapKeySet

public CompletableFuture<Set<String>> mapKeySet(String mapName)

Description copied from interface: DatabaseProxy

Gets a set of keys in the map.

Specified by:

mapKeySet in interface DatabaseProxy<String,byte[]>

Parameters:

mapName - map name

Returns:

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

mapValues

public CompletableFuture<Collection<org.onosproject.store.service.Versioned<byte[]>>> mapValues(String mapName)

Description copied from interface: DatabaseProxy

Gets a collection of values in the map.

Specified by:

mapValues in interface DatabaseProxy<String,byte[]>

Parameters:

mapName - map name

Returns:

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

mapEntrySet

public CompletableFuture<Set<Map.Entry<String,org.onosproject.store.service.Versioned<byte[]>>>> mapEntrySet(String mapName)

Description copied from interface: DatabaseProxy

Gets a set of entries in the map.

Specified by:

mapEntrySet in interface DatabaseProxy<String,byte[]>

Parameters:

mapName - map name

Returns:

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

counterGet

public CompletableFuture<Long> counterGet(String counterName)

Description copied from interface: DatabaseProxy

Returns the current value of the specified atomic counter.

Specified by:

counterGet in interface DatabaseProxy<String,byte[]>

Parameters:

counterName - counter name

Returns:

current value

counterAddAndGet

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

Description copied from interface: DatabaseProxy

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

Specified by:

counterAddAndGet in interface DatabaseProxy<String,byte[]>

Parameters:

counterName - counter name

delta - value to add

Returns:

updated value

counterGetAndAdd

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

Description copied from interface: DatabaseProxy

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

Specified by:

counterGetAndAdd in interface DatabaseProxy<String,byte[]>

Parameters:

counterName - counter name

delta - value to add

Returns:

previous value

counterSet

public CompletableFuture<Void> counterSet(String counterName,
                                          long value)

Description copied from interface: DatabaseProxy

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

Specified by:

counterSet in interface DatabaseProxy<String,byte[]>

Parameters:

counterName - counter name

value - value to set

Returns:

void future

counterCompareAndSet

public CompletableFuture<Boolean> counterCompareAndSet(String counterName,
                                                       long expectedValue,
                                                       long update)

Description copied from interface: DatabaseProxy

Atomically sets the given counter to the specified update value if and only if the current value is equal to the expected value.

Specified by:

counterCompareAndSet in interface DatabaseProxy<String,byte[]>

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

queueSize

public CompletableFuture<Long> queueSize(String queueName)

Description copied from interface: DatabaseProxy

Returns the size of queue.

Specified by:

queueSize in interface DatabaseProxy<String,byte[]>

Parameters:

queueName - queue name

Returns:

queue size

queuePush

public CompletableFuture<Void> queuePush(String queueName,
                                         byte[] entry)

Description copied from interface: DatabaseProxy

Inserts an entry into the queue.

Specified by:

queuePush in interface DatabaseProxy<String,byte[]>

Parameters:

queueName - queue name

entry - queue entry

Returns:

void future

queuePop

public CompletableFuture<byte[]> queuePop(String queueName)

Description copied from interface: DatabaseProxy

Removes an entry from the queue if the queue is non-empty.

Specified by:

queuePop in interface DatabaseProxy<String,byte[]>

Parameters:

queueName - queue name

Returns:

entry future. Can be completed with null if queue is empty

queuePeek

public CompletableFuture<byte[]> queuePeek(String queueName)

Description copied from interface: DatabaseProxy

Returns but does not remove an entry from the queue.

Specified by:

queuePeek in interface DatabaseProxy<String,byte[]>

Parameters:

queueName - queue name

Returns:

entry. Can be null if queue is empty

prepareAndCommit

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

Description copied from interface: DatabaseProxy

Prepare and commit the specified transaction.

Specified by:

prepareAndCommit in interface DatabaseProxy<String,byte[]>

Parameters:

transaction - transaction to commit (after preparation)

Returns:

A completable future to be completed with the result once complete

prepare

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

Description copied from interface: DatabaseProxy

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

Specified by:

prepare in interface DatabaseProxy<String,byte[]>

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

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

Description copied from interface: DatabaseProxy

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

Specified by:

commit in interface DatabaseProxy<String,byte[]>

Parameters:

transaction - transaction to commit

Returns:

A completable future to be completed with the result once complete

rollback

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

Description copied from interface: DatabaseProxy

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

Specified by:

rollback in interface DatabaseProxy<String,byte[]>

Parameters:

transaction - transaction to rollback

Returns:

A completable future to be completed with the result once complete

open

public CompletableFuture<Database> open()

Specified by:

open in interface net.kuujo.copycat.util.Managed<Database>

close

public CompletableFuture<Void> close()

Specified by:

close in interface net.kuujo.copycat.util.Managed<Database>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

registerConsumer

public void registerConsumer(Consumer<StateMachineUpdate> consumer)

Description copied from interface: Database

Registers a new consumer of StateMachineUpdates.

Specified by:

registerConsumer in interface Database

Parameters:

consumer - consumer to register

unregisterConsumer

public void unregisterConsumer(Consumer<StateMachineUpdate> consumer)

Description copied from interface: Database

Unregisters a consumer of StateMachineUpdates.

Specified by:

unregisterConsumer in interface Database

Parameters:

consumer - consumer to unregister