net.named_data.jndn.encrypt

Class ConsumerDb

java.lang.Object

net.named_data.jndn.encrypt.ConsumerDb

Direct Known Subclasses:

Sqlite3ConsumerDbBase

public abstract class ConsumerDb
extends Object

ConsumerDb is an abstract base class the storage of decryption keys for the consumer. A subclass must implement the methods. For example, see Sqlite3ConsumerDb.

Note:

This class is an experimental feature. The API may change.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConsumerDb.Error ConsumerDb.Error extends Exception for errors using ConsumerDb methods.

Constructor Summary

Constructors

Constructor and Description
ConsumerDb()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addKey(Name keyName, Blob keyBlob) Add the key with keyName and keyBlob to the database.
abstract void	deleteKey(Name keyName) Delete the key with keyName from the database.
abstract Blob	getKey(Name keyName) Get the key with keyName from the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumerDb

public ConsumerDb()

Method Detail

getKey

public abstract Blob getKey(Name keyName)
                     throws ConsumerDb.Error

Get the key with keyName from the database.

Parameters:

keyName - The key name.

Returns:

A Blob with the encoded key, or an isNull Blob if cannot find the key with keyName.

Throws:

ConsumerDb.Error - for a database error.

addKey

public abstract void addKey(Name keyName,
          Blob keyBlob)
                     throws ConsumerDb.Error

Add the key with keyName and keyBlob to the database.

Parameters:

keyName - The key name.

keyBlob - The encoded key.

Throws:

ConsumerDb.Error - if a key with the same keyName already exists in the database, or other database error.

deleteKey

public abstract void deleteKey(Name keyName)
                        throws ConsumerDb.Error

Delete the key with keyName from the database. If there is no key with keyName, do nothing.

Parameters:

keyName - The key name.

Throws:

ConsumerDb.Error - for a database error.