Package org.drasyl.node.plugin.groups.manager.database.jdbc

Class JDBCDatabaseAdapter

java.lang.Object

org.drasyl.node.plugin.groups.manager.database.jdbc.JDBCDatabaseAdapter

All Implemented Interfaces:

DatabaseAdapter

public class JDBCDatabaseAdapter
extends Object
implements DatabaseAdapter

DatabaseAdapter implementation that supports SQL databases.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	QUERY_TIMEOUT
static final String	SCHEME

Constructor Summary

Constructors

Constructor	Description
JDBCDatabaseAdapter(URI uri)

Method Summary

Modifier and Type	Method	Description
boolean	addGroup(Group group)	Adds a group to the database if it doesn't exist already.
boolean	addGroupMember(Membership membership)	Adds or updates the given groupMember#member to the given groupMember#group.
void	close()	Closes the connection to the database.
boolean	deleteGroup(String name)	Deleted the group with the specified name.
Set<Membership>	deleteStaleMemberships()	Deletes all stale memberships from all groups and returns the deleted members.
Group	getGroup(String name)	Returns the group with the specified name or null if it could not be found.
Set<Membership>	getGroupMembers(String name)	Returns the members of the group name as set.
Set<Group>	getGroups()	Lists all groups.
boolean	removeGroupMember(IdentityPublicKey member, String groupName)	Removes the member from the given group.
boolean	updateGroup(Group group)	Updates the specified group.

Methods inherited from class java.lang.Object

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

Field Details

QUERY_TIMEOUT

public static final int QUERY_TIMEOUT

See Also:

• Constant Field Values

SCHEME

public static final String SCHEME

See Also:

• Constant Field Values

Constructor Details

JDBCDatabaseAdapter

public JDBCDatabaseAdapter(URI uri)
                    throws DatabaseException

Throws:

DatabaseException

Method Details

addGroup

public boolean addGroup(Group group)
                 throws DatabaseException

Description copied from interface: DatabaseAdapter

Adds a group to the database if it doesn't exist already.

Specified by:

addGroup in interface DatabaseAdapter

Parameters:

group - the group that should be added

Returns:

true if the group was added, false if it already exist

Throws:

DatabaseException - if an error occurs during the execution

addGroupMember

public boolean addGroupMember(Membership membership)
                       throws DatabaseException

Description copied from interface: DatabaseAdapter

Adds or updates the given groupMember#member to the given groupMember#group.

Specified by:

addGroupMember in interface DatabaseAdapter

Parameters:

membership - the entry that should be added or updated

Returns:

true if the member was inserted and not updated

Throws:

DatabaseException - if an error occurs during the execution

getGroup

public Group getGroup(String name)
               throws DatabaseException

Description copied from interface: DatabaseAdapter

Returns the group with the specified name or null if it could not be found.

Specified by:

getGroup in interface DatabaseAdapter

Parameters:

name - the name of the group

Returns:

group or null if it could not be found

Throws:

DatabaseException - if an error occurs during the deletion

getGroups

public Set<Group> getGroups()
                     throws DatabaseException

Description copied from interface: DatabaseAdapter

Lists all groups.

Specified by:

getGroups in interface DatabaseAdapter

Returns:

List with all groups

Throws:

DatabaseException - if an error occurs during the execution

deleteGroup

public boolean deleteGroup(String name)
                    throws DatabaseException

Description copied from interface: DatabaseAdapter

Deleted the group with the specified name.

Specified by:

deleteGroup in interface DatabaseAdapter

Parameters:

name - the name of the group

Returns:

true if group was deleted. Otherwise false.

Throws:

DatabaseException - if an error occurs during removal

updateGroup

public boolean updateGroup(Group group)
                    throws DatabaseException

Description copied from interface: DatabaseAdapter

Updates the specified group.

Specified by:

updateGroup in interface DatabaseAdapter

Parameters:

group - the new desired group state (name is unchangeable)

Returns:

true if group was updated. Otherwise false.

Throws:

DatabaseException - if an error occurs during update

getGroupMembers

public Set<Membership> getGroupMembers(String name)
                                throws DatabaseException

Description copied from interface: DatabaseAdapter

Returns the members of the group name as set.

Specified by:

getGroupMembers in interface DatabaseAdapter

Parameters:

name - the group name

Returns:

members of the group as set

Throws:

DatabaseException - if an error occurs during the execution

removeGroupMember

public boolean removeGroupMember(IdentityPublicKey member,
 String groupName)
                          throws DatabaseException

Description copied from interface: DatabaseAdapter

Removes the member from the given group.

Specified by:

removeGroupMember in interface DatabaseAdapter

Parameters:

member - the member to remove

groupName - the group

Returns:

true if memberships was deleted. Otherwise false.

Throws:

DatabaseException - if an exception occurs during removal

close

public void close()
           throws DatabaseException

Description copied from interface: DatabaseAdapter

Closes the connection to the database.

Specified by:

close in interface DatabaseAdapter

Throws:

DatabaseException - if an error occurs during closing

deleteStaleMemberships

public Set<Membership> deleteStaleMemberships()
                                       throws DatabaseException

Description copied from interface: DatabaseAdapter

Deletes all stale memberships from all groups and returns the deleted members.

Specified by:

deleteStaleMemberships in interface DatabaseAdapter

Throws:

DatabaseException - if an error occurred during deletion