com.whitestein.lsps.pm

Class PersonServiceBase

java.lang.Object

com.whitestein.lsps.common.SecureAndLoggingService

com.whitestein.lsps.pm.PersonServiceBase

All Implemented Interfaces:

PersonService

Direct Known Subclasses:

PersonManagementServiceBean, PersonServiceBean

@PermitAll
public abstract class PersonServiceBase
extends com.whitestein.lsps.common.SecureAndLoggingService
implements PersonService

Common implementation of PersonServiceBean nad PersonManagementServiceBean

Author:

bhl

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ARGUMENT_PERSON_ID
protected static String	ARGUMENT_SETTING_NAME

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

PRINCIPAL_KEY

Constructor Summary

Constructors

Constructor and Description
PersonServiceBase()

Method Summary

Modifier and Type	Method and Description
boolean	checkActivePersonWithLoginExists(String loginName) Answer whether active person for given loginName exists.
protected Person	checkPersonWithIdExists(String personId)
void	deleteSetting(String personId, String settingName) Deletes the given personal setting.
PersonList	findPersons(PersonCriteria criteria) Returns a PersonList with Persons defined by the given personCriteria argument.
Person	getPerson(String personId) Returns a Person instance if such person (identified by id) exists in the application.
Person	getPersonByLogin(String loginName) Returns a Person instance if such person (identified by login) exists in the application.
protected abstract PersonDao	getPersonDao() Returns person service dao.
PersonPicture	getPersonPicture(String personId) Returns picture for person.
protected Person	getPersonWithLogin(String name)
ByteData	getSetting(String personId, String settingName) Returns the personal setting with the given name.
boolean	hasPersonAnyRight(String loginName, List<String> rights) Answer whether person is active and has any of the given rights
void	setPersonPicture(String personId, PersonPicture picture) Sets picture for person.
void	setSetting(String personId, String settingName, ByteData settingContent) Sets the given personal setting.

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

Field Detail

ARGUMENT_PERSON_ID

protected static final String ARGUMENT_PERSON_ID

See Also:

Constant Field Values

ARGUMENT_SETTING_NAME

protected static final String ARGUMENT_SETTING_NAME

See Also:

Constant Field Values

Constructor Detail

PersonServiceBase

public PersonServiceBase()

Method Detail

getPersonDao

protected abstract PersonDao getPersonDao()

Returns person service dao.

Returns:

person service dao

getPerson

@RightsAllowed(value="Person:Read")
public Person getPerson(String personId)

Description copied from interface: PersonService

Returns a Person instance if such person (identified by id) exists in the application.

Specified by:

getPerson in interface PersonService

Parameters:

personId - id of the person to find

Returns:

Person instance if such person exists, otherwise null

getPersonByLogin

@RightsAllowed(value="Person:Read")
public Person getPersonByLogin(String loginName)

Description copied from interface: PersonService

Returns a Person instance if such person (identified by login) exists in the application.

Specified by:

getPersonByLogin in interface PersonService

Parameters:

loginName - login of the person to find

Returns:

Person instance if such person exists in the application, otherwise null

checkActivePersonWithLoginExists

public boolean checkActivePersonWithLoginExists(String loginName)

Description copied from interface: PersonService

Answer whether active person for given loginName exists. Method is unprotected to be used by the SSO.

Specified by:

checkActivePersonWithLoginExists in interface PersonService

Parameters:

loginName - loginName of the person to find

Returns:

true when person exists in the LSPS database, false otherwise

findPersons

@RightsAllowed(value="Person:Read")
public PersonList findPersons(PersonCriteria criteria)

Description copied from interface: PersonService

Returns a PersonList with Persons defined by the given personCriteria argument.

Specified by:

findPersons in interface PersonService

Parameters:

criteria - PersonCriteria instance that specifies a paging and filtering criteria for querying persons

Returns:

result of the query defined by the given personCriteria argument.

getSetting

@RightsAllowed(value="Person:Read")
public ByteData getSetting(String personId,
                                                               String settingName)
                                                        throws PersonNotFoundException

Description copied from interface: PersonService

Returns the personal setting with the given name. Needed for monitoring.

Specified by:

getSetting in interface PersonService

Parameters:

personId - id name of the person for which the setting should be returned

settingName - name of the setting

Returns:

setting content or null

Throws:

PersonNotFoundException - if no person is found for the personId

setSetting

@RightsAllowed(value="Person:Read")
public void setSetting(String personId,
                                                           String settingName,
                                                           ByteData settingContent)
                                                    throws PersonNotFoundException

Description copied from interface: PersonService

Sets the given personal setting. If such setting was already present, its value is updated. Needed for monitoring.

Specified by:

setSetting in interface PersonService

Parameters:

personId - id of the person for which the setting should be set

settingName - name of the setting

settingContent - setting content

Throws:

PersonNotFoundException - if no person is found for the personId

deleteSetting

@RightsAllowed(value="Person:Read")
public void deleteSetting(String personId,
                                                              String settingName)
                                                       throws PersonNotFoundException

Description copied from interface: PersonService

Deletes the given personal setting. Needed for monitoring.

Specified by:

deleteSetting in interface PersonService

Parameters:

personId - id of the person for which the setting should be deleted

settingName - name of the setting

Throws:

PersonNotFoundException - if no person is found for the personId

hasPersonAnyRight

@RightsAllowed(value="Person:Read")
public boolean hasPersonAnyRight(String loginName,
                                                                     List<String> rights)

Description copied from interface: PersonService

Answer whether person is active and has any of the given rights

Specified by:

hasPersonAnyRight in interface PersonService

Parameters:

loginName - login of the person to find

rights - the rights person is required to have (at least one of them) or null if none is required

Returns:

true when person with given login is active and has any of the requested rights

getPersonPicture

public PersonPicture getPersonPicture(String personId)
                               throws PersonNotFoundException,
                                      PersonPictureException

Description copied from interface: PersonService

Returns picture for person.

Specified by:

getPersonPicture in interface PersonService

Returns:

picture for person

Throws:

PersonNotFoundException

PersonPictureException

setPersonPicture

public void setPersonPicture(String personId,
                             PersonPicture picture)
                      throws PersonNotFoundException,
                             PersonPictureException

Description copied from interface: PersonService

Sets picture for person.

Specified by:

setPersonPicture in interface PersonService

Throws:

PersonNotFoundException

PersonPictureException

checkPersonWithIdExists

protected Person checkPersonWithIdExists(String personId)
                                  throws PersonNotFoundException

Parameters:

personId -

Returns:

corresponding person

Throws:

PersonNotFoundException

getPersonWithLogin

protected Person getPersonWithLogin(String name)
                             throws PersonNotFoundException

Parameters:

name -

Returns:

corresponding person

Throws:

PersonNotFoundException