com.openkm.principal

Class UsersRolesPrincipalAdapter

java.lang.Object

com.openkm.principal.UsersRolesPrincipalAdapter

All Implemented Interfaces:

PrincipalAdapter

public class UsersRolesPrincipalAdapter
extends Object
implements PrincipalAdapter

Constructor Summary

Constructors

Constructor and Description
UsersRolesPrincipalAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersRolesPrincipalAdapter

public UsersRolesPrincipalAdapter()

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

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.