com.openkm.principal

Class DatabasePrincipalAdapter

java.lang.Object

com.openkm.principal.DatabasePrincipalAdapter

All Implemented Interfaces:

PrincipalAdapter

public class DatabasePrincipalAdapter
extends Object
implements PrincipalAdapter

Constructor Summary

Constructors

Constructor and Description
DatabasePrincipalAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	assignRole(String user, String role) Method to assign a role
void	createRole(String role, boolean active) Method to create a new role
void	createUser(String user, String password, String email, String name, boolean active) Method to create a new user
void	deleteRole(String role) Method to create a delete a role
void	deleteUser(String user) Method to create a delete a user
String	getMail(String user) Method to retrieve the mail from a user.
String	getName(String user) Method to retrieve the name from a user.
String	getPassword(String user) Method to retrieve the user password
List<String>	getRoles() Method to retrieve all roles from a authentication source.
List<String>	getRolesByUser(String user) Method to retrieve all roles from a user.
List<String>	getUsers() Method to retrieve all users from a authentication source.
List<String>	getUsersByRole(String role) Method to retrieve all users from a role.
void	removeRole(String user, String role) Method to remove a role
void	updateRole(String role, boolean active) Update role information
void	updateUser(String user, String password, String email, String name, boolean active) Update user information

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabasePrincipalAdapter

public DatabasePrincipalAdapter()

Method Detail

getUsers

public List<String> getUsers()
                      throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to retrieve all users from a authentication source.

Specified by:

getUsers in interface PrincipalAdapter

Returns:

A Collection with all the users.

Throws:

PrincipalAdapterException - If any error occurs.

getRoles

public List<String> getRoles()
                      throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to retrieve all roles from a authentication source.

Specified by:

getRoles in interface PrincipalAdapter

Returns:

A Collection with all the roles.

Throws:

PrincipalAdapterException - If any error occurs.

getUsersByRole

public List<String> getUsersByRole(String role)
                            throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to retrieve all users from a role.

Specified by:

getUsersByRole in interface PrincipalAdapter

Returns:

A Collection with all the users within a role.

Throws:

PrincipalAdapterException - If any error occurs.

getRolesByUser

public List<String> getRolesByUser(String user)
                            throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to retrieve all roles from a user.

Specified by:

getRolesByUser in interface PrincipalAdapter

Returns:

A Collection with all the roles of the user.

Throws:

PrincipalAdapterException - If any error occurs.

getMail

public String getMail(String user)
               throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to retrieve the mail from a user.

Specified by:

getMail in interface PrincipalAdapter

Parameters:

user - A user id.

Returns:

The email of the user.

Throws:

PrincipalAdapterException - If any error occurs.

getName

public String getName(String user)
               throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to retrieve the name from a user.

Specified by:

getName in interface PrincipalAdapter

Parameters:

user - A user id.

Returns:

The name of the user.

Throws:

PrincipalAdapterException - If any error occurs.

getPassword

public String getPassword(String user)
                   throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to retrieve the user password

Specified by:

getPassword in interface PrincipalAdapter

Parameters:

user - A user id.

Returns:

The password of the user.

Throws:

PrincipalAdapterException - If any error occurs.

createUser

public void createUser(String user,
              String password,
              String email,
              String name,
              boolean active)
                throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to create a new user

Specified by:

createUser in interface PrincipalAdapter

Parameters:

user - A user id.

password - The password of the user.

email - The user mail.

name - The full user name.

Throws:

PrincipalAdapterException - If any error occurs.

deleteUser

public void deleteUser(String user)
                throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to create a delete a user

Specified by:

deleteUser in interface PrincipalAdapter

Parameters:

user - A user id.

Throws:

PrincipalAdapterException - If any error occurs.

updateUser

public void updateUser(String user,
              String password,
              String email,
              String name,
              boolean active)
                throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Update user information

Specified by:

updateUser in interface PrincipalAdapter

Parameters:

user - A user id.

password - The password of the user.

email - The user mail.

name - The full user name.

Throws:

PrincipalAdapterException - If any error occurs.

createRole

public void createRole(String role,
              boolean active)
                throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to create a new role

Specified by:

createRole in interface PrincipalAdapter

Parameters:

role - A role id.

Throws:

PrincipalAdapterException - If any error occurs.

deleteRole

public void deleteRole(String role)
                throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to create a delete a role

Specified by:

deleteRole in interface PrincipalAdapter

Parameters:

role - A role id.

Throws:

PrincipalAdapterException - If any error occurs.

updateRole

public void updateRole(String role,
              boolean active)
                throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Update role information

Specified by:

updateRole in interface PrincipalAdapter

Parameters:

role - A role id..

Throws:

PrincipalAdapterException - If any error occurs.

assignRole

public void assignRole(String user,
              String role)
                throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to assign a role

Specified by:

assignRole in interface PrincipalAdapter

Parameters:

user - A user id.

role - A role id.

Throws:

PrincipalAdapterException - If any error occurs.

removeRole

public void removeRole(String user,
              String role)
                throws PrincipalAdapterException

Description copied from interface: PrincipalAdapter

Method to remove a role

Specified by:

removeRole in interface PrincipalAdapter

Parameters:

user - A user id.

role - A role id.

Throws:

PrincipalAdapterException - If any error occurs.