org.eclipse.kura.db.keyvalue

Interface KeyValueDbService

@ProviderType
public interface KeyValueDbService

KeyValueDbService provides APIs to use the functionalities a of a database capable of storing data in form of key-value pairs.

Since:

2.5.0

Method Summary

Modifier and Type	Method and Description
void	addListener(ConnectionListener listener) Adds a ConnectionListener.
void	delete(java.lang.String key) Delete a key with the specified value in the database
byte[]	get(java.lang.String key) Get a key with the specified value in the database
java.lang.String	getAsString(java.lang.String key) Get a key with the specified value in the database
boolean	isConnected() Returns whether the database is connected or not.
void	removeListener(ConnectionListener listener) Removes a ConnectionListener
void	set(java.lang.String key, byte[] value) Set a key with the specified value in the database
void	set(java.lang.String key, java.lang.String value) Set a key with the specified value in the database

Method Detail

addListener

void addListener(ConnectionListener listener)

Adds a ConnectionListener.

Parameters:

listener - to add

removeListener

void removeListener(ConnectionListener listener)

Removes a ConnectionListener

Parameters:

listener - to remove

isConnected

boolean isConnected()

Returns whether the database is connected or not.

set

void set(java.lang.String key,
         byte[] value)
  throws KuraException

Set a key with the specified value in the database

Parameters:

key - the key name

value - the value of the key as array of byte

Throws:

KuraException - if the operation is unsuccessful

set

void set(java.lang.String key,
         java.lang.String value)
  throws KuraException

Set a key with the specified value in the database

Parameters:

key - the key name

value - the value of the key as a String. The string encondig is platform dependent

Throws:

KuraException - if the operation is unsuccessful

get

byte[] get(java.lang.String key)
    throws KuraException

Get a key with the specified value in the database

Parameters:

key - the key name

Returns:

the key value as byte array

Throws:

KuraException - if the operation is unsuccessful

getAsString

java.lang.String getAsString(java.lang.String key)
                      throws KuraException

Get a key with the specified value in the database

Parameters:

key - the key name

Returns:

the key value as String. The string encondig is platform dependent

Throws:

KuraException - if the operation is unsuccessful

delete

void delete(java.lang.String key)
     throws KuraException

Delete a key with the specified value in the database

Parameters:

key - the key name

Throws:

KuraException - if the operation is unsuccessful