net.named_data.jndn.encrypt

Class Sqlite3GroupManagerDb

java.lang.Object

net.named_data.jndn.encrypt.GroupManagerDb

net.named_data.jndn.encrypt.Sqlite3GroupManagerDbBase

net.named_data.jndn.encrypt.Sqlite3GroupManagerDb

public class Sqlite3GroupManagerDb
extends Sqlite3GroupManagerDbBase

Sqlite3GroupManagerDb extends GroupManagerDb to implement the storage of data used by the GroupManager using SQLite3.

Note:

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

Nested Class Summary

Nested classes/interfaces inherited from class net.named_data.jndn.encrypt.GroupManagerDb

GroupManagerDb.Error

Field Summary

Fields inherited from class net.named_data.jndn.encrypt.Sqlite3GroupManagerDbBase

DELETE_cleanEKeys, DELETE_deleteEKey, DELETE_deleteMember, DELETE_deleteSchedule, DELETE_deleteScheduleMembers, INITIALIZATION1, INITIALIZATION2, INITIALIZATION3, INITIALIZATION4, INITIALIZATION5, INITIALIZATION6, INSERT_addEKey, INSERT_addMember, INSERT_addSchedule, SELECT_getEKey, SELECT_getMemberSchedule, SELECT_getSchedule, SELECT_getScheduleId, SELECT_getScheduleMembers, SELECT_hasEKey, SELECT_hasMember, SELECT_hasSchedule, SELECT_listAllMembers, SELECT_listAllScheduleNames, UPDATE_renameSchedule, UPDATE_updateMemberSchedule, UPDATE_updateSchedule, WHERE_renameSchedule, WHERE_updateSchedule

Constructor Summary

Constructors

Constructor and Description
Sqlite3GroupManagerDb(String databaseFilePath) Create an Sqlite3GroupManagerDb to use the given SQLite3 file.

Method Summary

Modifier and Type	Method and Description
void	addEKey(Name eKeyName, Blob publicKey, Blob privateKey) Add the EKey with name eKeyName to the database.
void	addMember(String scheduleName, Name keyName, Blob key) Add a new member with the given key named keyName into a schedule named scheduleName.
void	addSchedule(String name, Schedule schedule) Add a schedule with the given name.
void	cleanEKeys() Delete all the EKeys in the database.
void	deleteEKey(Name eKeyName) Delete the EKey with name eKeyName from the database.
void	deleteMember(Name identity) Delete a member with the given identity name.
void	deleteSchedule(String name) Delete the schedule with the given name.
void	getEKey(Name eKeyName, Blob[] publicKey, Blob[] privateKey) Get the group key pair with the name eKeyName from the database.
String	getMemberSchedule(Name identity) Get the name of the schedule for the given member's identity name.
Schedule	getSchedule(String name) Get a schedule with the given name.
Map	getScheduleMembers(String name) For each member using the given schedule, get the name and public key DER of the member's key.
boolean	hasEKey(Name eKeyName) Check if there is an EKey with the name eKeyName in the database.
boolean	hasMember(Name identity) Check if there is a member with the given identity name.
boolean	hasSchedule(String name) Check if there is a schedule with the given name.
List	listAllMembers() List all the members.
List	listAllScheduleNames() List all the names of the schedules.
void	renameSchedule(String oldName, String newName) Rename a schedule with oldName to newName.
void	updateMemberSchedule(Name identity, String scheduleName) Change the name of the schedule for the given member's identity name.
void	updateSchedule(String name, Schedule schedule) Update the schedule with name and replace the old object with the given schedule.

Methods inherited from class net.named_data.jndn.encrypt.Sqlite3GroupManagerDbBase

checkAddSchedule, checkRenameSchedule

Methods inherited from class java.lang.Object

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

Constructor Detail

Sqlite3GroupManagerDb

public Sqlite3GroupManagerDb(String databaseFilePath)
                      throws GroupManagerDb.Error

Create an Sqlite3GroupManagerDb to use the given SQLite3 file.

Parameters:

databaseFilePath - The path of the SQLite file.

Throws:

GroupManagerDb.Error - for a database error.

Method Detail

hasSchedule

public boolean hasSchedule(String name)
                    throws GroupManagerDb.Error

Check if there is a schedule with the given name.

Specified by:

hasSchedule in class GroupManagerDb

Parameters:

name - The name of the schedule.

Returns:

True if there is a schedule.

Throws:

GroupManagerDb.Error - for a database error.

listAllScheduleNames

public List listAllScheduleNames()
                          throws GroupManagerDb.Error

List all the names of the schedules.

Specified by:

listAllScheduleNames in class GroupManagerDb

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 Schedule getSchedule(String name)
                     throws GroupManagerDb.Error

Get a schedule with the given name.

Specified by:

getSchedule in class GroupManagerDb

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

Specified by:

getScheduleMembers in class GroupManagerDb

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 void addSchedule(String name,
                        Schedule schedule)
                 throws GroupManagerDb.Error

Add a schedule with the given name.

Specified by:

addSchedule in class GroupManagerDb

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

Specified by:

deleteSchedule in class GroupManagerDb

Parameters:

name - The name of the schedule.

Throws:

GroupManagerDb.Error - for a database error.

renameSchedule

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

Rename a schedule with oldName to newName.

Specified by:

renameSchedule in class GroupManagerDb

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

Specified by:

updateSchedule in class GroupManagerDb

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 boolean hasMember(Name identity)
                  throws GroupManagerDb.Error

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

Specified by:

hasMember in class GroupManagerDb

Parameters:

identity - The member's identity name.

Returns:

True if there is a member.

Throws:

GroupManagerDb.Error - for a database error.

listAllMembers

public List listAllMembers()
                    throws GroupManagerDb.Error

List all the members.

Specified by:

listAllMembers in class GroupManagerDb

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 String getMemberSchedule(Name identity)
                         throws GroupManagerDb.Error

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

Specified by:

getMemberSchedule in class GroupManagerDb

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

Specified by:

addMember in class GroupManagerDb

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 void updateMemberSchedule(Name identity,
                                 String scheduleName)
                          throws GroupManagerDb.Error

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

Specified by:

updateMemberSchedule in class GroupManagerDb

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

Specified by:

deleteMember in class GroupManagerDb

Parameters:

identity - The member's identity name.

Throws:

GroupManagerDb.Error - for a database error.

hasEKey

public boolean hasEKey(Name eKeyName)
                throws GroupManagerDb.Error

Check if there is an EKey with the name eKeyName in the database.

Specified by:

hasEKey in class GroupManagerDb

Parameters:

eKeyName - The name of the EKey.

Returns:

True if the EKey exists.

Throws:

GroupManagerDb.Error - for a database error.

addEKey

public void addEKey(Name eKeyName,
                    Blob publicKey,
                    Blob privateKey)
             throws GroupManagerDb.Error

Add the EKey with name eKeyName to the database.

Specified by:

addEKey in class GroupManagerDb

Parameters:

eKeyName - The name of the EKey. This copies the Name.

publicKey - The encoded public Key of the group key pair.

privateKey - The encoded private Key of the group key pair.

Throws:

GroupManagerDb.Error - If a key with name eKeyName already exists in the database, or other database error.

getEKey

public void getEKey(Name eKeyName,
                    Blob[] publicKey,
                    Blob[] privateKey)
             throws GroupManagerDb.Error

Get the group key pair with the name eKeyName from the database.

Specified by:

getEKey in class GroupManagerDb

Parameters:

eKeyName - The name of the EKey.

publicKey - Set publicKey[0] to the encoded public Key.

privateKey - Set publicKey[0] to the encoded private Key.

Throws:

GroupManagerDb.Error - If the key with name eKeyName does not exist in the database, or other database error.

cleanEKeys

public void cleanEKeys()
                throws GroupManagerDb.Error

Delete all the EKeys in the database. The database will keep growing because EKeys will keep being added, so this method should be called periodically.

Specified by:

cleanEKeys in class GroupManagerDb

Throws:

GroupManagerDb.Error - for a database error.

deleteEKey

public void deleteEKey(Name eKeyName)
                throws GroupManagerDb.Error

Delete the EKey with name eKeyName from the database. If no key with the name exists in the database, do nothing.

Specified by:

deleteEKey in class GroupManagerDb

Parameters:

eKeyName - The name of the EKey.

Throws:

GroupManagerDb.Error - for a database error.