PersonService (Alfresco 5.1.4.1 Public Java API)

org.alfresco.service.cmr.security

Interface PersonService

@org.alfresco.api.AlfrescoPublicApi
public interface PersonService

This service encapsulates the management of people and groups.

People and groups may be managed entirely in the repository or entirely in some other implementation such as LDAP or via NTLM. Some properties may in the repository and some in another store. Individual properties may or may not be mutable.

Nested Class Summary
static class	PersonService.PersonInfo Data pojo to carry common person information

Method Summary
int	countPeople() Counts the number of persons registered with the system.
boolean	createMissingPeople() Does this service create people on demand if they are missing.
NodeRef	createPerson(Map<QName,Serializable> properties) Create a new person with the given properties.
NodeRef	createPerson(Map<QName,Serializable> properties, Set<String> zones) Create a new person with the given properties, recording them against the given zone name (usually identifying an external user registry from which the details were obtained).
void	deletePerson(NodeRef personRef) Delete the person identified by the given ref.
void	deletePerson(NodeRef personRef, boolean deleteAuthentication) Delete the person identified by the given ref, and optionally delete the associated authentication, if one.
void	deletePerson(String userName) Delete the person identified by the given user name.
Set<NodeRef>	getAllPeople() Deprecated. see getPeople(List, boolean, List, PagingRequest)
Set<QName>	getMutableProperties() Get the list of properties that are mutable.
PagingResults<PersonService.PersonInfo>	getPeople(List<Pair<QName,String>> stringPropFilters, boolean filterIgnoreCase, List<Pair<QName,Boolean>> sortProps, PagingRequest pagingRequest) Deprecated. see getPeople(String pattern, List filterProps, List> sortProps, PagingRequest pagingRequest)
PagingResults<PersonService.PersonInfo>	getPeople(String pattern, List<QName> filterProps, List<Pair<QName,Boolean>> sortProps, PagingRequest pagingRequest) Get paged list of people optionally filtered and/or sorted Note: the pattern is applied to filter props (0 to 3) as startsWithIgnoreCase, which are OR'ed together, for example: cm:userName or cm:firstName or cm:lastName
PagingResults<PersonService.PersonInfo>	getPeople(String pattern, List<QName> filterStringProps, Set<QName> inclusiveAspects, Set<QName> exclusiveAspects, boolean includeAdministraotrs, List<Pair<QName,Boolean>> sortProps, PagingRequest pagingRequest) Get paged list of people optionally filtered and/or sorted
NodeRef	getPeopleContainer() Return the container that stores people.
Set<NodeRef>	getPeopleFilteredByProperty(QName propertyKey, Serializable propertyValue, int count) Get people filtered by the given property name/value pair.
PersonService.PersonInfo	getPerson(NodeRef personRef) Retrieve the person info for an existing person NodeRef
NodeRef	getPerson(String userName) Get a person by userName.
NodeRef	getPerson(String userName, boolean autoCreateHomeFolderAndMissingPersonIfAllowed) Retrieve the person NodeRef for a username, optionally creating the home folder if it does not exist and optionally creating the person if they don't exist AND the PersonService is configured to allow the creation of missing persons setCreateMissingPeople(boolean).
NodeRef	getPersonOrNull(String userName) Get a person by userName.
String	getUserIdentifier(String caseSensitiveUserName) Given the case sensitive user name find the approriate identifier from the person service.
boolean	getUserNamesAreCaseSensitive() Are user names case sensitive?
boolean	isEnabled(String userName) Is the specified user, enabled
boolean	isMutable() Can this service create, delete and update person information?
void	notifyPerson(String userName, String password) Notifies a user by email that their account has been created, and the details of it.
boolean	personExists(String userName) Check if a person exists.
void	setCreateMissingPeople(boolean createMissing) Set if missing people should be created.
void	setPersonProperties(String userName, Map<QName,Serializable> properties) Set the properties on a person - some of these may be persisted in different locations - the home folder is created if it doesn't exist
void	setPersonProperties(String userName, Map<QName,Serializable> properties, boolean autoCreateHomeFolder) Set the properties on a person - some of these may be persisted in different locations.

@Auditable(parameters="userName")
NodeRef getPerson(String userName)

Get a person by userName. The person is store in the repository. The person may be created as a side effect of this call, depending on the setting of to create missing people or not. The home folder will also be created as a side effect if it does not exist.

userName - - the userName key to find the person

Returns the person node, either existing or new

NoSuchPersonException - if the user doesn't exist and could not be created automatically

@Auditable(parameters="userName")
NodeRef getPersonOrNull(String userName)

Get a person by userName. The person is store in the repository. No missing person objects will be created as a side effect of this call. If the person is missing from the repository null will be returned.

userName - - the userName key to find the person

Returns the existing person node, or null if does not exist.

@Auditable(parameters={
  "userName",
  "autoCreate"
})
NodeRef getPerson(String userName,
                  boolean autoCreateHomeFolderAndMissingPersonIfAllowed)

Retrieve the person NodeRef for a username, optionally creating the home folder if it does not exist and optionally creating the person if they don't exist AND the PersonService is configured to allow the creation of missing persons setCreateMissingPeople(boolean). If not allowed to create missing persons and the person does not exist a NoSuchPersonException exception will be thrown.

userName - of the person NodeRef to retrieve

autoCreateHomeFolderAndMissingPersonIfAllowed - If the person exits: should we create the home folder if it does not exist? If the person exists AND the creation of missing persons is allowed should we create both the person and home folder.

NodeRef of the person as specified by the username

NoSuchPersonException - if the person doesn't exist and can't be created

Retrieve the person info for an existing person NodeRef

PersonInfo (username, firstname, lastname)

NoSuchPersonException - if the person doesn't exist

@Auditable(parameters="userName")
boolean personExists(String userName)

Check if a person exists.

userName - the user name

Returns true if the user exists, otherwise false

@Auditable
boolean createMissingPeople()

Does this service create people on demand if they are missing. If this is true, a call to getPerson() will create a person if they are missing.

true if people are created on demand and false otherwise.

setCreateMissingPeople

@Auditable(parameters="createMissing")
void setCreateMissingPeople(boolean createMissing)

Set if missing people should be created.

createMissing - set to true to create people

getMutableProperties

@Auditable
Set<QName> getMutableProperties()

Get the list of properties that are mutable. Some service may only allow a limited list of properties to be changed. This may be those persisted in the repository or those that can be changed in some other implementation such as LDAP.

A set of QNames that identify properties that can be changed

@Auditable(parameters={
  "userName",
  "properties"
})
void setPersonProperties(String userName,
                         Map<QName,Serializable> properties)

Set the properties on a person - some of these may be persisted in different locations - the home folder is created if it doesn't exist

userName - - the user for which the properties should be set.

properties - - the map of properties to set (as the NodeService)

@Auditable(parameters={
  "userName",
  "properties",
  "autoCreate"
})
void setPersonProperties(String userName,
                         Map<QName,Serializable> properties,
                         boolean autoCreateHomeFolder)

Set the properties on a person - some of these may be persisted in different locations.

userName - - the user for which the properties should be set.

properties - - the map of properties to set (as the NodeService)

autoCreateHomeFolder - should we auto-create the home folder if it doesn't exist.

@Auditable
boolean isMutable()

Can this service create, delete and update person information?

true if this service allows mutation to people.

@Auditable(parameters="properties")
NodeRef createPerson(Map<QName,Serializable> properties)

Create a new person with the given properties. The userName is one of the properties. Users with duplicate userNames are not allowed.

@Auditable(parameters={
  "properties",
  "zones"
})
NodeRef createPerson(Map<QName,Serializable> properties,
                     Set<String> zones)

Create a new person with the given properties, recording them against the given zone name (usually identifying an external user registry from which the details were obtained). The userName is one of the properties. Users with duplicate userNames are not allowed.

properties - the properties

zones - a set if zones including the identifier for the external user registry owning the person information, or null or an empty set

@Auditable(parameters="userName")
void notifyPerson(String userName,
String password)

Notifies a user by email that their account has been created, and the details of it. Normally called after createPerson(Map) or createPerson(Map, Set) where email notifications are required.

userName - of the person to notify

password - of the person to notify

NoSuchPersonException - if the person doesn't exist

@Auditable(parameters="userName")
void deletePerson(String userName)

Delete the person identified by the given user name.

@Auditable(parameters="personRef")
void deletePerson(NodeRef personRef)

Delete the person identified by the given ref.

@Auditable(parameters={
  "personRef",
  "deleteAuthentication"
})
void deletePerson(NodeRef personRef,
                  boolean deleteAuthentication)

Delete the person identified by the given ref, and optionally delete the associated authentication, if one.

deleteAuthentication - boolean

@Auditable
Set<NodeRef> getAllPeople()

Get all the people we know about.

a set of people in no specific order.

@Auditable(parameters={
  "pattern",
  "filterProps",
  "sortProps",
  "pagingRequest"
})
PagingResults<PersonService.PersonInfo> getPeople(String pattern,
                                                  List<QName> filterProps,
                                                  List<Pair<QName,Boolean>> sortProps,
                                                  PagingRequest pagingRequest)

Get paged list of people optionally filtered and/or sorted Note: the pattern is applied to filter props (0 to 3) as startsWithIgnoreCase, which are OR'ed together, for example: cm:userName or cm:firstName or cm:lastName

pattern - pattern to apply to filter props - "startsWith" and "ignoreCase"

filterProps - list of filter properties (these are OR'ed)

sortProps - sort property, eg. cm:username ascending

pagingRequest - skip, max + optional query execution id

PagingResults

author janv

@Auditable(parameters={
  "stringPropFilters",
  "filterIgnoreCase",
  "sortProps",
  "pagingRequest"
})
PagingResults<PersonService.PersonInfo> getPeople(List<Pair<QName,String>> stringPropFilters,
                                                  boolean filterIgnoreCase,
                                                  List<Pair<QName,Boolean>> sortProps,
                                                  PagingRequest pagingRequest)

Deprecated. see getPeople(String pattern, List filterProps, List> sortProps, PagingRequest pagingRequest)

Get paged list of people optionally filtered and/or sorted

stringPropFilters - list of filter properties (with "startsWith" values), eg. cm:username "al" might match "alex", "alice", ...

filterIgnoreCase - true to ignore case when filtering, false to be case-sensitive when filtering

sortProps - sort property, eg. cm:username ascending

pagingRequest - skip, max + optional query execution id

author janv

@Auditable(parameters={
  "stringPropFilters",
  "filterIgnoreCase",
  "inclusiveAspect",
  "exclusiveAspects",
  "sortProps",
  "pagingRequest"
})
PagingResults<PersonService.PersonInfo> getPeople(String pattern,
                                                  List<QName> filterStringProps,
                                                  Set<QName> inclusiveAspects,
                                                  Set<QName> exclusiveAspects,
                                                  boolean includeAdministraotrs,
                                                  List<Pair<QName,Boolean>> sortProps,
                                                  PagingRequest pagingRequest)

Get paged list of people optionally filtered and/or sorted

filterStringProps - list of filter properties (with "startsWith" values), eg. cm:username "al" might match "alex", "alice", ...

inclusiveAspects - if set, filter out any people that don't have one of these aspects

exclusiveAspects - if set, filter out any people that do have one of these aspects

includeAdministraotrs - true to include administrators in the results.

sortProps - sort property, eg. cm:username ascending

pagingRequest - skip, max + optional query execution id

getPeopleFilteredByProperty

@Auditable
Set<NodeRef> getPeopleFilteredByProperty(QName propertyKey,
Serializable propertyValue,
int count)

Get people filtered by the given property name/value pair.

In order to get paging, use getPeople(List, boolean, List, PagingRequest)

propertyKey - property key of property to filter people by

propertyValue - property value of property to filter people by

count - the number of results to retrieve, up to a maximum of 1000

people filtered by the given property name/value pair

@Auditable
NodeRef getPeopleContainer()

Return the container that stores people.

getUserNamesAreCaseSensitive

@Auditable
boolean getUserNamesAreCaseSensitive()

Are user names case sensitive?

@NotAuditable
String getUserIdentifier(String caseSensitiveUserName)

Given the case sensitive user name find the approriate identifier from the person service. If the system is case sensitive it will return the same string. If case insentive it will return the common object. If the user does not exist it will return null;

caseSensitiveUserName - String

@NotAuditable
int countPeople()

Counts the number of persons registered with the system.

@NotAuditable
boolean isEnabled(String userName)

Is the specified user, enabled

NoSuchPersonException - if the user doesn't exist

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.