Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-13 00:45:44 +01:00
Code Issues Packages Projects Releases Activity

Name and document things

Browse Source
This commit is contained in:
René Pfeuffer
2018-06-26 11:47:38 +02:00
parent e3af714a76
commit d55fa508b9
1 changed files with 40 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
scm-webapp/src/main/java/sonia/scm/api/v2/resources/ResourceManagerAdapter.java
View File

@@ -14,48 +14,70 @@ import java.util.Collection;
import java.util.function.Function; import java.util.function.Function;
import java.util.function.Supplier; import java.util.function.Supplier;
class ResourceManagerAdapter<T extends ModelObject, D extends HalRepresentation, E extends Exception> extends AbstractManagerResource<T, E> { /**
* Adapter from resource http endpoints to managers.
* @param <MODEL_OBJECT> The type of the model object, eg. {@link sonia.scm.user.User}.
* @param <DTO> The corresponding transport object, eg. {@link UserDto}.
* @param <EXCEPTION> The exception type for the model object, eg. {@link sonia.scm.user.UserException}.
*/
class ResourceManagerAdapter<MODEL_OBJECT extends ModelObject, DTO extends HalRepresentation, EXCEPTION extends Exception> extends AbstractManagerResource<MODEL_OBJECT, EXCEPTION> {
ResourceManagerAdapter(Manager<T, E> manager) { ResourceManagerAdapter(Manager<MODEL_OBJECT, EXCEPTION> manager) {
super(manager); super(manager);
} }
public Response get(String id, Function<T, D> mapToDto) { /**
T entity = manager.get(id); * Reads the model object for the given id, transforms it to a dto and returns a corresponding http response.
if (entity == null) { * This handles all corner cases, eg. no matching object for the id or missing privileges.
*/
Response get(String id, Function<MODEL_OBJECT, DTO> mapToDto) {
MODEL_OBJECT modelObject = manager.get(id);
if (modelObject == null) {
return Response.status(Response.Status.NOT_FOUND).build(); return Response.status(Response.Status.NOT_FOUND).build();
} }
D dto = mapToDto.apply(entity); DTO dto = mapToDto.apply(modelObject);
return Response.ok(dto).build(); return Response.ok(dto).build();
} }
public Response update(String id, Function<T, T> applyChanges) { /**
T existingEntity = manager.get(id); * Update the model object for the given id according to the given function and returns a corresponding http response.
T changedEntity = applyChanges.apply(existingEntity); * This handles all corner cases, eg. no matching object for the id or missing privileges.
return update(id, changedEntity); */
public Response update(String id, Function<MODEL_OBJECT, MODEL_OBJECT> applyChanges) {
MODEL_OBJECT existingModelObject = manager.get(id);
MODEL_OBJECT changedModelObject = applyChanges.apply(existingModelObject);
return update(id, changedModelObject);
} }
public Response getAll(int page, int pageSize, String sortBy, boolean desc, Function<PageResult<T>, CollectionDto> mapToDto) { /**
PageResult<T> pageResult = fetchPage(sortBy, desc, page, pageSize); * Reads all model objects in a paged way, maps them using the given function and returns a corresponding http response.
* This handles all corner cases, eg. missing privileges.
*/
public Response getAll(int page, int pageSize, String sortBy, boolean desc, Function<PageResult<MODEL_OBJECT>, CollectionDto> mapToDto) {
PageResult<MODEL_OBJECT> pageResult = fetchPage(sortBy, desc, page, pageSize);
return Response.ok(mapToDto.apply(pageResult)).build(); return Response.ok(mapToDto.apply(pageResult)).build();
} }
public Response create(D dto, Supplier<T> entitySupplyer, Function<T, String> uriCreator) throws IOException, E { /**
* Creates a model object for the given dto and returns a corresponding http response.
* This handles all corner cases, eg. no conflicts or missing privileges.
*/
public Response create(DTO dto, Supplier<MODEL_OBJECT> modelObjectSupplier, Function<MODEL_OBJECT, String> uriCreator) throws IOException, EXCEPTION {
if (dto == null) { if (dto == null) {
return Response.status(400).build(); return Response.status(400).build();
} }
T entity = entitySupplyer.get(); MODEL_OBJECT modelObject = modelObjectSupplier.get();
manager.create(entity); manager.create(modelObject);
return Response.created(URI.create(uriCreator.apply(entity))).build(); return Response.created(URI.create(uriCreator.apply(modelObject))).build();
} }
@Override @Override
protected GenericEntity<Collection<T>> createGenericEntity(Collection<T> items) { protected GenericEntity<Collection<MODEL_OBJECT>> createGenericEntity(Collection<MODEL_OBJECT> modelObjects) {
throw new UnsupportedOperationException(); throw new UnsupportedOperationException();
} }
@Override @Override
protected String getId(T item) { protected String getId(MODEL_OBJECT item) {
return item.getId(); return item.getId();
} }