com.whitestein.lsps.os

Interface PersonManagementService

All Superinterfaces:

PersonService

All Known Subinterfaces:

PersonManagementServiceLocal, PersonManagementServiceRemote

All Known Implementing Classes:

PersonManagementServiceBean

public interface PersonManagementService
extends PersonService

Provides methods for person management (creating, updating, removing persons), person-role mapping and querying, and role querying. Full role management (creating, updating, removing roles) is not supported as this is managed (almost) entirely by process models.

Since:

1.1

Author:

vgr

Method Summary

Modifier and Type	Method and Description
Person	addPerson(Person person) Adds new person into the application.
Person	addPersonWithData(PersonData personData) Adds new person into the application.
Person	assignSecurityRolesToPerson(String personId, List<String> securityRoleNames) Assigns given list of security roles (specified by their names) to the user identified by given personId argument.
RoleUnitNameList	findRoles() Returns a collection of all roles with all different combinations of parameters assigned to persons.
Collection<PersonAttribute>	getEditableAttributes() Returns editable person attributes.
Collection<SecurityRole>	getSecurityRoles(String personId) Returns a collection of all the security roles currently assigned to the user identified by given personId or an empty collection if the user has no security roles assigned to them.
boolean	isReadOnly() Deprecated. As of release 3.2, replaced by getEditableAttributes(). This method has been deprecated as some implementations may allow editing of some of the person attributes and therefore finer grained control over the attribute editability is required.
Person	updatePerson(Person person) Updates the person.
Person	updatePersonLogin(String personId, String newLogin) Updates current login of the user identified by given personId with the content of newLogin argument.
Person	updatePersonPassword(String personId, String newPassword) Updates current password of the user identified by given personId with the content of newPassword argument.
Person	updatePersonWithData(PersonData personData) Updates the person.
void	validatePassword(String password) Validates the given password candidate to the actual password policy.

Methods inherited from interface com.whitestein.lsps.os.PersonService

checkActivePersonWithLoginExists, deleteSetting, findPersons, getPerson, getPersonByLogin, getPersonPicture, getSetting, hasPersonAnyRight, setPersonPicture, setSetting

Method Detail

addPerson

Person addPerson(Person person)
          throws PersonAlreadyExistsException,
                 PersonNotFoundException,
                 RoleNotFoundException,
                 PersonValidationException

Adds new person into the application.

Parameters:

person - person to be added

Returns:

added person

Throws:

NullPointerException - if the person is null

PersonAlreadyExistsException - if the person already exists in the application

PersonNotFoundException - if the person contains substitutes that do not exist

RoleNotFoundException - if the person contains roles that do not exist

PersonValidationException - if the person contains invalid data

updatePersonLogin

Person updatePersonLogin(String personId,
                         String newLogin)
                  throws PersonNotFoundException

Updates current login of the user identified by given personId with the content of newLogin argument.

Note: The result of this method call has an effect only if the "LSPS login modules" are used for user authentication. In other cases (different JAAS-compliant LoginModule used), the calling this method has no effect for JAAS authentication process.

Parameters:

personId - The id of the user. Cannot be blank.

newLogin - The new login to be set for the user identified by given personId. Cannot be blank.

Returns:

updated person

Throws:

NullPointerException - if at least one of the arguments is null.

IllegalArgumentException - if at least one of the the arguments contains just whitespace characters.

PersonNotFoundException - if the user identified by their personId does not exist in the application.

updatePersonPassword

Person updatePersonPassword(String personId,
                            String newPassword)
                     throws PersonNotFoundException,
                            InvalidPasswordException

Updates current password of the user identified by given personId with the content of newPassword argument.

Note: The result of this method call has an effect only if the "LSPS login modules" are used for user authentication. In other cases (different JAAS-compliant LoginModule used), the calling this method has no effect for JAAS authentication process.

Parameters:

personId - The id of the user. Cannot be blank.

newPassword - The new password to be set for the user identified by given personId. Cannot be blank.

Returns:

updated person

Throws:

NullPointerException - if at least one of the arguments is null.

IllegalArgumentException - if at least one of the the arguments contains just whitespace characters.

PersonNotFoundException - if the user identified by their personId does not exist in the application.

InvalidPasswordException - if the password value does not meet the password value constraints

validatePassword

void validatePassword(String password)
               throws InvalidPasswordException

Validates the given password candidate to the actual password policy.

Parameters:

password - the password candidate to be validated

Throws:

InvalidPasswordException - if the password candidate does not conform to the current password policy

updatePerson

Person updatePerson(Person person)
             throws PersonNotFoundException,
                    PersonStaleException,
                    RoleNotFoundException,
                    PersonValidationException

Updates the person. Substitutions are updated only using Person.getDirectSubstitutes() attribute. No persons in substitutions are updated.

Parameters:

person - person to be updated

Returns:

updated person

Throws:

NullPointerException - if the person is null

PersonNotFoundException - if the person contains substitutes that do not exist

PersonStaleException - if the person object is stale (this applies only if the version is not null)

RoleNotFoundException - if the person contains roles that do not exist

PersonValidationException - if the person contains invalid data

findRoles

RoleUnitNameList findRoles()

Returns a collection of all roles with all different combinations of parameters assigned to persons.

Returns:

a collection of all roles with all different combinations of parameters assigned to persons

assignSecurityRolesToPerson

Person assignSecurityRolesToPerson(String personId,
                                   List<String> securityRoleNames)
                            throws PersonNotFoundException,
                                   SecurityRoleNotFoundException

Assigns given list of security roles (specified by their names) to the user identified by given personId argument. All the security roles currently assigned to the user will be replaced by new collection of security roles (given as the securityRoleNames argument).

Parameters:

personId - The id of the user. Cannot be blank.

securityRoleNames - The list of names of security roles to assign to given user. Cannot be null.

Returns:

updated person

Throws:

NullPointerException - if at least one of the arguments is null.

IllegalArgumentException - if the personId argument contains just whitespace characters.

PersonNotFoundException - if the user with personId is not found

SecurityRoleNotFoundException - if any of the securityRoleNames is not found

getSecurityRoles

Collection<SecurityRole> getSecurityRoles(String personId)
                                   throws PersonNotFoundException

Returns a collection of all the security roles currently assigned to the user identified by given personId or an empty collection if the user has no security roles assigned to them.

Parameters:

personId - The id name of the user.

Returns:

A collection of all the security roles currently assigned to the user identified by given personId.

Throws:

NullPointerException - if at the personId argument is null.

PersonNotFoundException - if the user with personId is not found in application

isReadOnly

@Deprecated
boolean isReadOnly()

Deprecated. As of release 3.2, replaced by getEditableAttributes(). This method has been deprecated as some implementations may allow editing of some of the person attributes and therefore finer grained control over the attribute editability is required.

Some implementations might not have write access to the system containing user information. In such cases, this method should return true, so that the UI can disable editing of data.

Returns:

true if it's not possible to modify user related data, false otherwise

getEditableAttributes

Collection<PersonAttribute> getEditableAttributes()

Returns editable person attributes. Some implementations might not allow to manage all person attributes but only a subset of all person attributes.

Returns:

a collection of editable person attributes.

addPersonWithData

Person addPersonWithData(PersonData personData)
                  throws PersonAlreadyExistsException,
                         PersonNotFoundException,
                         RoleNotFoundException,
                         InvalidPasswordException,
                         SecurityRoleNotFoundException,
                         PersonValidationException

Adds new person into the application. If the provided password in the person data is not null then the password is set. If the provided security roles in the person data are not null then security roles are set.

Parameters:

personData - data representing a person to be added

Returns:

added person

Throws:

NullPointerException - if the person is null

PersonAlreadyExistsException - if the person already exists in the application

PersonNotFoundException - if the person contains substitutes that do not exist

RoleNotFoundException - if the person contains roles that do not exist

InvalidPasswordException - if the password value does not meet the password value constraints

SecurityRoleNotFoundException - if any of the security role names is not found

PersonValidationException - if the personData contains invalid data

updatePersonWithData

Person updatePersonWithData(PersonData personData)
                     throws PersonNotFoundException,
                            PersonStaleException,
                            RoleNotFoundException,
                            InvalidPasswordException,
                            SecurityRoleNotFoundException,
                            PersonValidationException

Updates the person. Substitutions are updated only using Person.getDirectSubstitutes() attribute. No persons in substitutions are updated. If a non-null password value is provided then the person's password is updated. If security role names are provided then the person's old security roles are replaced by the new ones.

Parameters:

personData - a data representing a person to be updated

Returns:

updated person

Throws:

NullPointerException - if the person in the personData is null

PersonNotFoundException - if the person contains substitutes that do not exist

PersonStaleException - if the person object is stale (this applies only if the version is not null)

RoleNotFoundException - if the person contains roles that do not exist

InvalidPasswordException - if the password value does not meet the password value constraints

SecurityRoleNotFoundException - if any of the security role names is not found

PersonValidationException - if the personData contains invalid data