net.named_data.jndn.encrypt

Class ProducerDb

java.lang.Object

net.named_data.jndn.encrypt.ProducerDb

Direct Known Subclasses:

Sqlite3ProducerDbBase

public abstract class ProducerDb
extends Object

ProducerDb is an abstract base class for the storage of keys for the producer. It contains one table that maps time slots (to the nearest hour) to the content key created for that time slot. A subclass must implement the methods. For example, see Sqlite3ProducerDb.

Note:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ProducerDb()

Method Summary

Modifier and Type	Method and Description
abstract void	addContentKey(double timeSlot, Blob key) Add key as the content key for the hour covering timeSlot.
abstract void	deleteContentKey(double timeSlot) Delete the content key for the hour covering timeSlot.
abstract Blob	getContentKey(double timeSlot) Get the content key for the hour covering timeSlot.
protected static int	getFixedTimeSlot(double timeSlot) Get the hour-based time slot.
abstract boolean	hasContentKey(double timeSlot) Check if a content key exists for the hour covering timeSlot.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProducerDb

public ProducerDb()

Method Detail

hasContentKey

public abstract boolean hasContentKey(double timeSlot)
                               throws ProducerDb.Error

Check if a content key exists for the hour covering timeSlot.

Parameters:

timeSlot - The time slot as milliseconds since Jan 1, 1970 UTC.

Returns:

True if there is a content key for timeSlot.

Throws:

ProducerDb.Error - for a database error.

getContentKey

public abstract Blob getContentKey(double timeSlot)
                            throws ProducerDb.Error

Get the content key for the hour covering timeSlot.

Parameters:

timeSlot - The time slot as milliseconds since Jan 1, 1970 UTC.

Returns:

A Blob with the encoded key.

Throws:

ProducerDb.Error - if there is no key covering timeSlot or other database error.

addContentKey

public abstract void addContentKey(double timeSlot,
                                   Blob key)
                            throws ProducerDb.Error

Add key as the content key for the hour covering timeSlot.

Parameters:

timeSlot - The time slot as milliseconds since Jan 1, 1970 UTC.

key - The encoded key.

Throws:

ProducerDb.Error - if a key for the same hour already exists in the database, or other database error.

deleteContentKey

public abstract void deleteContentKey(double timeSlot)
                               throws ProducerDb.Error

Delete the content key for the hour covering timeSlot. If there is no key for the time slot, do nothing.

Parameters:

timeSlot - The time slot as milliseconds since Jan 1, 1970 UTC.

Throws:

ProducerDb.Error - for a database error.

getFixedTimeSlot

protected static int getFixedTimeSlot(double timeSlot)

Get the hour-based time slot.

Parameters:

timeSlot - The time slot as milliseconds since Jan 1, 1970 UTC.

Returns:

The hour-based time slot as hours since Jan 1, 1970 UTC.