com.whitestein.lsps.pm

Class PersonManagementServiceBean

java.lang.Object

com.whitestein.lsps.common.SecureAndLoggingService

com.whitestein.lsps.pm.PersonServiceBase

com.whitestein.lsps.pm.PersonManagementServiceBean

All Implemented Interfaces:

PersonManagementServiceLocal, PersonManagementServiceRemote, PersonManagementService, PersonService

@PermitAll
public class PersonManagementServiceBean
extends PersonServiceBase
implements PersonManagementServiceLocal, PersonManagementServiceRemote

The implementation of PersonManagementService using local database..

Since:

1.1

Author:

vgr

Field Summary

Fields inherited from class com.whitestein.lsps.pm.PersonServiceBase

ARGUMENT_PERSON_ID, ARGUMENT_SETTING_NAME

Fields inherited from class com.whitestein.lsps.common.SecureAndLoggingService

PRINCIPAL_KEY

Constructor Summary

Constructors

Constructor and Description
PersonManagementServiceBean() Creates new instance.
PersonManagementServiceBean(RoleNameDao roleNameDao, RoleDao roleDao, PersonDao personDao, SecurityRoleDao securityRoleDao, SecurityManagerServiceLocal securityManager, ComponentServiceLocal componentService) Creates new instance.

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.
protected PersonDao	getPersonDao() Returns person service dao.
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() Some implementations might not have write access to the system containing user information.
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 class com.whitestein.lsps.pm.PersonServiceBase

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

Methods inherited from class com.whitestein.lsps.common.SecureAndLoggingService

getCurrentTransactionData, getOriginalPrincipal, getSecurityManagerService

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

PersonManagementServiceBean

public PersonManagementServiceBean()

Creates new instance.

PersonManagementServiceBean

public PersonManagementServiceBean(RoleNameDao roleNameDao,
                                   RoleDao roleDao,
                                   PersonDao personDao,
                                   SecurityRoleDao securityRoleDao,
                                   SecurityManagerServiceLocal securityManager,
                                   ComponentServiceLocal componentService)

Creates new instance.

Parameters:

roleNameDao - the role name dao

roleDao - the role dao

personDao - the person dao

securityRoleDao -

securityManager - the security manager

componentService - the component service

Throws:

NullPointerException - if any of the parameters is null

Method Detail

getPersonDao

protected PersonDao getPersonDao()

Description copied from class: PersonServiceBase

Returns person service dao.

Specified by:

getPersonDao in class PersonServiceBase

Returns:

person service dao

addPerson

@RightsAllowed(value="Person:Manage")
public Person addPerson(Person person)
                                                       throws PersonAlreadyExistsException,
                                                              PersonNotFoundException,
                                                              RoleNotFoundException

Description copied from interface: PersonManagementService

Adds new person into the application.

Specified by:

addPerson in interface PersonManagementService

Parameters:

person - person to be added

Returns:

added person

Throws:

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

updatePersonLogin

@RightsAllowed(value="Person:Manage")
public Person updatePersonLogin(String personId,
                                                                      String newLogin)
                                                               throws PersonNotFoundException

Description copied from interface: PersonManagementService

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.

Specified by:

updatePersonLogin in interface PersonManagementService

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:

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

updatePersonPassword

@PermitAll
 @RightsAllowed(value={"Person:Manage","Person:Change_Own_Password"})
public Person updatePersonPassword(String personId,
                                                                                                                    String newPassword)
                                                                                                             throws PersonNotFoundException,
                                                                                                                    InvalidPasswordException

Description copied from interface: PersonManagementService

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.

Specified by:

updatePersonPassword in interface PersonManagementService

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:

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

@PermitAll
 @RightsAllowed(value={"Person:Manage","Person:Change_Own_Password"})
public void validatePassword(String password)
                                                                                                       throws InvalidPasswordException

Description copied from interface: PersonManagementService

Validates the given password candidate to the actual password policy.

Specified by:

validatePassword in interface PersonManagementService

Parameters:

password - the password candidate to be validated

Throws:

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

updatePerson

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

Description copied from interface: PersonManagementService

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

Specified by:

updatePerson in interface PersonManagementService

Parameters:

person - person to be updated

Returns:

updated person

Throws:

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

findRoles

@RightsAllowed(value="Person:Read")
public RoleUnitNameList findRoles()

Description copied from interface: PersonManagementService

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

Specified by:

findRoles in interface PersonManagementService

Returns:

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

assignSecurityRolesToPerson

@RightsAllowed(value="Person:Manage")
public Person assignSecurityRolesToPerson(String personId,
                                                                                List<String> securityRoleNames)
                                                                         throws PersonNotFoundException,
                                                                                SecurityRoleNotFoundException

Description copied from interface: PersonManagementService

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).

Specified by:

assignSecurityRolesToPerson in interface PersonManagementService

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:

PersonNotFoundException - if the user with personId is not found

SecurityRoleNotFoundException - if any of the securityRoleNames is not found

getSecurityRoles

@RightsAllowed(value="Person:Read")
public Collection<SecurityRole> getSecurityRoles(String personId)
                                                                              throws PersonNotFoundException

Description copied from interface: PersonManagementService

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.

Specified by:

getSecurityRoles in interface PersonManagementService

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:

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

isReadOnly

public boolean isReadOnly()

Description copied from interface: PersonManagementService

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.

Specified by:

isReadOnly in interface PersonManagementService

Returns:

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

getEditableAttributes

public Collection<PersonAttribute> getEditableAttributes()

Description copied from interface: PersonManagementService

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

Specified by:

getEditableAttributes in interface PersonManagementService

Returns:

a collection of editable person attributes.

addPersonWithData

@RightsAllowed(value={"Person:Manage","Person:Change_Own_Password"})
public Person addPersonWithData(PersonData personData)
                                                                                              throws PersonAlreadyExistsException,
                                                                                                     PersonNotFoundException,
                                                                                                     RoleNotFoundException,
                                                                                                     InvalidPasswordException,
                                                                                                     SecurityRoleNotFoundException

Description copied from interface: PersonManagementService

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.

Specified by:

addPersonWithData in interface PersonManagementService

Parameters:

personData - data representing a person to be added

Returns:

added person

Throws:

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

updatePersonWithData

@RightsAllowed(value={"Person:Manage","Person:Change_Own_Password"})
public Person updatePersonWithData(PersonData personData)
                                                                                                 throws PersonNotFoundException,
                                                                                                        PersonStaleException,
                                                                                                        RoleNotFoundException,
                                                                                                        InvalidPasswordException,
                                                                                                        SecurityRoleNotFoundException

Description copied from interface: PersonManagementService

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.

Specified by:

updatePersonWithData in interface PersonManagementService

Parameters:

personData - a data representing a person to be updated

Returns:

updated person

Throws:

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