net.named_data.jndn.encrypt

Class GroupManagerDb

java.lang.Object

net.named_data.jndn.encrypt.GroupManagerDb

Direct Known Subclasses:

Sqlite3GroupManagerDbBase

public abstract class GroupManagerDb
extends Object

GroupManagerDb is an abstract base class for the storage of data used by the GroupManager. It contains two tables to store Schedules and Members. This is an abstract base class. A subclass must implement the methods. For example, see Sqlite3GroupManagerDb.

Note:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
GroupManagerDb()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addMember(String scheduleName, Name keyName, Blob key) Add a new member with the given key named keyName into a schedule named scheduleName.
abstract void	addSchedule(String name, Schedule schedule) Add a schedule with the given name.
abstract void	deleteMember(Name identity) Delete a member with the given identity name.
abstract void	deleteSchedule(String name) Delete the schedule with the given name.
abstract String	getMemberSchedule(Name identity) Get the name of the schedule for the given member's identity name.
abstract Schedule	getSchedule(String name) Get a schedule with the given name.
abstract Map	getScheduleMembers(String name) For each member using the given schedule, get the name and public key DER of the member's key.
abstract boolean	hasMember(Name identity) Check if there is a member with the given identity name.
abstract boolean	hasSchedule(String name) Check if there is a schedule with the given name.
abstract List	listAllMembers() List all the members.
abstract List	listAllScheduleNames() List all the names of the schedules.
abstract void	renameSchedule(String oldName, String newName) Rename a schedule with oldName to newName.
abstract void	updateMemberSchedule(Name identity, String scheduleName) Change the name of the schedule for the given member's identity name.
abstract void	updateSchedule(String name, Schedule schedule) Update the schedule with name and replace the old object with the given schedule.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupManagerDb

public GroupManagerDb()

Method Detail

hasSchedule

public abstract boolean hasSchedule(String name)
                             throws GroupManagerDb.Error

Check if there is a schedule with the given name.

Parameters:

name - The name of the schedule.

Returns:

True if there is a schedule.

Throws:

GroupManagerDb.Error - for a database error.

listAllScheduleNames

public abstract List listAllScheduleNames()
                                   throws GroupManagerDb.Error

List all the names of the schedules.

Returns:

A new List of String with the names of all schedules. (Use List without generics so it works with older Java compilers.)

Throws:

GroupManagerDb.Error - for a database error.

getSchedule

public abstract Schedule getSchedule(String name)
                              throws GroupManagerDb.Error

Get a schedule with the given name.

Parameters:

name - The name of the schedule.

Returns:

A new Schedule object.

Throws:

GroupManagerDb.Error - if the schedule does not exist or other database error.

getScheduleMembers

public abstract Map getScheduleMembers(String name)
                                throws GroupManagerDb.Error

For each member using the given schedule, get the name and public key DER of the member's key.

Parameters:

name - The name of the schedule.

Returns:

a new Map where the map's key is the Name of the public key and the value is the Blob of the public key DER. (Use Map without generics so it works with older Java compilers.) Note that the member's identity name is keyName.getPrefix(-1). If the schedule name is not found, the map is empty.

Throws:

GroupManagerDb.Error - for a database error.

addSchedule

public abstract void addSchedule(String name,
               Schedule schedule)
                          throws GroupManagerDb.Error

Add a schedule with the given name.

Parameters:

name - The name of the schedule. The name cannot be empty.

schedule - The Schedule to add.

Throws:

GroupManagerDb.Error - if a schedule with the same name already exists, if the name is empty, or other database error.

deleteSchedule

public abstract void deleteSchedule(String name)
                             throws GroupManagerDb.Error

Delete the schedule with the given name. Also delete members which use this schedule. If there is no schedule with the name, then do nothing.

Parameters:

name - The name of the schedule.

Throws:

GroupManagerDb.Error - for a database error.

renameSchedule

public abstract void renameSchedule(String oldName,
                  String newName)
                             throws GroupManagerDb.Error

Rename a schedule with oldName to newName.

Parameters:

oldName - The name of the schedule to be renamed.

newName - The new name of the schedule. The name cannot be empty.

Throws:

GroupManagerDb.Error - If a schedule with newName already exists, if the schedule with oldName does not exist, if newName is empty, or other database error.

updateSchedule

public abstract void updateSchedule(String name,
                  Schedule schedule)
                             throws GroupManagerDb.Error

Update the schedule with name and replace the old object with the given schedule. Otherwise, if no schedule with name exists, a new schedule with name and the given schedule will be added to database.

Parameters:

name - The name of the schedule. The name cannot be empty.

schedule - The Schedule to update or add.

Throws:

GroupManagerDb.Error - if the name is empty, or other database error.

hasMember

public abstract boolean hasMember(Name identity)
                           throws GroupManagerDb.Error

Check if there is a member with the given identity name.

Parameters:

identity - The member's identity name.

Returns:

True if there is a member.

Throws:

GroupManagerDb.Error - for a database error.

listAllMembers

public abstract List listAllMembers()
                             throws GroupManagerDb.Error

List all the members.

Returns:

A new List of Name with the names of all members. (Use List without generics so it works with older Java compilers.)

Throws:

GroupManagerDb.Error - for a database error.

getMemberSchedule

public abstract String getMemberSchedule(Name identity)
                                  throws GroupManagerDb.Error

Get the name of the schedule for the given member's identity name.

Parameters:

identity - The member's identity name.

Returns:

The name of the schedule.

Throws:

GroupManagerDb.Error - if there's no member with the given identity name in the database, or other database error.

addMember

public abstract void addMember(String scheduleName,
             Name keyName,
             Blob key)
                        throws GroupManagerDb.Error

Add a new member with the given key named keyName into a schedule named scheduleName. The member's identity name is keyName.getPrefix(-1).

Parameters:

scheduleName - The schedule name.

keyName - The name of the key.

key - A Blob of the public key DER.

Throws:

GroupManagerDb.Error - If there's no schedule named scheduleName, if the member's identity name already exists, or other database error.

updateMemberSchedule

public abstract void updateMemberSchedule(Name identity,
                        String scheduleName)
                                   throws GroupManagerDb.Error

Change the name of the schedule for the given member's identity name.

Parameters:

identity - The member's identity name.

scheduleName - The new schedule name.

Throws:

GroupManagerDb.Error - if there's no member with the given identity name in the database, or there's no schedule named scheduleName, or other database error.

deleteMember

public abstract void deleteMember(Name identity)
                           throws GroupManagerDb.Error

Delete a member with the given identity name. If there is no member with the identity name, then do nothing.

Parameters:

identity - The member's identity name.

Throws:

GroupManagerDb.Error - for a database error.