com.openkm.api

Class OKMAuth

java.lang.Object

com.openkm.api.OKMAuth

All Implemented Interfaces:

AuthModule

public class OKMAuth
extends Object
implements AuthModule

Method Summary

Modifier and Type	Method and Description
void	assignRole(String token, String user, String role) Method to assign a role
void	changeSecurity(String token, String nodePath, Map<String,Integer> grantUsers, Map<String,Integer> revokeUsers, Map<String,Integer> grantRoles, Map<String,Integer> revokeRoles, boolean recursive) Change several security permissions in the same call.
void	createRole(String token, String role, boolean active) Method to create a new role
void	createUser(String token, String user, String password, String email, String name, boolean active) Method to create a new user
void	deleteRole(String token, String role) Method to create a delete a role
void	deleteUser(String token, String user) Method to create a delete a user
Map<String,Integer>	getGrantedRoles(String token, String nodePath) Get roles permissions from am item (document or folder).
Map<String,Integer>	getGrantedUsers(String token, String nodePath) Get user permissions from am item (document or folder).
static OKMAuth	getInstance()
String	getMail(String token, String user) Retrieves the mail from an user.
String	getName(String token, String user) Retrieves the name from an user.
List<String>	getRoles(String token) Retrieves a list of repository roles.
List<String>	getRolesByUser(String token, String user) Retrieves a list of roles by user.
List<String>	getUsers(String token) Retrieves a list of repository users
List<String>	getUsersByRole(String token, String role) Retrieves a list of users by role.
void	grantRole(String token, String nodePath, String role, int permissions, boolean recursive) Grant role permissions for a node.
void	grantUser(String token, String nodePath, String user, int permissions, boolean recursive) Add user permissions to a node.
void	login() Logins into the repository.
String	login(String user, String pass)
void	logout(String token) Log out from the repository.
void	removeRole(String token, String user, String role) Method to remove a role
void	revokeRole(String token, String nodePath, String role, int permissions, boolean recursive) Revoke role permissions from a node.
void	revokeUser(String token, String nodePath, String user, int permissions, boolean recursive) Revoke user permissions from a node.
void	updateRole(String token, String role, boolean active) Update role information
void	updateUser(String token, 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

Method Detail

getInstance

public static OKMAuth getInstance()

login

public void login()
           throws RepositoryException,
                  DatabaseException

Description copied from interface: AuthModule

Logins into the repository.

Specified by:

login in interface AuthModule

Throws:

RepositoryException

DatabaseException

login

public String login(String user,
                    String pass)
             throws AccessDeniedException,
                    RepositoryException,
                    DatabaseException

Specified by:

login in interface AuthModule

Throws:

AccessDeniedException

RepositoryException

DatabaseException

logout

public void logout(String token)
            throws RepositoryException,
                   DatabaseException

Description copied from interface: AuthModule

Log out from the repository.

Specified by:

logout in interface AuthModule

Throws:

RepositoryException

DatabaseException

grantUser

public void grantUser(String token,
                      String nodePath,
                      String user,
                      int permissions,
                      boolean recursive)
               throws PathNotFoundException,
                      AccessDeniedException,
                      RepositoryException,
                      DatabaseException

Description copied from interface: AuthModule

Add user permissions to a node.

Specified by:

grantUser in interface AuthModule

nodePath - The complete path to the node or its UUID.

user - User name which permissions are changed.

permissions - A mask with the permissions to be added.

recursive - recursive – If the nodePath indicated a folder, the permissions can be applied recursively.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

revokeUser

public void revokeUser(String token,
                       String nodePath,
                       String user,
                       int permissions,
                       boolean recursive)
                throws PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       DatabaseException

Description copied from interface: AuthModule

Revoke user permissions from a node.

Specified by:

revokeUser in interface AuthModule

nodePath - The complete path to the node or its UUID.

user - User name which permissions are changed.

permissions - A mask with the permissions to be removed.

recursive - If the nodePath indicates a folder, the permissions can be revoked recursively.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

getGrantedUsers

public Map<String,Integer> getGrantedUsers(String token,
                                           String nodePath)
                                    throws PathNotFoundException,
                                           AccessDeniedException,
                                           RepositoryException,
                                           DatabaseException

Description copied from interface: AuthModule

Get user permissions from am item (document or folder).

Specified by:

getGrantedUsers in interface AuthModule

nodePath - The complete path to the node or its UUID.

Returns:

A hashmap with pairs of user / permissions.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

grantRole

public void grantRole(String token,
                      String nodePath,
                      String role,
                      int permissions,
                      boolean recursive)
               throws PathNotFoundException,
                      AccessDeniedException,
                      RepositoryException,
                      DatabaseException

Description copied from interface: AuthModule

Grant role permissions for a node.

Specified by:

grantRole in interface AuthModule

nodePath - The complete path to the node or its UUID.

role - Role name which permissions are changed.

permissions - A mask with the permissions to be added.

recursive - If the nodePath indicates a folder, the permissions can be applied recursively.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

revokeRole

public void revokeRole(String token,
                       String nodePath,
                       String role,
                       int permissions,
                       boolean recursive)
                throws PathNotFoundException,
                       AccessDeniedException,
                       RepositoryException,
                       DatabaseException

Description copied from interface: AuthModule

Revoke role permissions from a node.

Specified by:

revokeRole in interface AuthModule

nodePath - The complete path to the node or its UUID.

role - Role name which permissions are changed.

permissions - A mask with the permissions to be removed.

recursive - If the nodePath indicates a folder, the permissions can be applied recursively.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

getGrantedRoles

public Map<String,Integer> getGrantedRoles(String token,
                                           String nodePath)
                                    throws PathNotFoundException,
                                           AccessDeniedException,
                                           RepositoryException,
                                           DatabaseException

Description copied from interface: AuthModule

Get roles permissions from am item (document or folder).

Specified by:

getGrantedRoles in interface AuthModule

nodePath - The complete path to the node or its UUID.

Returns:

A hashmap with pairs of role / permissions.

Throws:

PathNotFoundException - If the node defined by nodePath do not exists.

AccessDeniedException - If the authorization information is not valid.

RepositoryException - If there is any error accessing to the repository.

DatabaseException

getUsers

public List<String> getUsers(String token)
                      throws PrincipalAdapterException

Description copied from interface: AuthModule

Retrieves a list of repository users

Specified by:

getUsers in interface AuthModule

Returns:

A collection of repository users.

Throws:

PrincipalAdapterException

getRoles

public List<String> getRoles(String token)
                      throws PrincipalAdapterException

Description copied from interface: AuthModule

Retrieves a list of repository roles.

Specified by:

getRoles in interface AuthModule

Returns:

A collection of repository roles.

Throws:

PrincipalAdapterException

getUsersByRole

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

Description copied from interface: AuthModule

Retrieves a list of users by role.

Specified by:

getUsersByRole in interface AuthModule

Returns:

A repository role.

Throws:

PrincipalAdapterException

getRolesByUser

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

Description copied from interface: AuthModule

Retrieves a list of roles by user.

Specified by:

getRolesByUser in interface AuthModule

Returns:

A repository user.

Throws:

PrincipalAdapterException

getMail

public String getMail(String token,
                      String user)
               throws PrincipalAdapterException

Description copied from interface: AuthModule

Retrieves the mail from an user.

Specified by:

getMail in interface AuthModule

user - The user id.

Returns:

A email of the user.

Throws:

PrincipalAdapterException

getName

public String getName(String token,
                      String user)
               throws PrincipalAdapterException

Description copied from interface: AuthModule

Retrieves the name from an user.

Specified by:

getName in interface AuthModule

user - The user id.

Returns:

A name of the user.

Throws:

PrincipalAdapterException

changeSecurity

public void changeSecurity(String token,
                           String nodePath,
                           Map<String,Integer> grantUsers,
                           Map<String,Integer> revokeUsers,
                           Map<String,Integer> grantRoles,
                           Map<String,Integer> revokeRoles,
                           boolean recursive)
                    throws PathNotFoundException,
                           AccessDeniedException,
                           RepositoryException,
                           DatabaseException

Description copied from interface: AuthModule

Change several security permissions in the same call.

Specified by:

changeSecurity in interface AuthModule

Throws:

PathNotFoundException

AccessDeniedException

RepositoryException

DatabaseException

createUser

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

Description copied from interface: AuthModule

Method to create a new user

Specified by:

createUser in interface AuthModule

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 token,
                       String user)
                throws PrincipalAdapterException

Description copied from interface: AuthModule

Method to create a delete a user

Specified by:

deleteUser in interface AuthModule

user - A user id.

Throws:

PrincipalAdapterException - If any error occurs.

updateUser

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

Description copied from interface: AuthModule

Update user information

Specified by:

updateUser in interface AuthModule

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 token,
                       String role,
                       boolean active)
                throws PrincipalAdapterException

Description copied from interface: AuthModule

Method to create a new role

Specified by:

createRole in interface AuthModule

role - A role id.

Throws:

PrincipalAdapterException - If any error occurs.

deleteRole

public void deleteRole(String token,
                       String role)
                throws PrincipalAdapterException

Description copied from interface: AuthModule

Method to create a delete a role

Specified by:

deleteRole in interface AuthModule

role - A role id.

Throws:

PrincipalAdapterException - If any error occurs.

updateRole

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

Description copied from interface: AuthModule

Update role information

Specified by:

updateRole in interface AuthModule

role - A role id..

Throws:

PrincipalAdapterException - If any error occurs.

assignRole

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

Description copied from interface: AuthModule

Method to assign a role

Specified by:

assignRole in interface AuthModule

user - A user id.

role - A role id.

Throws:

PrincipalAdapterException - If any error occurs.

removeRole

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

Description copied from interface: AuthModule

Method to remove a role

Specified by:

removeRole in interface AuthModule

user - A user id.

role - A role id.

Throws:

PrincipalAdapterException - If any error occurs.