Package org.alfresco.rest.api.people

Class PeopleEntityResource

java.lang.Object

org.alfresco.rest.api.people.PeopleEntityResource

All Implemented Interfaces:

BinaryResourceAction.Delete, BinaryResourceAction.Read, BinaryResourceAction.Update<Person>, EntityResourceAction.Create<Person>, EntityResourceAction.Read<Person>, EntityResourceAction.ReadById<Person>, EntityResourceAction.Update<Person>, ResourceAction, org.springframework.beans.factory.InitializingBean

@EntityResource(name="people",
                title="People")
public class PeopleEntityResource
extends Object
implements EntityResourceAction.ReadById<Person>, EntityResourceAction.Create<Person>, EntityResourceAction.Update<Person>, EntityResourceAction.Read<Person>, BinaryResourceAction.Read, BinaryResourceAction.Update<Person>, BinaryResourceAction.Delete, org.springframework.beans.factory.InitializingBean

An implementation of an Entity Resource for a Person

Author:

sglover, Gethin James

Constructor Summary

Constructors

Constructor	Description
PeopleEntityResource()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
List<Person>	create(List<Person> persons, Parameters parameters)
void	deauthorizeUser(String personId, Void body, Parameters parameters, WithResponse withResponse)	De-authorize user Not currently supported in community edition.
void	deleteProperty(String personId, Parameters parameters)	Delete avatar image content
AuthCode	getReauthorizationCode(String personId, Void body, Parameters parameters, WithResponse withResponse)	Get the authorization code.
CollectionWithPagingInfo<Person>	readAll(Parameters params)	Reads all the entries from the collection.
Person	readById(String personId, Parameters parameters)	Get a person by userName.
BinaryResource	readProperty(String personId, Parameters parameters)	Download avatar image content
void	reauthorizeUser(String personId, AuthKey authKey, Parameters parameters, WithResponse withResponse)	Reauthorize user.
void	requestPasswordReset(String personId, Client client, Parameters parameters, WithResponse withResponse)	Deprecated.
void	resetPassword(String personId, PasswordReset passwordReset, Parameters parameters, WithResponse withResponse)	Deprecated.
void	setPeople(People people)
Person	update(String personId, Person person, Parameters parameters)
Person	updateProperty(String personId, BasicContentInfo contentInfo, InputStream stream, Parameters parameters)	Upload avatar image content

Methods inherited from class java.lang.Object

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

Constructor Details

PeopleEntityResource

public PeopleEntityResource()

Method Details

setPeople

public void setPeople(People people)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

readById

public Person readById(String personId,
 Parameters parameters)

Get a person by userName.

Specified by:

readById in interface EntityResourceAction.ReadById<Person>

See Also:

• EntityResourceAction.ReadById.readById(String, org.alfresco.rest.framework.resource.parameters.Parameters)

create

public List<Person> create(List<Person> persons,
 Parameters parameters)

Specified by:

create in interface EntityResourceAction.Create<Person>

update

public Person update(String personId,
 Person person,
 Parameters parameters)

Specified by:

update in interface EntityResourceAction.Update<Person>

readAll

public CollectionWithPagingInfo<Person> readAll(Parameters params)

Description copied from interface: EntityResourceAction.Read

Reads all the entries from the collection. Paging information is provided.

Specified by:

readAll in interface EntityResourceAction.Read<Person>

Parameters:

params - - will never be null and will have the PAGING default values

requestPasswordReset

@Deprecated
@WebApiNoAuth
public void requestPasswordReset(String personId,
 Client client,
 Parameters parameters,
 WithResponse withResponse)

Deprecated.

resetPassword

@Deprecated
@WebApiNoAuth
public void resetPassword(String personId,
 PasswordReset passwordReset,
 Parameters parameters,
 WithResponse withResponse)

Deprecated.

readProperty

public BinaryResource readProperty(String personId,
 Parameters parameters)
                            throws EntityNotFoundException

Download avatar image content

Specified by:

readProperty in interface BinaryResourceAction.Read

Parameters:

personId -

parameters - Parameters

Returns:

Throws:

EntityNotFoundException

updateProperty

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

Upload avatar image content

Specified by:

updateProperty in interface BinaryResourceAction.Update<Person>

Parameters:

personId -

contentInfo - Basic information about the content stream

stream - An inputstream

parameters -

Returns:

deleteProperty

public void deleteProperty(String personId,
 Parameters parameters)

Delete avatar image content

Specified by:

deleteProperty in interface BinaryResourceAction.Delete

Parameters:

personId -

parameters -

deauthorizeUser

public void deauthorizeUser(String personId,
 Void body,
 Parameters parameters,
 WithResponse withResponse)

De-authorize user Not currently supported in community edition.

Parameters:

personId -

body -

parameters -

withResponse -

getReauthorizationCode

public AuthCode getReauthorizationCode(String personId,
 Void body,
 Parameters parameters,
 WithResponse withResponse)

Get the authorization code. Not supported in community edition.

reauthorizeUser

public void reauthorizeUser(String personId,
 AuthKey authKey,
 Parameters parameters,
 WithResponse withResponse)

Reauthorize user. Not supported in community edition.