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(java.util.function.Supplier<CompletableFuture<T>> supplier) If the database is closed, returning a failed CompletableFuture.
CompletableFuture<Result<Void>>	clear(String tableName) Clears the table.
CompletableFuture<Void>	close()
CompletableFuture<Boolean>	commit(org.onosproject.store.service.Transaction transaction) Commit the specified transaction.
CompletableFuture<Boolean>	containsKey(String tableName, String key) Checks whether the table contains a key.
CompletableFuture<Boolean>	containsValue(String tableName, byte[] 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<String,org.onosproject.store.service.Versioned<byte[]>>>>	entrySet(String tableName) Gets a set of entries in the table.
boolean	equals(Object other)
CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>	get(String tableName, String key) Gets a value from the table.
int	hashCode()
CompletableFuture<Boolean>	isEmpty(String tableName) Checks whether the table is empty.
CompletableFuture<Set<String>>	keySet(String tableName) Gets a set of keys in the table.
CompletableFuture<Database>	open()
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<byte[]>>>	put(String tableName, String key, byte[] value) Puts a value in the table.
CompletableFuture<Result<UpdateResult<org.onosproject.store.service.Versioned<byte[]>>>>	putAndGet(String tableName, String key, byte[] value) Puts a value in the table.
CompletableFuture<Result<org.onosproject.store.service.Versioned<byte[]>>>	putIfAbsent(String tableName, String key, byte[] value) Puts a value in the table if the given key does not exist.
CompletableFuture<Result<UpdateResult<org.onosproject.store.service.Versioned<byte[]>>>>	putIfAbsentAndGet(String tableName, String key, byte[] value) Puts a value in the table.
CompletableFuture<Result<org.onosproject.store.service.Versioned<byte[]>>>	remove(String tableName, String key) Removes a value from the table.
CompletableFuture<Result<Boolean>>	remove(String tableName, String key, byte[] value) Removes a key and if the existing value for that key matches the specified value.
CompletableFuture<Result<Boolean>>	remove(String tableName, String key, long version) Removes a key and if the existing version for that key matches the specified version.
CompletableFuture<Result<Boolean>>	replace(String tableName, String key, byte[] oldValue, byte[] newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
CompletableFuture<Result<Boolean>>	replace(String tableName, String key, long oldVersion, byte[] newValue) Replaces the entry for the specified key only if currently mapped to the specified version.
CompletableFuture<Result<UpdateResult<org.onosproject.store.service.Versioned<byte[]>>>>	replaceAndGet(String tableName, String key, long oldVersion, byte[] 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<byte[]>>>	values(String tableName) Gets a collection of values in the table.

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

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(java.util.function.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.

tableNames

public CompletableFuture<Set<String>> tableNames()

Description copied from interface: DatabaseProxy

Returns a set of all tables names.

Specified by:

tableNames 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.

size

public CompletableFuture<Integer> size(String tableName)

Description copied from interface: DatabaseProxy

Gets the table size.

Specified by:

size in interface DatabaseProxy<String,byte[]>

Parameters:

tableName - table name

Returns:

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

isEmpty

public CompletableFuture<Boolean> isEmpty(String tableName)

Description copied from interface: DatabaseProxy

Checks whether the table is empty.

Specified by:

isEmpty in interface DatabaseProxy<String,byte[]>

Parameters:

tableName - table name

Returns:

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

containsKey

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

Description copied from interface: DatabaseProxy

Checks whether the table contains a key.

Specified by:

containsKey in interface DatabaseProxy<String,byte[]>

Parameters:

tableName - table name

key - The key to check.

Returns:

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

containsValue

public CompletableFuture<Boolean> containsValue(String tableName,
                                                byte[] value)

Description copied from interface: DatabaseProxy

Checks whether the table contains a value.

Specified by:

containsValue in interface DatabaseProxy<String,byte[]>

Parameters:

tableName - table name

value - The value to check.

Returns:

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

get

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

Description copied from interface: DatabaseProxy

Gets a value from the table.

Specified by:

get in interface DatabaseProxy<String,byte[]>

Parameters:

tableName - table name

key - The key to get.

Returns:

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

put

public CompletableFuture<Result<org.onosproject.store.service.Versioned<byte[]>>> put(String tableName,
                                                                                      String key,
                                                                                      byte[] value)

Description copied from interface: DatabaseProxy

Puts a value in the table.

Specified by:

put in interface DatabaseProxy<String,byte[]>

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

public CompletableFuture<Result<UpdateResult<org.onosproject.store.service.Versioned<byte[]>>>> putAndGet(String tableName,
                                                                                                          String key,
                                                                                                          byte[] value)

Description copied from interface: DatabaseProxy

Puts a value in the table.

Specified by:

putAndGet in interface DatabaseProxy<String,byte[]>

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

public CompletableFuture<Result<UpdateResult<org.onosproject.store.service.Versioned<byte[]>>>> putIfAbsentAndGet(String tableName,
                                                                                                                  String key,
                                                                                                                  byte[] value)

Description copied from interface: DatabaseProxy

Puts a value in the table.

Specified by:

putIfAbsentAndGet in interface DatabaseProxy<String,byte[]>

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

public CompletableFuture<Result<org.onosproject.store.service.Versioned<byte[]>>> remove(String tableName,
                                                                                         String key)

Description copied from interface: DatabaseProxy

Removes a value from the table.

Specified by:

remove in interface DatabaseProxy<String,byte[]>

Parameters:

tableName - table name

key - The key to remove.

Returns:

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

clear

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

Description copied from interface: DatabaseProxy

Clears the table.

Specified by:

clear in interface DatabaseProxy<String,byte[]>

Parameters:

tableName - table name

Returns:

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

keySet

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

Description copied from interface: DatabaseProxy

Gets a set of keys in the table.

Specified by:

keySet in interface DatabaseProxy<String,byte[]>

Parameters:

tableName - table name

Returns:

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

values

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

Description copied from interface: DatabaseProxy

Gets a collection of values in the table.

Specified by:

values in interface DatabaseProxy<String,byte[]>

Parameters:

tableName - table name

Returns:

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

entrySet

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

Description copied from interface: DatabaseProxy

Gets a set of entries in the table.

Specified by:

entrySet in interface DatabaseProxy<String,byte[]>

Parameters:

tableName - table name

Returns:

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

putIfAbsent

public CompletableFuture<Result<org.onosproject.store.service.Versioned<byte[]>>> putIfAbsent(String tableName,
                                                                                              String key,
                                                                                              byte[] value)

Description copied from interface: DatabaseProxy

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

Specified by:

putIfAbsent in interface DatabaseProxy<String,byte[]>

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

public CompletableFuture<Result<Boolean>> remove(String tableName,
                                                 String key,
                                                 byte[] value)

Description copied from interface: DatabaseProxy

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

Specified by:

remove in interface DatabaseProxy<String,byte[]>

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

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

Description copied from interface: DatabaseProxy

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

Specified by:

remove in interface DatabaseProxy<String,byte[]>

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

public CompletableFuture<Result<Boolean>> replace(String tableName,
                                                  String key,
                                                  byte[] oldValue,
                                                  byte[] newValue)

Description copied from interface: DatabaseProxy

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

Specified by:

replace in interface DatabaseProxy<String,byte[]>

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

public CompletableFuture<Result<Boolean>> replace(String tableName,
                                                  String key,
                                                  long oldVersion,
                                                  byte[] newValue)

Description copied from interface: DatabaseProxy

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

Specified by:

replace in interface DatabaseProxy<String,byte[]>

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

public CompletableFuture<Result<UpdateResult<org.onosproject.store.service.Versioned<byte[]>>>> replaceAndGet(String tableName,
                                                                                                              String key,
                                                                                                              long oldVersion,
                                                                                                              byte[] newValue)

Description copied from interface: DatabaseProxy

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

Specified by:

replaceAndGet in interface DatabaseProxy<String,byte[]>

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.

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

prepareAndCommit

public CompletableFuture<Boolean> 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<Boolean> 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