mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
8328ca78ab
Creating branch for REPO-892 (Create person REST API) REPO-892: create person - initial commit, bare-bones implementation and test. REPO-892: refactored test versions of Person and Company to reduce duplication. REPO-892: further refactoring to reduce prod/test duplication. REPO-892: add missing fields to the 'create person' operation. REPO-892: introduced PersonUpdate class for create (and I'm assuming update) operations. REPO-892: missing license header REPO-892: very minor refactoring - extract field in tests. REPO-892: make sure not all fields need to be supplied during create. git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@131858 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
122 lines
4.7 KiB
Java
122 lines
4.7 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Remote API
|
|
* %%
|
|
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
|
* %%
|
|
* This file is part of the Alfresco software.
|
|
* If the software was purchased under a paid Alfresco license, the terms of
|
|
* the paid license agreement will prevail. Otherwise, the software is
|
|
* provided under the following open source license terms:
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
* #L%
|
|
*/
|
|
package org.alfresco.rest.api.people;
|
|
|
|
import org.alfresco.rest.api.People;
|
|
import org.alfresco.rest.api.model.Person;
|
|
import org.alfresco.rest.api.model.PersonUpdate;
|
|
import org.alfresco.rest.framework.WebApiDescription;
|
|
import org.alfresco.rest.framework.WebApiParam;
|
|
import org.alfresco.rest.framework.core.ResourceParameter;
|
|
import org.alfresco.rest.framework.resource.EntityResource;
|
|
import org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction;
|
|
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
|
import org.alfresco.util.ParameterCheck;
|
|
import org.apache.commons.logging.Log;
|
|
import org.apache.commons.logging.LogFactory;
|
|
import org.springframework.beans.factory.InitializingBean;
|
|
|
|
import java.util.ArrayList;
|
|
import java.util.List;
|
|
|
|
/**
|
|
* An implementation of an Entity Resource for a Person
|
|
*
|
|
* @author sglover
|
|
* @author Gethin James
|
|
*/
|
|
@EntityResource(name="people", title = "People")
|
|
public class PeopleEntityResource implements EntityResourceAction.ReadById<Person>, EntityResourceAction.Create<Person>, InitializingBean
|
|
{
|
|
private static Log logger = LogFactory.getLog(PeopleEntityResource.class);
|
|
|
|
private People people;
|
|
|
|
public void setPeople(People people)
|
|
{
|
|
this.people = people;
|
|
}
|
|
|
|
@Override
|
|
public void afterPropertiesSet()
|
|
{
|
|
ParameterCheck.mandatory("people", this.people);
|
|
}
|
|
|
|
/**
|
|
* Get a person by userName.
|
|
*
|
|
* @see org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction.ReadById#readById(String, org.alfresco.rest.framework.resource.parameters.Parameters)
|
|
*/
|
|
@Override
|
|
@WebApiDescription(title = "Get Person Information", description = "Get information for the person with id 'personId'")
|
|
@WebApiParam(name = "personId", title = "The person's username")
|
|
public Person readById(String personId, Parameters parameters)
|
|
{
|
|
Person person = people.getPerson(personId);
|
|
return person;
|
|
}
|
|
|
|
@Override
|
|
@WebApiDescription(title="Create person", description="Create a person")
|
|
@WebApiParam(name="entity", title="A single person", description="A single person, multiple people are not supported.",
|
|
kind= ResourceParameter.KIND.HTTP_BODY_OBJECT, allowMultiple=false)
|
|
public List<Person> create(List<Person> persons, Parameters parameters)
|
|
{
|
|
// Until REPO-110 is solved, we need to explicitly test for the presence of fields
|
|
// that are present on Person but not PersonUpdate
|
|
// see also, SiteEntityResource.update(String, Site, Parameters)
|
|
|
|
// TODO: these are the extras:
|
|
// avatarId
|
|
// statusUpdatedAt
|
|
// quota
|
|
// quotaUsed
|
|
|
|
List<Person> result = new ArrayList<>(1);
|
|
Person p = persons.get(0);
|
|
PersonUpdate person = new PersonUpdate.Builder()
|
|
.id(p.getUserName())
|
|
.firstName(p.getFirstName())
|
|
.lastName(p.getLastName())
|
|
.description(p.getDescription())
|
|
.email(p.getEmail())
|
|
.skypeId(p.getSkypeId())
|
|
.googleId(p.getGoogleId())
|
|
.instantMessageId(p.getInstantMessageId())
|
|
.jobTitle(p.getJobTitle())
|
|
.location(p.getLocation())
|
|
.company(p.getCompany())
|
|
.mobile(p.getMobile())
|
|
.telephone(p.getTelephone())
|
|
.userStatus(p.getUserStatus())
|
|
.enabled(p.isEnabled())
|
|
.emailNotificationsEnabled(p.isEmailNotificationsEnabled()).build();
|
|
|
|
result.add(people.create(person));
|
|
return result;
|
|
}
|
|
} |