org.alfresco.rest.api.impl

Class PeopleImpl

java.lang.Object

org.alfresco.rest.api.impl.PeopleImpl

All Implemented Interfaces:

People

public class PeopleImpl
extends Object
implements People

Centralises access to people services and maps between representations.

Since:

publicapi1.0

Author:

steveglover

Field Summary

Fields

Modifier and Type	Field and Description
protected org.alfresco.service.cmr.security.AuthenticationService	authenticationService
protected org.alfresco.service.cmr.security.AuthorityService	authorityService
protected org.alfresco.service.cmr.repository.ContentService	contentService
protected org.alfresco.service.cmr.usage.ContentUsageService	contentUsageService
protected Nodes	nodes
protected org.alfresco.service.cmr.repository.NodeService	nodeService
protected org.alfresco.service.cmr.security.PersonService	personService
protected Renditions	renditions
protected org.alfresco.repo.security.authentication.ResetPasswordService	resetPasswordService
protected Sites	sites
protected org.alfresco.service.cmr.site.SiteService	siteService
protected org.alfresco.service.cmr.thumbnail.ThumbnailService	thumbnailService

Fields inherited from interface org.alfresco.rest.api.People

DEFAULT_USER, PARAM_FIRST_NAME, PARAM_ID, PARAM_INCLUDE_ASPECTNAMES, PARAM_INCLUDE_CAPABILITIES, PARAM_INCLUDE_PROPERTIES, PARAM_LAST_NAME

Constructor Summary

Constructors

Constructor and Description
PeopleImpl()

Method Summary

Modifier and Type	Method and Description
Person	create(Person person) Create a person.
void	deleteAvatarContent(String personId)
BinaryResource	downloadAvatarContent(String personId, Parameters parameters)
org.alfresco.service.cmr.repository.NodeRef	getAvatar(String personId)
CollectionWithPagingInfo<Person>	getPeople(Parameters parameters) Get people list
Person	getPerson(String personId) Get a full representation of a person.
Person	getPerson(String personId, List<String> include) Get a person, specifying optional includes as required.
boolean	hasAvatar(org.alfresco.service.cmr.repository.NodeRef personNodeRef)
protected void	processPersonProperties(String userName, Map<org.alfresco.service.namespace.QName,Serializable> nodeProps)
void	requestPasswordReset(String userId, String client) Request password reset (an email will be sent to the registered email of the given userId).
void	resetPassword(String personId, PasswordReset passwordReset) Performs password reset
void	setAuthenticationService(org.alfresco.service.cmr.security.AuthenticationService authenticationService)
void	setAuthorityService(org.alfresco.service.cmr.security.AuthorityService authorityService)
void	setContentService(org.alfresco.service.cmr.repository.ContentService contentService)
void	setContentUsageService(org.alfresco.service.cmr.usage.ContentUsageService contentUsageService)
void	setNodes(Nodes nodes)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPersonService(org.alfresco.service.cmr.security.PersonService personService)
void	setRenditions(Renditions renditions)
void	setResetPasswordService(org.alfresco.repo.security.authentication.ResetPasswordService resetPasswordService)
void	setSites(Sites sites)
void	setSiteService(org.alfresco.service.cmr.site.SiteService siteService)
void	setThumbnailService(org.alfresco.service.cmr.thumbnail.ThumbnailService thumbnailService)
Person	update(String personId, Person person) Update the given person's details.
Person	uploadAvatarContent(String personId, BasicContentInfo contentInfo, InputStream stream, Parameters parameters)
String	validatePerson(String personId) Validate, perform -me- substitution and canonicalize the person ID.
String	validatePerson(String requestedPersonId, boolean validateIsCurrentUser)

Methods inherited from class java.lang.Object

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

Field Detail

nodes

protected Nodes nodes

sites

protected Sites sites

siteService

protected org.alfresco.service.cmr.site.SiteService siteService

nodeService

protected org.alfresco.service.cmr.repository.NodeService nodeService

personService

protected org.alfresco.service.cmr.security.PersonService personService

authenticationService

protected org.alfresco.service.cmr.security.AuthenticationService authenticationService

authorityService

protected org.alfresco.service.cmr.security.AuthorityService authorityService

contentUsageService

protected org.alfresco.service.cmr.usage.ContentUsageService contentUsageService

contentService

protected org.alfresco.service.cmr.repository.ContentService contentService

thumbnailService

protected org.alfresco.service.cmr.thumbnail.ThumbnailService thumbnailService

resetPasswordService

protected org.alfresco.repo.security.authentication.ResetPasswordService resetPasswordService

renditions

protected Renditions renditions

Constructor Detail

PeopleImpl

public PeopleImpl()

Method Detail

setSites

public void setSites(Sites sites)

setSiteService

public void setSiteService(org.alfresco.service.cmr.site.SiteService siteService)

setNodes

public void setNodes(Nodes nodes)

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setPersonService

public void setPersonService(org.alfresco.service.cmr.security.PersonService personService)

setAuthenticationService

public void setAuthenticationService(org.alfresco.service.cmr.security.AuthenticationService authenticationService)

setAuthorityService

public void setAuthorityService(org.alfresco.service.cmr.security.AuthorityService authorityService)

setContentUsageService

public void setContentUsageService(org.alfresco.service.cmr.usage.ContentUsageService contentUsageService)

setContentService

public void setContentService(org.alfresco.service.cmr.repository.ContentService contentService)

setThumbnailService

public void setThumbnailService(org.alfresco.service.cmr.thumbnail.ThumbnailService thumbnailService)

setResetPasswordService

public void setResetPasswordService(org.alfresco.repo.security.authentication.ResetPasswordService resetPasswordService)

setRenditions

public void setRenditions(Renditions renditions)

validatePerson

public String validatePerson(String personId)

Validate, perform -me- substitution and canonicalize the person ID.

Specified by:

validatePerson in interface People

Parameters:

personId -

Returns:

The validated and processed ID.

validatePerson

public String validatePerson(String requestedPersonId,
                             boolean validateIsCurrentUser)

Specified by:

validatePerson in interface People

processPersonProperties

protected void processPersonProperties(String userName,
                                       Map<org.alfresco.service.namespace.QName,Serializable> nodeProps)

hasAvatar

public boolean hasAvatar(org.alfresco.service.cmr.repository.NodeRef personNodeRef)

getAvatar

public org.alfresco.service.cmr.repository.NodeRef getAvatar(String personId)

Specified by:

getAvatar in interface People

downloadAvatarContent

public BinaryResource downloadAvatarContent(String personId,
                                            Parameters parameters)

Specified by:

downloadAvatarContent in interface People

Returns:

uploadAvatarContent

public Person uploadAvatarContent(String personId,
                                  BasicContentInfo contentInfo,
                                  InputStream stream,
                                  Parameters parameters)

Specified by:

uploadAvatarContent in interface People

Returns:

deleteAvatarContent

public void deleteAvatarContent(String personId)

Specified by:

deleteAvatarContent in interface People

getPerson

public Person getPerson(String personId)

Get a full representation of a person.

Specified by:

getPerson in interface People

Throws:

org.alfresco.service.cmr.security.NoSuchPersonException - if personId does not exist

getPerson

public Person getPerson(String personId,
                        List<String> include)

Description copied from interface: People

Get a person, specifying optional includes as required.

Specified by:

getPerson in interface People

Returns:

getPeople

public CollectionWithPagingInfo<Person> getPeople(Parameters parameters)

Description copied from interface: People

Get people list

Specified by:

getPeople in interface People

Returns:

CollectionWithPagingInfo

create

public Person create(Person person)

Description copied from interface: People

Create a person.

Specified by:

create in interface People

Returns:

update

public Person update(String personId,
                     Person person)

Description copied from interface: People

Update the given person's details.

Specified by:

update in interface People

Parameters:

personId - The identifier of a person.

person - The person details.

Returns:

The updated person details.

requestPasswordReset

public void requestPasswordReset(String userId,
                                 String client)

Description copied from interface: People

Request password reset (an email will be sent to the registered email of the given userId). The API returns a 202 response for a valid, as well as the invalid (does not exist or disabled) userId

Specified by:

requestPasswordReset in interface People

Parameters:

userId - the user id of the person requesting the password reset

client - the client name which is registered to send emails

resetPassword

public void resetPassword(String personId,
                          PasswordReset passwordReset)

Description copied from interface: People

Performs password reset

Specified by:

resetPassword in interface People

passwordReset - the password reset details