mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-24 17:32:48 +00:00
ACS-9178 Add REST API for deauthorizing (#3169)
* ACS-9178 Set peopleEntityResource bean id * ACS-9178 Add the 'deauthorizeUser' operation * ACS-9178 Add 'deauthorizeUser' to Rest API * ACS-9178 Add test * ACS-9178 Fix PMD * ACS-9178 Fix deauthorize API tests --------- Co-authored-by: Gerard Olenski <gerard.olenski@hyland.com>
This commit is contained in:
Damian Ujma
GitHub
@@ -1,234 +1,248 @@
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2023 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 java.io.InputStream;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import jakarta.servlet.http.HttpServletResponse;
|
||||
|
||||
import org.alfresco.model.ContentModel;
|
||||
import org.alfresco.rest.api.People;
|
||||
import org.alfresco.rest.api.model.Client;
|
||||
import org.alfresco.rest.api.model.PasswordReset;
|
||||
import org.alfresco.rest.api.model.Person;
|
||||
import org.alfresco.rest.framework.BinaryProperties;
|
||||
import org.alfresco.rest.framework.Operation;
|
||||
import org.alfresco.rest.framework.WebApiDescription;
|
||||
import org.alfresco.rest.framework.WebApiNoAuth;
|
||||
import org.alfresco.rest.framework.WebApiParam;
|
||||
import org.alfresco.rest.framework.core.ResourceParameter;
|
||||
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
|
||||
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
|
||||
import org.alfresco.rest.framework.resource.EntityResource;
|
||||
import org.alfresco.rest.framework.resource.actions.interfaces.BinaryResourceAction;
|
||||
import org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction;
|
||||
import org.alfresco.rest.framework.resource.content.BasicContentInfo;
|
||||
import org.alfresco.rest.framework.resource.content.BinaryResource;
|
||||
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
|
||||
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
||||
import org.alfresco.rest.framework.webscripts.WithResponse;
|
||||
import org.alfresco.util.PropertyCheck;
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
import org.springframework.beans.factory.InitializingBean;
|
||||
|
||||
/**
|
||||
* 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>,
|
||||
EntityResourceAction.Update<Person>,EntityResourceAction.Read<Person>,
|
||||
|
||||
BinaryResourceAction.Read, BinaryResourceAction.Update<Person>, BinaryResourceAction.Delete, InitializingBean
|
||||
{
|
||||
private static Log logger = LogFactory.getLog(PeopleEntityResource.class);
|
||||
|
||||
private People people;
|
||||
|
||||
public void setPeople(People people)
|
||||
{
|
||||
this.people = people;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void afterPropertiesSet()
|
||||
{
|
||||
PropertyCheck.mandatory(this, "people", 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="persons", title="A single person", description="A single person, multiple people are not supported.",
|
||||
kind= ResourceParameter.KIND.HTTP_BODY_OBJECT, allowMultiple=false, required = true)
|
||||
public List<Person> create(List<Person> persons, Parameters parameters)
|
||||
{
|
||||
Person p = persons.get(0);
|
||||
|
||||
validateDerivedFieldsExistence(p);
|
||||
|
||||
List<Person> result = new ArrayList<>(1);
|
||||
result.add(people.create(p));
|
||||
return result;
|
||||
}
|
||||
|
||||
@Override
|
||||
@WebApiDescription(title="Update person", description="Update the given person's details")
|
||||
public Person update(String personId, Person person, Parameters parameters)
|
||||
{
|
||||
if (person.wasSet(ContentModel.PROP_USERNAME))
|
||||
{
|
||||
// REPO-1537
|
||||
throw new InvalidArgumentException("Unsupported field: id");
|
||||
}
|
||||
|
||||
validateDerivedFieldsExistence(person);
|
||||
|
||||
return people.update(personId, person);
|
||||
}
|
||||
|
||||
/**
|
||||
* Explicitly test for the presence of system-maintained (derived) fields that are settable on Person (see also REPO-110).
|
||||
*
|
||||
* @param person
|
||||
*/
|
||||
private void validateDerivedFieldsExistence(Person person)
|
||||
{
|
||||
if (person.wasSet(ContentModel.PROP_USER_STATUS_TIME))
|
||||
{
|
||||
throw new InvalidArgumentException("Unsupported field: statusUpdatedAt");
|
||||
}
|
||||
|
||||
if (person.wasSet(Person.PROP_PERSON_AVATAR_ID))
|
||||
{
|
||||
throw new InvalidArgumentException("Unsupported field: avatarId");
|
||||
}
|
||||
|
||||
if (person.wasSet(ContentModel.PROP_SIZE_QUOTA))
|
||||
{
|
||||
throw new InvalidArgumentException("Unsupported field: quota");
|
||||
}
|
||||
|
||||
if (person.wasSet(ContentModel.PROP_SIZE_CURRENT))
|
||||
{
|
||||
throw new InvalidArgumentException("Unsupported field: quotaUsed");
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
@WebApiDescription(title = "Get List of People", description = "Get List of People")
|
||||
public CollectionWithPagingInfo<Person> readAll(Parameters params)
|
||||
{
|
||||
return people.getPeople(params);
|
||||
}
|
||||
|
||||
@Deprecated
|
||||
@Operation("request-password-reset")
|
||||
@WebApiDescription(title = "Request Password Reset", description = "Request password reset",
|
||||
successStatus = HttpServletResponse.SC_ACCEPTED)
|
||||
@WebApiNoAuth
|
||||
public void requestPasswordReset(String personId, Client client, Parameters parameters, WithResponse withResponse)
|
||||
{
|
||||
people.requestPasswordReset(personId, client.getClient());
|
||||
}
|
||||
|
||||
@Deprecated
|
||||
@Operation("reset-password")
|
||||
@WebApiDescription(title = "Reset Password", description = "Performs password reset", successStatus = HttpServletResponse.SC_ACCEPTED)
|
||||
@WebApiNoAuth
|
||||
public void resetPassword(String personId, PasswordReset passwordReset, Parameters parameters, WithResponse withResponse)
|
||||
{
|
||||
people.resetPassword(personId, passwordReset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Download avatar image content
|
||||
*
|
||||
* @param personId
|
||||
* @param parameters {@link Parameters}
|
||||
* @return
|
||||
* @throws EntityNotFoundException
|
||||
*/
|
||||
@Override
|
||||
@WebApiDescription(title = "Download avatar", description = "Download avatar")
|
||||
@BinaryProperties({"avatar"})
|
||||
public BinaryResource readProperty(String personId, Parameters parameters) throws EntityNotFoundException
|
||||
{
|
||||
return people.downloadAvatarContent(personId, parameters);
|
||||
}
|
||||
|
||||
/**
|
||||
* Upload avatar image content
|
||||
*
|
||||
* @param personId
|
||||
* @param contentInfo Basic information about the content stream
|
||||
* @param stream An inputstream
|
||||
* @param parameters
|
||||
* @return
|
||||
*/
|
||||
@Override
|
||||
@WebApiDescription(title = "Upload avatar", description = "Upload avatar")
|
||||
@BinaryProperties({"avatar"})
|
||||
public Person updateProperty(String personId, BasicContentInfo contentInfo, InputStream stream, Parameters parameters)
|
||||
{
|
||||
return people.uploadAvatarContent(personId, contentInfo, stream, parameters);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete avatar image content
|
||||
*
|
||||
* @param personId
|
||||
* @param parameters
|
||||
* @return
|
||||
*/
|
||||
@Override
|
||||
@WebApiDescription(title = "Delete avatar image", description = "Delete avatar image")
|
||||
@BinaryProperties({ "avatar" })
|
||||
public void deleteProperty(String personId, Parameters parameters)
|
||||
{
|
||||
people.deleteAvatarContent(personId);
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
/*
|
||||
* #%L
|
||||
* Alfresco Remote API
|
||||
* %%
|
||||
* Copyright (C) 2005 - 2025 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 java.io.InputStream;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import jakarta.servlet.http.HttpServletResponse;
|
||||
|
||||
import org.springframework.beans.factory.InitializingBean;
|
||||
|
||||
import org.alfresco.model.ContentModel;
|
||||
import org.alfresco.rest.api.People;
|
||||
import org.alfresco.rest.api.model.Client;
|
||||
import org.alfresco.rest.api.model.PasswordReset;
|
||||
import org.alfresco.rest.api.model.Person;
|
||||
import org.alfresco.rest.framework.BinaryProperties;
|
||||
import org.alfresco.rest.framework.Operation;
|
||||
import org.alfresco.rest.framework.WebApiDescription;
|
||||
import org.alfresco.rest.framework.WebApiNoAuth;
|
||||
import org.alfresco.rest.framework.WebApiParam;
|
||||
import org.alfresco.rest.framework.core.ResourceParameter;
|
||||
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
|
||||
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
|
||||
import org.alfresco.rest.framework.resource.EntityResource;
|
||||
import org.alfresco.rest.framework.resource.actions.interfaces.BinaryResourceAction;
|
||||
import org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction;
|
||||
import org.alfresco.rest.framework.resource.content.BasicContentInfo;
|
||||
import org.alfresco.rest.framework.resource.content.BinaryResource;
|
||||
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
|
||||
import org.alfresco.rest.framework.resource.parameters.Parameters;
|
||||
import org.alfresco.rest.framework.webscripts.WithResponse;
|
||||
import org.alfresco.util.PropertyCheck;
|
||||
|
||||
/**
|
||||
* 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>,
|
||||
EntityResourceAction.Update<Person>, EntityResourceAction.Read<Person>,
|
||||
|
||||
BinaryResourceAction.Read, BinaryResourceAction.Update<Person>, BinaryResourceAction.Delete, InitializingBean
|
||||
{
|
||||
private People people;
|
||||
|
||||
public void setPeople(People people)
|
||||
{
|
||||
this.people = people;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void afterPropertiesSet()
|
||||
{
|
||||
PropertyCheck.mandatory(this, "people", 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 = "persons", title = "A single person", description = "A single person, multiple people are not supported.",
|
||||
kind = ResourceParameter.KIND.HTTP_BODY_OBJECT, allowMultiple = false, required = true)
|
||||
public List<Person> create(List<Person> persons, Parameters parameters)
|
||||
{
|
||||
Person p = persons.get(0);
|
||||
|
||||
validateDerivedFieldsExistence(p);
|
||||
|
||||
List<Person> result = new ArrayList<>(1);
|
||||
result.add(people.create(p));
|
||||
return result;
|
||||
}
|
||||
|
||||
@Override
|
||||
@WebApiDescription(title = "Update person", description = "Update the given person's details")
|
||||
public Person update(String personId, Person person, Parameters parameters)
|
||||
{
|
||||
if (person.wasSet(ContentModel.PROP_USERNAME))
|
||||
{
|
||||
// REPO-1537
|
||||
throw new InvalidArgumentException("Unsupported field: id");
|
||||
}
|
||||
|
||||
validateDerivedFieldsExistence(person);
|
||||
|
||||
return people.update(personId, person);
|
||||
}
|
||||
|
||||
/**
|
||||
* Explicitly test for the presence of system-maintained (derived) fields that are settable on Person (see also REPO-110).
|
||||
*
|
||||
* @param person
|
||||
*/
|
||||
private void validateDerivedFieldsExistence(Person person)
|
||||
{
|
||||
if (person.wasSet(ContentModel.PROP_USER_STATUS_TIME))
|
||||
{
|
||||
throw new InvalidArgumentException("Unsupported field: statusUpdatedAt");
|
||||
}
|
||||
|
||||
if (person.wasSet(Person.PROP_PERSON_AVATAR_ID))
|
||||
{
|
||||
throw new InvalidArgumentException("Unsupported field: avatarId");
|
||||
}
|
||||
|
||||
if (person.wasSet(ContentModel.PROP_SIZE_QUOTA))
|
||||
{
|
||||
throw new InvalidArgumentException("Unsupported field: quota");
|
||||
}
|
||||
|
||||
if (person.wasSet(ContentModel.PROP_SIZE_CURRENT))
|
||||
{
|
||||
throw new InvalidArgumentException("Unsupported field: quotaUsed");
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
@WebApiDescription(title = "Get List of People", description = "Get List of People")
|
||||
public CollectionWithPagingInfo<Person> readAll(Parameters params)
|
||||
{
|
||||
return people.getPeople(params);
|
||||
}
|
||||
|
||||
@Deprecated
|
||||
@Operation("request-password-reset")
|
||||
@WebApiDescription(title = "Request Password Reset", description = "Request password reset",
|
||||
successStatus = HttpServletResponse.SC_ACCEPTED)
|
||||
@WebApiNoAuth
|
||||
public void requestPasswordReset(String personId, Client client, Parameters parameters, WithResponse withResponse)
|
||||
{
|
||||
people.requestPasswordReset(personId, client.getClient());
|
||||
}
|
||||
|
||||
@Deprecated
|
||||
@Operation("reset-password")
|
||||
@WebApiDescription(title = "Reset Password", description = "Performs password reset", successStatus = HttpServletResponse.SC_ACCEPTED)
|
||||
@WebApiNoAuth
|
||||
public void resetPassword(String personId, PasswordReset passwordReset, Parameters parameters, WithResponse withResponse)
|
||||
{
|
||||
people.resetPassword(personId, passwordReset);
|
||||
}
|
||||
|
||||
/**
|
||||
* Download avatar image content
|
||||
*
|
||||
* @param personId
|
||||
* @param parameters
|
||||
* {@link Parameters}
|
||||
* @return
|
||||
* @throws EntityNotFoundException
|
||||
*/
|
||||
@Override
|
||||
@WebApiDescription(title = "Download avatar", description = "Download avatar")
|
||||
@BinaryProperties({"avatar"})
|
||||
public BinaryResource readProperty(String personId, Parameters parameters) throws EntityNotFoundException
|
||||
{
|
||||
return people.downloadAvatarContent(personId, parameters);
|
||||
}
|
||||
|
||||
/**
|
||||
* Upload avatar image content
|
||||
*
|
||||
* @param personId
|
||||
* @param contentInfo
|
||||
* Basic information about the content stream
|
||||
* @param stream
|
||||
* An inputstream
|
||||
* @param parameters
|
||||
* @return
|
||||
*/
|
||||
@Override
|
||||
@WebApiDescription(title = "Upload avatar", description = "Upload avatar")
|
||||
@BinaryProperties({"avatar"})
|
||||
public Person updateProperty(String personId, BasicContentInfo contentInfo, InputStream stream, Parameters parameters)
|
||||
{
|
||||
return people.uploadAvatarContent(personId, contentInfo, stream, parameters);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete avatar image content
|
||||
*
|
||||
* @param personId
|
||||
* @param parameters
|
||||
* @return
|
||||
*/
|
||||
@Override
|
||||
@WebApiDescription(title = "Delete avatar image", description = "Delete avatar image")
|
||||
@BinaryProperties({"avatar"})
|
||||
public void deleteProperty(String personId, Parameters parameters)
|
||||
{
|
||||
people.deleteAvatarContent(personId);
|
||||
}
|
||||
|
||||
/**
|
||||
* De-authorize user
|
||||
*
|
||||
* Not currently supported in community edition.
|
||||
*
|
||||
* @param personId
|
||||
* @param body
|
||||
* @param parameters
|
||||
* @param withResponse
|
||||
*/
|
||||
@Operation("deauthorize")
|
||||
@WebApiDescription(title = "De-authorize user", description = "Performs user de-authorization", successStatus = HttpServletResponse.SC_NOT_IMPLEMENTED)
|
||||
public void deauthorizeUser(String personId, Void body, Parameters parameters, WithResponse withResponse)
|
||||
{
|
||||
// functionality is not implemented in community edition
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1116,7 +1116,7 @@
|
||||
<property name="siteMembershipRequests" ref="SiteMembershipRequests" />
|
||||
</bean>
|
||||
|
||||
<bean class="org.alfresco.rest.api.people.PeopleEntityResource">
|
||||
<bean id="peopleEntityResource" class="org.alfresco.rest.api.people.PeopleEntityResource">
|
||||
<property name="people" ref="People" />
|
||||
</bean>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user