Mercurial > lada > lada-server
view src/main/java/de/intevation/lada/rest/StatusService.java @ 722:c81881dac97e
Switch to shibboleth authorization in all REST-services.
author | Raimund Renkert <raimund.renkert@intevation.de> |
---|---|
date | Fri, 14 Aug 2015 09:45:01 +0200 |
parents | 3ec358698b4d |
children | e2a78d5afaaa |
line wrap: on
line source
/* Copyright (C) 2013 by Bundesamt fuer Strahlenschutz * Software engineering by Intevation GmbH * * This file is Free Software under the GNU GPL (v>=3) * and comes with ABSOLUTELY NO WARRANTY! Check out * the documentation coming with IMIS-Labordaten-Application for details. */ package de.intevation.lada.rest; import javax.enterprise.context.RequestScoped; import javax.inject.Inject; import javax.servlet.http.HttpServletRequest; import javax.ws.rs.DELETE; import javax.ws.rs.GET; import javax.ws.rs.POST; import javax.ws.rs.PUT; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.core.Context; import javax.ws.rs.core.HttpHeaders; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.MultivaluedMap; import javax.ws.rs.core.UriInfo; import de.intevation.lada.lock.LockConfig; import de.intevation.lada.lock.LockType; import de.intevation.lada.lock.ObjectLocker; import de.intevation.lada.model.land.LStatus; import de.intevation.lada.util.annotation.AuthorizationConfig; import de.intevation.lada.util.annotation.RepositoryConfig; import de.intevation.lada.util.auth.Authorization; import de.intevation.lada.util.auth.AuthorizationType; import de.intevation.lada.util.data.QueryBuilder; import de.intevation.lada.util.data.Repository; import de.intevation.lada.util.data.RepositoryType; import de.intevation.lada.util.rest.RequestMethod; import de.intevation.lada.util.rest.Response; /** * REST service for Status objects. * <p> * The services produce data in the application/json media type. * All HTTP methods use the authorization module to determine if the user is * allowed to perform the requested action. * A typical response holds information about the action performed and the data. * <pre> * <code> * { * "success": [boolean]; * "message": [string], * "data":[{ * "id": [number], * "erzeuger": [string], * "messungsId": [number], * "status": [number], * "owner": [boolean], * "readonly": [boolean], * "treeModified": [timestamp], * "parentModified": [timestamp], * "sdatum": [timestamp], * "skommentar": [string] * }], * "errors": [object], * "warnings": [object], * "readonly": [boolean], * "totalCount": [number] * } * </code> * </pre> * * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> */ @Path("status") @RequestScoped public class StatusService { /** * The data repository granting read/write access. */ @Inject @RepositoryConfig(type=RepositoryType.RW) private Repository defaultRepo; /** * The object lock mechanism. */ @Inject @LockConfig(type=LockType.TIMESTAMP) private ObjectLocker lock; /** * The authorization module. */ @Inject @AuthorizationConfig(type=AuthorizationType.HEADER) private Authorization authorization; /** * Get all Status objects. * <p> * The requested objects can be filtered using a URL parameter named * messungsId. * <p> * Example: http://example.com/status?messungsId=[ID] * * @return Response object containing all Status objects. */ @GET @Path("/") @Produces(MediaType.APPLICATION_JSON) public Response get( @Context HttpHeaders headers, @Context UriInfo info, @Context HttpServletRequest request ) { MultivaluedMap<String, String> params = info.getQueryParameters(); if (params.isEmpty() || !params.containsKey("messungsId")) { return defaultRepo.getAll(LStatus.class, "land"); } String messungId = params.getFirst("messungsId"); QueryBuilder<LStatus> builder = new QueryBuilder<LStatus>( defaultRepo.entityManager("land"), LStatus.class); builder.and("messungsId", messungId); return authorization.filter( request, defaultRepo.filter(builder.getQuery(), "land"), LStatus.class); } /** * Get a single Status object by id. * <p> * The id is appended to the URL as a path parameter. * <p> * Example: http://example.com/status/{id} * * @return Response object containing a single Status. */ @GET @Path("/{id}") @Produces(MediaType.APPLICATION_JSON) public Response getById( @Context HttpHeaders headers, @Context HttpServletRequest request, @PathParam("id") String id ) { return authorization.filter( request, defaultRepo.getById(LStatus.class, Integer.valueOf(id), "land"), LStatus.class); } /** * Create a Status object. * <p> * The new object is embedded in the post data as JSON formatted string. * <p> * <pre> * <code> * { * "owner": [boolean], * "messungsId": [number], * "erzeuger": [string], * "status": [number], * "skommentar": [string], * "treeModified":null, * "parentModified":null, * "sdatum": [date] * } * </code> * </pre> * * @return A response object containing the created Status. */ @POST @Path("/") @Produces(MediaType.APPLICATION_JSON) public Response create( @Context HttpHeaders headers, @Context HttpServletRequest request, LStatus status ) { if (!authorization.isAuthorized( request, status, RequestMethod.POST, LStatus.class) ) { return new Response(false, 699, null); } /* Persist the new object*/ return authorization.filter( request, defaultRepo.create(status, "land"), LStatus.class); } /** * Update an existing Status object. * <p> * The object to update should come as JSON formatted string. * <pre> * <code> * { * "id": [number], * "owner": [boolean], * "messungsId": [number], * "erzeuger": [string], * "status": [number], * "skommentar": [string], * "treeModified": [timestamp], * "parentModified": [timestamp], * "sdatum": [date] * } * </code> * </pre> * * @return Response object containing the updated Status object. */ @PUT @Path("/{id}") @Produces(MediaType.APPLICATION_JSON) public Response update( @Context HttpHeaders headers, @Context HttpServletRequest request, LStatus status ) { if (!authorization.isAuthorized( request, status, RequestMethod.PUT, LStatus.class) ) { return new Response(false, 699, null); } if (lock.isLocked(status)) { return new Response(false, 697, null); } Response response = defaultRepo.update(status, "land"); Response updated = defaultRepo.getById( LStatus.class, ((LStatus)response.getData()).getId(), "land"); return authorization.filter( request, updated, LStatus.class); } /** * Delete an existing Status object by id. * <p> * The id is appended to the URL as a path parameter. * <p> * Example: http://example.com/status/{id} * * @return Response object. */ @DELETE @Path("/{id}") @Produces(MediaType.APPLICATION_JSON) public Response delete( @Context HttpHeaders headers, @Context HttpServletRequest request, @PathParam("id") String id ) { /* Get the object by id*/ Response object = defaultRepo.getById(LStatus.class, Integer.valueOf(id), "land"); LStatus obj = (LStatus)object.getData(); if (!authorization.isAuthorized( request, obj, RequestMethod.DELETE, LStatus.class) ) { return new Response(false, 699, null); } if (lock.isLocked(obj)) { return new Response(false, 697, null); } /* Delete the object*/ return defaultRepo.delete(obj, "land"); } }