org.onosproject.store.consistent.impl

Class PartitionedDatabase

java.lang.Object

org.onosproject.store.consistent.impl.PartitionedDatabase

All Implemented Interfaces:

DatabaseProxy<String,byte[]>, PartitionedDatabaseManager

public class PartitionedDatabase
extends Object
implements DatabaseProxy<String,byte[]>, PartitionedDatabaseManager

A database that partitions the keys across one or more database partitions.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PartitionedDatabase(net.kuujo.copycat.cluster.internal.coordinator.ClusterCoordinator coordinator)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	atomicBatchUpdate(List<org.onosproject.store.service.UpdateOperation<String,byte[]>> updates) Perform a atomic batch update operation i.e.
CompletableFuture<Void>	clear(String tableName) Clears the table.
CompletableFuture<Void>	close() Closes the database.
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<Set<Map.Entry<String,org.onosproject.store.service.Versioned<byte[]>>>>	entrySet(String tableName) Gets a set of entries in the table.
CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>	get(String tableName, String key) Gets a value from the table.
Map<String,Database>	getRegisteredPartitions() Returns all the registered database partitions.
CompletableFuture<Boolean>	isEmpty(String tableName) Checks whether the table is empty.
boolean	isOpen() Returns true if the database is open.
CompletableFuture<Set<String>>	keySet(String tableName) Gets a set of keys in the table.
CompletableFuture<PartitionedDatabase>	open() Opens the database.
CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>	put(String tableName, String key, byte[] value) Puts a value in the table.
CompletableFuture<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.
void	registerPartition(String name, Database partition) Registers a new partition.
CompletableFuture<org.onosproject.store.service.Versioned<byte[]>>	remove(String tableName, String key) Removes a value from the table.
CompletableFuture<Boolean>	remove(String tableName, String key, byte[] value) Removes a key and if the existing value for that key matches the specified value.
CompletableFuture<Boolean>	remove(String tableName, String key, long version) Removes a key and if the existing version for that key matches the specified version.
CompletableFuture<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<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.
void	setPartitioner(Partitioner<String> partitioner) Sets the partitioner to use for mapping keys to partitions.
CompletableFuture<Integer>	size(String tableName) Gets the table size.
CompletableFuture<Collection<org.onosproject.store.service.Versioned<byte[]>>>	values(String tableName) Gets a collection of values in the table.

Methods inherited from class java.lang.Object

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

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

create

Constructor Detail

PartitionedDatabase

protected PartitionedDatabase(net.kuujo.copycat.cluster.internal.coordinator.ClusterCoordinator coordinator)

Method Detail

isOpen

public boolean isOpen()

Returns true if the database is open.

Returns:

true if open, false otherwise

registerPartition

public void registerPartition(String name,
                              Database partition)

Description copied from interface: PartitionedDatabaseManager

Registers a new partition.

Specified by:

registerPartition in interface PartitionedDatabaseManager

Parameters:

name - partition name.

partition - partition.

getRegisteredPartitions

public Map<String,Database> getRegisteredPartitions()

Description copied from interface: PartitionedDatabaseManager

Returns all the registered database partitions.

Specified by:

getRegisteredPartitions in interface PartitionedDatabaseManager

Returns:

mapping of all registered database partitions.

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

remove

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

atomicBatchUpdate

public CompletableFuture<Boolean> atomicBatchUpdate(List<org.onosproject.store.service.UpdateOperation<String,byte[]>> updates)

Description copied from interface: DatabaseProxy

Perform a atomic batch update operation i.e. either all operations in batch succeed or none do and no state changes are made.

Specified by:

atomicBatchUpdate in interface DatabaseProxy<String,byte[]>

Parameters:

updates - list of updates to apply atomically.

Returns:

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

setPartitioner

public void setPartitioner(Partitioner<String> partitioner)

Description copied from interface: PartitionedDatabaseManager

Sets the partitioner to use for mapping keys to partitions.

Specified by:

setPartitioner in interface PartitionedDatabaseManager

Parameters:

partitioner - partitioner

open

public CompletableFuture<PartitionedDatabase> open()

Description copied from interface: PartitionedDatabaseManager

Opens the database.

Specified by:

open in interface PartitionedDatabaseManager

Returns:

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

close

public CompletableFuture<Void> close()

Description copied from interface: PartitionedDatabaseManager

Closes the database.

Specified by:

close in interface PartitionedDatabaseManager

Returns:

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