|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
---|---|
boolean |
createMissingPeople()
Does this service create people on demand if they are missing. |
org.alfresco.service.cmr.repository.NodeRef |
createPerson(java.util.Map properties)
Create a new person with the given properties. |
org.alfresco.service.cmr.repository.NodeRef |
createPerson(java.util.Map properties,
java.util.Set 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(org.alfresco.service.cmr.repository.NodeRef personRef)
Delete the person identified by the given ref. |
void |
deletePerson(java.lang.String userName)
Delete the person identified by the given user name. |
java.util.Set |
getAllPeople()
Deprecated. see getPeople |
java.util.Set |
getMutableProperties()
Get the list of properties that are mutable. |
org.alfresco.query.PagingResults |
getPeople(java.util.List stringPropFilters,
boolean filterIgnoreCase,
java.util.List sortProps,
org.alfresco.query.PagingRequest pagingRequest)
Get paged list of people optionally filtered and/or sorted |
org.alfresco.service.cmr.repository.NodeRef |
getPeopleContainer()
Return the container that stores people. |
java.util.Set |
getPeopleFilteredByProperty(org.alfresco.service.namespace.QName propertyKey,
java.io.Serializable propertyValue)
Deprecated. see getPeople |
org.alfresco.service.cmr.repository.NodeRef |
getPerson(java.lang.String userName)
Get a person by userName. |
org.alfresco.service.cmr.repository.NodeRef |
getPerson(java.lang.String userName,
boolean autoCreate)
Retrieve the person NodeRef for a username key. |
java.lang.String |
getUserIdentifier(java.lang.String caseSensitiveUserName)
Given the case sensitive user name find the approriate identifier from the person service. |
boolean |
getUserNamesAreCaseSensitive()
Are user names case sensitive? |
boolean |
isMutable()
Can this service create, delete and update person information? |
void |
notifyPerson(java.lang.String userName,
java.lang.String password)
Notifies a user by email that their account has been created, and the details of it. |
boolean |
personExists(java.lang.String userName)
Check if a person exists. |
void |
setCreateMissingPeople(boolean createMissing)
Set if missing people should be created. |
void |
setPersonProperties(java.lang.String userName,
java.util.Map properties)
Set the properties on a person - some of these may be persisted in different locations. |
void |
setPersonProperties(java.lang.String userName,
java.util.Map properties,
boolean autoCreate)
Set the properties on a person - some of these may be persisted in different locations. |
Method Detail |
---|
@Auditable(parameters="userName") org.alfresco.service.cmr.repository.NodeRef getPerson(java.lang.String userName)
create missing people or not
.
userName
- -
the userName key to find the person
NoSuchPersonException
- if the user doesn't exist and could not be created
automaticallyPersonService.setCreateMissingPeople(boolean)
,
PersonService.createMissingPeople()
@Auditable(parameters={"userName", "autoCreate"}) org.alfresco.service.cmr.repository.NodeRef getPerson(java.lang.String userName, boolean autoCreate)
autoCreate
parameter and
configuration missing people will be created if not found, else a NoSuchPersonException exception will be thrown.
userName
- of the person NodeRef to retrieveautoCreate
- should we auto-create the person node and home folder if they don't exist? (and configuration allows
us to)
NoSuchPersonException
- if the person doesn't exist and can't be created@Auditable(parameters="userName") boolean personExists(java.lang.String userName)
userName
- the user name
@Auditable boolean createMissingPeople()
@Auditable(parameters="createMissing") void setCreateMissingPeople(boolean createMissing)
createMissing
- set to true to create peoplePersonService.getPerson(String)
@Auditable java.util.Set getMutableProperties()
@Auditable(parameters={"userName", "properties"}) void setPersonProperties(java.lang.String userName, java.util.Map properties)
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(java.lang.String userName, java.util.Map properties, boolean autoCreate)
userName
- - the user for which the properties should be set.properties
- - the map of properties to set (as the NodeService)autoCreate
- should we auto-create the home folder if it doesn't exist? (and configuration allows us to)@Auditable boolean isMutable()
@Auditable(parameters="properties") org.alfresco.service.cmr.repository.NodeRef createPerson(java.util.Map properties)
properties
-
@Auditable(parameters={"properties", "zones"}) org.alfresco.service.cmr.repository.NodeRef createPerson(java.util.Map properties, java.util.Set zones)
properties
- the propertieszones
- 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(java.lang.String userName, java.lang.String password)
PersonService.createPerson(Map)
or PersonService.createPerson(Map, Set)
where email notifications are required.
userName
- of the person to notifypassword
- of the person to notify
NoSuchPersonException
- if the person doesn't exist@Auditable(parameters="userName") void deletePerson(java.lang.String userName)
userName
- @Auditable(parameters="personRef") void deletePerson(org.alfresco.service.cmr.repository.NodeRef personRef)
personRef
- @Auditable java.util.Set getAllPeople()
@Auditable(parameters={"stringPropFilters", "filterIgnoreCase", "sortProps", "pagingRequest"}) org.alfresco.query.PagingResults getPeople(java.util.List stringPropFilters, boolean filterIgnoreCase, java.util.List sortProps, org.alfresco.query.PagingRequest pagingRequest)
filterProps
- 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 filteringsortProps
- sort property, eg. cm:username ascendingpagingRequest
- skip, max + optional query execution id@Auditable java.util.Set getPeopleFilteredByProperty(org.alfresco.service.namespace.QName propertyKey, java.io.Serializable propertyValue)
propertyKey
- property key of property to filter people bypropertyValue
- property value of property to filter people by
@Auditable org.alfresco.service.cmr.repository.NodeRef getPeopleContainer()
@Auditable boolean getUserNamesAreCaseSensitive()
@NotAuditable java.lang.String getUserIdentifier(java.lang.String caseSensitiveUserName)
caseSensitiveUserName
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |