| java.lang.Object
 org.manentia.kasai.KasaiFacade
| KasaiFacade | | public class KasaiFacade (Code) | | Class to provide authority and authorization functionalities
author:
fpena
author:
(c) 2004 Koala Developers S.R.L. |
| Method Summary | |
| public void | addOperativeToRole(String loginUser, String idOperative, int role, String clientIP)
Add one operative to a specific role. | | public void | addUserToGroup(String loginUser, String idGroup, String idUserToAdd, String clientIP)
| | public void | blockGroup(String loginUser, String idGroup, String clientIP)
Method to block just the group, not the users. | | public void | blockUser(String loginUser, String idUserToBlock, String clientIP)
Method to block a specific user. | | public void | changePasswordUser(String login, String oldPassword, String newPassword, String confirmation, String clientIP)
| | public boolean | checkOperative(String login, String operative, String object)
| | public void | checkPasswordUser(String login, String password, String clientIP)
| | public void | copyObjectRoles(String loginUser, String sourceObject, String destinationObject)
Copy all permissions from one object to another. | | public void | createAuditEntry(String userId, int returnCode, String errorDescription, long duration, String clientIP, String operation, String objectID, Document transactionData)
| | public void | createAuditEntry(String userId, int returnCode, String errorDescription, long duration, String clientIP, String operation, String objectID, HashMap<String, String> transactionData)
| | public void | createGroup(String loginUser, Group group, String clientIP)
| | public void | createGroup(String loginUser, String id, String description, boolean blocked, String clientIP)
| | public void | createObject(String loginUser, String objectId)
Method to register a new object in kasai. | | public void | createObjectGroupRole(String loginUser, String objectId, String group, int role, String clientIP)
Method to assign permissions. | | public void | createObjectUserRole(String objectId, String user, int role)
Method to assign permissions. | | public void | createObjectUserRole(String loginUser, String objectId, String user, int role, String clientIP)
Method to assign permissions. | | public void | createObjectWithRole(String loginUser, String objectId, int roleId)
| | public int | createRole(String loginUser, String name, String description, String[] operatives, String clientIP)
| | public void | createUser(String loginUser, String idUser, String firstName, String lastName, String email, boolean blocked, String description, boolean superUser, String clientIP)
| | public void | createUser(String loginUser, String idUser, String firstName, String lastName, String email, boolean blocked, String description, boolean superUser, String password, String clientIP)
| | public void | createUser(String loginUser, User user, String password, String clientIP)
| | public void | deleteGroup(String loginUser, String group, String clientIP)
| | public void | deleteObject(String objectId)
| | public void | deleteObjectGroupRole(String loginUser, int id, String clientIP)
| | public void | deleteObjectUserRole(String loginUser, int id, String clientIP)
| | public void | deleteObjectUserRole(String user, String idObject)
| | public void | deleteObjectUserRole(String loginUser, String user, String idObject, int role, String clientIP)
| | public void | deleteObjectUserRole(String loginUser, String user, String idObject, String clientIP)
| | public void | deleteRole(String loginUser, int role, String clientIP)
| | public void | deleteUser(String loginUser, String idUserToDelete, String clientIP)
| | public static synchronized KasaiFacade | getInstance()
| | public boolean | isUserInGroup(String login, String userId, String groupId)
| | public Collection<AuditBean> | listAuditEntries(String loginUser, java.util.Date dateFrom, java.util.Date dateTo, java.lang.String user, java.lang.String operation, String clientIP)
| | public String[] | listGroupMembers(String groupId)
| | public List<Group> | listGroups(String actualUser, String idGroup, String description, int blocked, int system)
| | public Collection<Group> | listGroupsFromUser(String user)
| | public Collection<Group> | listGroupsFromUser(String loginUser, String user)
| | public Collection<Group> | listGroupsOperativeCollection(String operative, String object)
List groups that have a given operative assigned over a specific object. | | public Collection | listObjectRoles(String loginUser, String idObject)
| | public Collection<Operative> | listOperatives(String loginUser)
| | public Collection<Operative> | listOperativesFromRole(String loginUser, int role)
| | public Collection<Operative> | listOperativesNotInRole(String loginUser, int role)
| | public List<Role> | listRoles(String loginUser, String name)
| | public String[] | listUsernames()
| | public List<User> | listUsers(String loginUser, String login, String firstName, String lastName, String email, int blocked, String description, String group)
| | public Collection<User> | listUsersFromGroup(String group)
| | public Collection<User> | listUsersFromGroup(String loginUser, String group)
| | public Collection<User> | listUsersNotInGroup(String loginUser, String group)
| | public Collection<User> | listUsersOperative(String operative, String object)
List users that have a given operative assigned over a specific object. | | public void | modifyRole(String loginUser, int role, String name, String description, String[] operatives, String clientIP)
| | public Group | readGroup(String group)
| | public Group | readGroup(String loginUser, String group, String clientIP)
| | public Role | readRole(int role)
| | public Role | readRole(String loginUser, int role)
| | public User | readUser(String login)
| | public User | readUser(String loginUser, String login, String clientIP)
Read a user checking permission and auditing the transaction. | | public void | remindPasswordUser(String loginUser, String clientIP)
Reset the user password and send it to his email. | | public void | removeOperativeFromRole(String loginUser, String idOperative, int role, String clientIP)
| | public void | removeUserFromGroup(String loginUser, String idGroup, String login, String clientIP)
| | public void | resetPasswordUser(String actualUser, String login, String clientIP)
| | public void | unblockGroup(String loginUser, String idGroup, String clientIP)
| | public void | unblockUser(String loginUser, String login, String clientIP)
| | public void | updateGroup(String loginUser, Group group, String[] members, String clientIP)
| | public void | updateGroup(String loginUser, String id, String description, boolean blocked, String[] members, String clientIP)
| | public void | updateUser(String loginUser, String login, String firstName, String lastName, String email, boolean blocked, String description, boolean superUser, String clientIP)
| | public void | updateUser(String loginUser, User user, String clientIP)
| | public void | validateOperative(String user, String operative, String object)
|
| ADD_USER_TO_GROUP | | final static String ADD_USER_TO_GROUP(Code) | | Permission to add users to a group
|
| BLOCK_GROUP | | final static String BLOCK_GROUP(Code) | | Permission to block a group
|
| BLOCK_USER | | final static String BLOCK_USER(Code) | | Permission to block a user
|
| COMMIT_GROUP | | final static String COMMIT_GROUP(Code) | | Permission to modify a group
|
| COMMIT_ROLE | | final static String COMMIT_ROLE(Code) | | Permission to modify a role
|
| COMMIT_USER | | final static String COMMIT_USER(Code) | | Permission to modify a user
|
| DELETE_GROUP | | final static String DELETE_GROUP(Code) | | Permission to delete a group
|
| DELETE_ROLE | | final static String DELETE_ROLE(Code) | | Permission to delete a role
|
| DELETE_USER | | final static String DELETE_USER(Code) | | Permission to delete a user
|
| DELETE_USER_GROUP | | final static String DELETE_USER_GROUP(Code) | | Permission to delete a user from a group
|
| LIST_AUDIT_ENTRIES | | final static String LIST_AUDIT_ENTRIES(Code) | | |
| MODIFY_ACCESS | | final static String MODIFY_ACCESS(Code) | | Permission to modify permissions of a object
|
| READ_GROUP | | final static String READ_GROUP(Code) | | Permission to read a group
|
| READ_ROLE | | final static String READ_ROLE(Code) | | Permission to read a role
|
| READ_USER | | final static String READ_USER(Code) | | Permission to read a user
|
| RESET_PASSWORD_USER | | final static String RESET_PASSWORD_USER(Code) | | Permission to reset a user password
|
| UNBLOCK_GROUP | | final static String UNBLOCK_GROUP(Code) | | Permission to unblock a group
|
| UNBLOCK_USER | | final static String UNBLOCK_USER(Code) | | Permission to unblock a user
|
| blockGroup | | public void blockGroup(String loginUser, String idGroup, String clientIP) throws DataAccessException, InvalidAttributesException, NotEnoughPermissionException, DoesntExistsException, CannotAuditException, XMLException(Code) | | Method to block just the group, not the users. Users lost permissions assigned to them through the group.
Parameters:
loginUser - User who is making the request
Parameters:
idGroup - Group identifier
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
InvalidAttributesException - Group existing attributes are not correct
throws:
NotEnoughPermissionException - The user cannot execute this operative
throws:
DoesntExistsException - The group does not exist
throws:
CannotAuditException - Error auditing transaction
throws:
XMLException - |
| blockUser | | public void blockUser(String loginUser, String idUserToBlock, String clientIP) throws DataAccessException, InvalidAttributesException, NotEnoughPermissionException, DoesntExistsException, CannotAuditException, XMLException(Code) | | Method to block a specific user. After this, user is disabled to use the application.
Parameters:
loginUser - User who is making the request
Parameters:
idUserToBlock - User identifier
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
InvalidAttributesException - Existing user information is invalid
throws:
NotEnoughPermissionException - The user cannot perform this operation
throws:
DoesntExistsException - The selected user does not exist
throws:
CannotAuditException - Error auditing transaction
throws:
XMLException - |
| changePasswordUser | | public void changePasswordUser(String login, String oldPassword, String newPassword, String confirmation, String clientIP) throws DataAccessException, InvalidAttributesException, ServiceException, ServiceNotAvailableException, DoesntExistsException, CannotAuditException, InvalidPasswordException, XMLException(Code) | | Method to change the user's password
Parameters:
login - User who is making the request
Parameters:
oldPassword - Actual password
Parameters:
newPassword - New password
Parameters:
confirmation - Confirmation password
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
InvalidAttributesException - Existing user info or new password are not valid
throws:
ServiceException - Error changing password at the authentication service level
throws:
ServiceNotAvailableException - The authentication service is not available
throws:
DoesntExistsException - The user does not exists
throws:
CannotAuditException - Error auditing operation
throws:
InvalidPasswordException - The old password is not valid
throws:
XMLException - |
| checkOperative | | public boolean checkOperative(String login, String operative, String object)(Code) | | Method to verify if a user can do a specific operative over the object identified by object parameter
Parameters:
login - User who is making the request
Parameters:
operative - Operative to run over the object
Parameters:
object - Id of the object True if the user can do the operative over this object, false in other case |
| checkPasswordUser | | public void checkPasswordUser(String login, String password, String clientIP) throws DataAccessException, NotFoundException, UserBlockedException, InvalidPasswordException, ServiceException, ServiceNotAvailableException, CannotAuditException, XMLException(Code) | | Method to verify user's password
Parameters:
login - User who is making the request
Parameters:
password - User password
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
NotFoundException - The user does not exist
throws:
UserBlockedException - The user is blocked
throws:
InvalidPasswordException - The password is not valid
throws:
ServiceException - The authentication service raised an error while validating the password
throws:
ServiceNotAvailableException - The authentication service is not available
throws:
CannotAuditException - Error auditing operation
throws:
XMLException - |
| createAuditEntry | | public void createAuditEntry(String userId, int returnCode, String errorDescription, long duration, String clientIP, String operation, String objectID, Document transactionData) throws CannotAuditException(Code) | | Audit an operation
Parameters:
userId - User who is making the request
Parameters:
returnCode - Return code
Parameters:
errorDescription - Error description
Parameters:
duration - Duration in milliseconds
Parameters:
clientIP - IP Address of whom is making the request
Parameters:
operation - Operation executed
Parameters:
objectID - Object involved in the operation
Parameters:
transactionData - Extra data
throws:
CannotAuditException - A severe error ocurred while writing the audit entry |
| createAuditEntry | | public void createAuditEntry(String userId, int returnCode, String errorDescription, long duration, String clientIP, String operation, String objectID, HashMap<String, String> transactionData) throws CannotAuditException(Code) | | Audits an operation
Parameters:
userId - User who is making the request
Parameters:
returnCode - Return code
Parameters:
errorDescription - Error description
Parameters:
duration - Duration in milliseconds
Parameters:
clientIP - IP Address of whom is making the request
Parameters:
operation - Operation executed
Parameters:
objectID - Object involved in the operation
Parameters:
transactionData - Extra data
throws:
CannotAuditException - A severe error ocurred while writing the audit entry |
| createGroup | | public void createGroup(String loginUser, String id, String description, boolean blocked, String clientIP) throws DataAccessException, AlreadyExistsException, InvalidAttributesException, NotEnoughPermissionException, CannotAuditException, CriticalException(Code) | | Method to create a group
Parameters:
loginUser - User who is making the request
Parameters:
id - Group Group Identifier
Parameters:
description - Group description
Parameters:
blocked - Specify if the group must be blocked or not
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
AlreadyExistsException - A group with the given ID already exists
throws:
InvalidAttributesException - The attributes are not valid for a group
throws:
NotEnoughPermissionException - The user does not have enough permission to execute this operation
throws:
CannotAuditException - Error auditing transaction
throws:
CriticalException - Severe error creating group |
| createObject | | public void createObject(String loginUser, String objectId) throws DataAccessException, CriticalException(Code) | | Method to register a new object in kasai. It Method assign to the loginUser the role specified in the properties file
with the property kasai.default.role
Parameters:
loginUser - User who is making the request
Parameters:
objectId - Object identifier
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
CriticalException - The object could be created but not its default permissions |
| createObjectGroupRole | | public void createObjectGroupRole(String loginUser, String objectId, String group, int role, String clientIP) throws DataAccessException, DoesntExistsException, NotEnoughPermissionException, CannotAuditException, XMLException(Code) | | Method to assign permissions. This assign the role specified to the group over the object identified by objectId
Parameters:
loginUser - User who is making the request
Parameters:
objectId - Object identifier
Parameters:
group - Group identifier
Parameters:
role - Role identifier
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
DoesntExistsException - The object, group or role doesnt exists
throws:
NotEnoughPermissionException - The user cannot perform this operation
throws:
CannotAuditException - Error auditing transaction
throws:
XMLException - |
| createObjectUserRole | | public void createObjectUserRole(String objectId, String user, int role) throws DataAccessException, DoesntExistsException, XMLException(Code) | | Method to assign permissions. This assign the role specified to the user over the object identified by objectId
Parameters:
objectId - User who is making the request
Parameters:
user - User identifier
Parameters:
role - Role identifier
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
DoesntExistsException - The object, user or role doesnt exist
throws:
XMLException - |
| createObjectUserRole | | public void createObjectUserRole(String loginUser, String objectId, String user, int role, String clientIP) throws DataAccessException, DoesntExistsException, NotEnoughPermissionException, CannotAuditException, XMLException(Code) | | Method to assign permissions. This assign the role specified to the user over the object identified by objectId
Parameters:
loginUser - User who is making the request
Parameters:
objectId - Object identifier
Parameters:
user - User identifier
Parameters:
role - Role identifier
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
DoesntExistsException - The user, object or role doesnt exist
throws:
NotEnoughPermissionException - The user cannot perform this operation
throws:
CannotAuditException - Error auditing transaction
throws:
XMLException - |
| createObjectWithRole | | public void createObjectWithRole(String loginUser, String objectId, int roleId) throws DataAccessException, DoesntExistsException, XMLException(Code) | | Register an object in Kasai, and assign to the user the specified role (roleId) over an object (objectId)
Parameters:
loginUser - User who is making the request
Parameters:
objectId - Object Identifier
Parameters:
roleId - Role identifier
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
DoesntExistsException - The user, object or role doesnt exist
throws:
XMLException - |
| createRole | | public int createRole(String loginUser, String name, String description, String[] operatives, String clientIP) throws AlreadyExistsException, DoesntExistsException, DataAccessException, InvalidAttributesException, NotEnoughPermissionException, CannotAuditException, CriticalException(Code) | | Creates a role
Parameters:
loginUser - User who is making the request
Parameters:
name - Name of the role to be created
Parameters:
description - Description of the role to be created
Parameters:
operatives - Operatives of the role to be created
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
CriticalException - Severe errors like SQL error, IO Error, etc
throws:
AlreadyExistsException - A role with the given name already exists
throws:
DoesntExistsException - One of the given operatives does not exist
throws:
InvalidAttributesException - The attributes are not valid for a role
throws:
NotEnoughPermissionException - The user cannot perform this operation
throws:
CannotAuditException - Error auditing transaction |
| createUser | | public void createUser(String loginUser, String idUser, String firstName, String lastName, String email, boolean blocked, String description, boolean superUser, String clientIP) throws DataAccessException, AlreadyExistsException, InvalidAttributesException, DoesntExistsException, NotEnoughPermissionException, CannotAuditException, CriticalException, InvalidPasswordException(Code) | | Creates a user
Parameters:
loginUser - User who is making the request
Parameters:
idUser - Identifier of the user to be created
Parameters:
firstName - First Name of the user to be created
Parameters:
lastName - Last Name of the user to be created
Parameters:
email - Email of the user to be created
Parameters:
blocked - Specifies if the user must be blocked or not
Parameters:
description - Description of the user to be created
Parameters:
superUser - Specifies if the user must be superUser or not
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
CriticalException - Severe errors like SQL error, IO Error, etc
throws:
AlreadyExistsException - A user with the given id already exists
throws:
InvalidAttributesException - The attributes are not valid for a user
throws:
DoesntExistsException - The user executing the transaction does not exist
throws:
NotEnoughPermissionException - The user cannot perform this operation
throws:
CannotAuditException - Error auditing transaction
throws:
InvalidPasswordException - |
| createUser | | public void createUser(String loginUser, String idUser, String firstName, String lastName, String email, boolean blocked, String description, boolean superUser, String password, String clientIP) throws DataAccessException, AlreadyExistsException, InvalidAttributesException, DoesntExistsException, NotEnoughPermissionException, CannotAuditException, CriticalException, InvalidPasswordException(Code) | | Creates a user
Parameters:
loginUser - User who is making the request
Parameters:
idUser - Identifier of the user to be created
Parameters:
firstName - First Name of the user to be created
Parameters:
lastName - Last Name of the user to be created
Parameters:
email - Email of the user to be created
Parameters:
blocked - Specifies if the user must be blocked or not
Parameters:
description - Description of the user to be created
Parameters:
superUser - Specifies if the user must be superUser or not
Parameters:
password - Password to assign to the user
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
CriticalException - Severe errors like SQL error, IO Error, etc
throws:
AlreadyExistsException - A user with the given id already exists
throws:
InvalidAttributesException - The attributes are not valid for a user
throws:
DoesntExistsException - The user executing the transaction does not exist
throws:
NotEnoughPermissionException - The user cannot perform this operation
throws:
CannotAuditException - Error auditing transaction |
| createUser | | public void createUser(String loginUser, User user, String password, String clientIP) throws DataAccessException, AlreadyExistsException, InvalidAttributesException, DoesntExistsException, NotEnoughPermissionException, CannotAuditException, CriticalException, InvalidPasswordException(Code) | | |
| deleteObjectUserRole | | public void deleteObjectUserRole(String loginUser, int id, String clientIP) throws DataAccessException, CannotAuditException(Code) | | Remove all assigned roles to the user over an object
Parameters:
loginUser - User who is making the request
Parameters:
id - Relation identifier to be deleted
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
CannotAuditException - Error auditing transaction |
| deleteObjectUserRole | | public void deleteObjectUserRole(String user, String idObject) throws DataAccessException(Code) | | Remove all assigned roles to the user over an object
Parameters:
user - User who is making the request
Parameters:
idObject - Object identifier
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc |
| getInstance | | public static synchronized KasaiFacade getInstance()(Code) | | Returns an instance of KasaiFacade
Instance of KasaiFacade |
| isUserInGroup | | public boolean isUserInGroup(String login, String userId, String groupId) throws DataAccessException, XMLException(Code) | | Method to verify if a specific user is part of a specific group
Parameters:
login - User who is making the request
Parameters:
userId - Specific user
Parameters:
groupId - Specific group true if the userId is part of a groupId
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc Severe error (SQL errors, IO errors, etc)
throws:
XMLException - |
| listGroups | | public List<Group> listGroups(String actualUser, String idGroup, String description, int blocked, int system) throws DataAccessException, XMLException(Code) | | List groups
Parameters:
actualUser - User making the request
Parameters:
idGroup - It filters the list by group identifier
Parameters:
description - It filters the list by group description
Parameters:
blocked - It filters the list by blocked attribute
Parameters:
system - It filters the list by system attribute Groups that satisfy given filters.
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
XMLException - |
| listGroupsFromUser | | public Collection<Group> listGroupsFromUser(String user) throws DataAccessException, XMLException(Code) | | List all the groups a user is member of
Parameters:
user - user identifier A collection containing the groups
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
XMLException - |
| listGroupsOperativeCollection | | public Collection<Group> listGroupsOperativeCollection(String operative, String object) throws DataAccessException, XMLException(Code) | | List groups that have a given operative assigned over a specific object.
Parameters:
operative - Operative
Parameters:
object - Object identifier A collection of groups
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
XMLException - |
| listObjectRoles | | public Collection listObjectRoles(String loginUser, String idObject) throws DataAccessException(Code) | | List assigned permissions over a given object
Parameters:
loginUser - User who is making the request
Parameters:
idObject - Object identifier
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc |
| listUsers | | public List<User> listUsers(String loginUser, String login, String firstName, String lastName, String email, int blocked, String description, String group) throws DataAccessException, XMLException(Code) | | List users
Parameters:
loginUser - User who is making the request
Parameters:
login - It filters the list by the user login
Parameters:
firstName - It filters the list by the user first name
Parameters:
lastName - It filters the list by the user last name
Parameters:
email - It filters the list by the user email
Parameters:
blocked - It filters the list by the block attribute
Parameters:
description - It filters the list by the user description
Parameters:
group - It filters the list by a specific group that the user has to belong to List of users
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
XMLException - |
| listUsersFromGroup | | public Collection<User> listUsersFromGroup(String loginUser, String group) throws DataAccessException, XMLException(Code) | | List group's users checking permission
Parameters:
loginUser - User who is making the request
Parameters:
group - Group identifier List of users
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
XMLException - |
| listUsersNotInGroup | | public Collection<User> listUsersNotInGroup(String loginUser, String group) throws DataAccessException, XMLException(Code) | | List users that aren't part of a group
Parameters:
loginUser - User who is making the request
Parameters:
group - Group identifier List of users
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
XMLException - |
| listUsersOperative | | public Collection<User> listUsersOperative(String operative, String object) throws DataAccessException, XMLException(Code) | | List users that have a given operative assigned over a specific object.
Parameters:
operative - Operative identifier
Parameters:
object - Object identifier A collection of users
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
XMLException - |
| modifyRole | | public void modifyRole(String loginUser, int role, String name, String description, String[] operatives, String clientIP) throws DataAccessException, InvalidAttributesException, NotEnoughPermissionException, CannotAuditException(Code) | | Modify a role
Parameters:
loginUser - User who is making the request
Parameters:
role - Role identifier
Parameters:
name - New name of the role to be modified
Parameters:
description - New description of the role to be modified
Parameters:
operatives - New operatives of the role to be modified
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
InvalidAttributesException - The new attributes are not valid for a role
throws:
NotEnoughPermissionException - The user cannot perform this operation
throws:
CannotAuditException - Error auditing transaction |
| readRole | | public Role readRole(int role) throws DataAccessException(Code) | | Reads a role without checking permission
Parameters:
role - Role identifier An Object Role object representing the object role with the given role id
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc |
| readRole | | public Role readRole(String loginUser, int role) throws DataAccessException(Code) | | Read a role
Parameters:
loginUser - User who is making the request
Parameters:
role - Role identifier Role identified by role parameter or null if the role doesnt' exist
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc |
| resetPasswordUser | | public void resetPasswordUser(String actualUser, String login, String clientIP) throws ServiceException, ServiceNotAvailableException, NotEnoughPermissionException, CannotAuditException, DataAccessException, DoesntExistsException, XMLException(Code) | | Reset the user account password
Parameters:
actualUser - User who is making the request
Parameters:
login - is the login
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
ServiceException - Severe error returned from the authentication service
throws:
ServiceNotAvailableException - The configured authentication service is not available
throws:
NotEnoughPermissionException - The user cannot perform this operation
throws:
CannotAuditException - Error auditing transaction
throws:
DoesntExistsException - The user doesnt exist
throws:
XMLException - |
| updateGroup | | public void updateGroup(String loginUser, String id, String description, boolean blocked, String[] members, String clientIP) throws DataAccessException, InvalidAttributesException, NotEnoughPermissionException, CannotAuditException, DoesntExistsException, XMLException(Code) | | Modify a group
Parameters:
loginUser - User who is making the request
Parameters:
id - group identifier
Parameters:
description - description group
Parameters:
blocked - Specifies if the group must be blocked or not
Parameters:
members - Members of the group
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
InvalidAttributesException - The new group attributes are not valid
throws:
NotEnoughPermissionException - The user cannot perform this operation
throws:
CannotAuditException - Error auditing transaction
throws:
XMLException -
throws:
DoesntExistsException - |
| updateUser | | public void updateUser(String loginUser, String login, String firstName, String lastName, String email, boolean blocked, String description, boolean superUser, String clientIP) throws DataAccessException, InvalidAttributesException, NotEnoughPermissionException, CannotAuditException, DoesntExistsException, XMLException(Code) | | Update User Information
Parameters:
loginUser - User who is making the request
Parameters:
login - identifier of the user
Parameters:
firstName - First Name of the user
Parameters:
lastName - Last Name of the user
Parameters:
email - email of the user
Parameters:
blocked - Specify if the user must be blocked or not
Parameters:
description - User description
Parameters:
superUser - Specify if the user is super user.
Parameters:
clientIP - IP Address of whom is making the request
throws:
DataAccessException - Severe errors like SQL error, IO Error, etc
throws:
InvalidAttributesException - The new user attributes are not valid
throws:
NotEnoughPermissionException - The user cannot perform this operation
throws:
CannotAuditException - Error auditing transaction
throws:
DoesntExistsException - The user does not exist
throws:
XMLException - |
| validateOperative | | public void validateOperative(String user, String operative, String object) throws NotEnoughPermissionException(Code) | | Verify if the user can execute the operative over the obejct
Parameters:
user - User who is making the request
Parameters:
operative - Operative identifier
Parameters:
object - Object identifier
throws:
NotEnoughPermissionException - The user cannot execute the operation |
|
|