com.openkm.principal

Interface PrincipalAdapter

All Known Implementing Classes:

DatabasePrincipalAdapter, DummyPrincipalAdapter, LdapPrincipalAdapter, UsersRolesPrincipalAdapter

public interface PrincipalAdapter

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

Method Detail

getUsers

List<String> getUsers()
                      throws PrincipalAdapterException

Method to retrieve all users from a authentication source.

Returns:

A Collection with all the users.

Throws:

PrincipalAdapterException - If any error occurs.

getRoles

List<String> getRoles()
                      throws PrincipalAdapterException

Method to retrieve all roles from a authentication source.

Returns:

A Collection with all the roles.

Throws:

PrincipalAdapterException - If any error occurs.

getUsersByRole

List<String> getUsersByRole(String role)
                            throws PrincipalAdapterException

Method to retrieve all users from a role.

Returns:

A Collection with all the users within a role.

Throws:

PrincipalAdapterException - If any error occurs.

getRolesByUser

List<String> getRolesByUser(String user)
                            throws PrincipalAdapterException

Method to retrieve all roles from a user.

Returns:

A Collection with all the roles of the user.

Throws:

PrincipalAdapterException - If any error occurs.

getMail

String getMail(String user)
               throws PrincipalAdapterException

Method to retrieve the mail from a user.

Parameters:

user - A user id.

Returns:

The email of the user.

Throws:

PrincipalAdapterException - If any error occurs.

getName

String getName(String user)
               throws PrincipalAdapterException

Method to retrieve the name from a user.

Parameters:

user - A user id.

Returns:

The name of the user.

Throws:

PrincipalAdapterException - If any error occurs.

getPassword

String getPassword(String user)
                   throws PrincipalAdapterException

Method to retrieve the user password

Parameters:

user - A user id.

Returns:

The password of the user.

Throws:

PrincipalAdapterException - If any error occurs.

createUser

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

Method to create a new user

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

void deleteUser(String user)
                throws PrincipalAdapterException

Method to create a delete a user

Parameters:

user - A user id.

Throws:

PrincipalAdapterException - If any error occurs.

updateUser

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

Update user information

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

void createRole(String role,
              boolean active)
                throws PrincipalAdapterException

Method to create a new role

Parameters:

role - A role id.

Throws:

PrincipalAdapterException - If any error occurs.

deleteRole

void deleteRole(String role)
                throws PrincipalAdapterException

Method to create a delete a role

Parameters:

role - A role id.

Throws:

PrincipalAdapterException - If any error occurs.

updateRole

void updateRole(String role,
              boolean active)
                throws PrincipalAdapterException

Update role information

Parameters:

role - A role id..

Throws:

PrincipalAdapterException - If any error occurs.

assignRole

void assignRole(String user,
              String role)
                throws PrincipalAdapterException

Method to assign a role

Parameters:

user - A user id.

role - A role id.

Throws:

PrincipalAdapterException - If any error occurs.

removeRole

void removeRole(String user,
              String role)
                throws PrincipalAdapterException

Method to remove a role

Parameters:

user - A user id.

role - A role id.

Throws:

PrincipalAdapterException - If any error occurs.