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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterPropertiesSet()
List<Person>
create(List<Person> persons, Parameters parameters)
void
deleteProperty(String personId, Parameters parameters)
Delete avatar image contentCollectionWithPagingInfo<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 contentvoid
requestPasswordReset(String personId, Client client, Parameters parameters, WithResponse withResponse)
void
resetPassword(String personId, PasswordReset passwordReset, Parameters parameters, WithResponse withResponse)
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
-
-
-
Method Detail
-
setPeople
public void setPeople(People people)
-
afterPropertiesSet
public void afterPropertiesSet()
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
-
readById
public Person readById(String personId, Parameters parameters)
Get a person by userName.- Specified by:
readById
in interfaceEntityResourceAction.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 interfaceEntityResourceAction.Create<Person>
-
update
public Person update(String personId, Person person, Parameters parameters)
- Specified by:
update
in interfaceEntityResourceAction.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 interfaceEntityResourceAction.Read<Person>
- Parameters:
params
- - will never be null and will have the PAGING default values
-
requestPasswordReset
@WebApiNoAuth public void requestPasswordReset(String personId, Client client, Parameters parameters, WithResponse withResponse)
-
resetPassword
@WebApiNoAuth public void resetPassword(String personId, PasswordReset passwordReset, Parameters parameters, WithResponse withResponse)
-
readProperty
public BinaryResource readProperty(String personId, Parameters parameters) throws EntityNotFoundException
Download avatar image content- Specified by:
readProperty
in interfaceBinaryResourceAction.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 interfaceBinaryResourceAction.Update<Person>
- Parameters:
personId
-contentInfo
- Basic information about the content streamstream
- An inputstreamparameters
-- Returns:
-
deleteProperty
public void deleteProperty(String personId, Parameters parameters)
Delete avatar image content- Specified by:
deleteProperty
in interfaceBinaryResourceAction.Delete
- Parameters:
personId
-parameters
-
-
-