Mercurial > lada > lada-server

annotate src/main/java/de/intevation/lada/rest/StatusService.java @ 628:21a49dc9984d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Code documentation.
author Raimund Renkert <rrenkert@intevation.de>
date Wed, 22 Apr 2015 14:03:53 +0200
parents ddab1ecb2898
children 3ec358698b4d
rev   line source
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
1 /* Copyright (C) 2013 by Bundesamt fuer Strahlenschutz
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
2 * Software engineering by Intevation GmbH
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
3 *
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
4 * This file is Free Software under the GNU GPL (v>=3)
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
6 * the documentation coming with IMIS-Labordaten-Application for details.
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
7 */
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
8 package de.intevation.lada.rest;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
9
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
10 import javax.enterprise.context.RequestScoped;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
11 import javax.inject.Inject;
582
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
12 import javax.servlet.http.HttpServletRequest;
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
13 import javax.ws.rs.DELETE;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
14 import javax.ws.rs.GET;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
15 import javax.ws.rs.POST;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
16 import javax.ws.rs.PUT;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
17 import javax.ws.rs.Path;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
18 import javax.ws.rs.PathParam;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
19 import javax.ws.rs.Produces;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
20 import javax.ws.rs.core.Context;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
21 import javax.ws.rs.core.HttpHeaders;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
22 import javax.ws.rs.core.MediaType;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
23 import javax.ws.rs.core.MultivaluedMap;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
24 import javax.ws.rs.core.UriInfo;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
25
595
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
26 import de.intevation.lada.lock.LockConfig;
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
27 import de.intevation.lada.lock.LockType;
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
28 import de.intevation.lada.lock.ObjectLocker;
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
29 import de.intevation.lada.model.land.LStatus;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
30 import de.intevation.lada.util.annotation.AuthorizationConfig;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
31 import de.intevation.lada.util.annotation.RepositoryConfig;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
32 import de.intevation.lada.util.auth.Authorization;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
33 import de.intevation.lada.util.auth.AuthorizationType;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
34 import de.intevation.lada.util.data.QueryBuilder;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
35 import de.intevation.lada.util.data.Repository;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
36 import de.intevation.lada.util.data.RepositoryType;
582
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
37 import de.intevation.lada.util.rest.RequestMethod;
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
38 import de.intevation.lada.util.rest.Response;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
39
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
40 /**
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
41 * REST service for Status objects.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
42 * <p>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
43 * The services produce data in the application/json media type.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
44 * All HTTP methods use the authorization module to determine if the user is
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
45 * allowed to perform the requested action.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
46 * A typical response holds information about the action performed and the data.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
47 * <pre>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
48 * <code>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
49 * {
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
50 * "success": [boolean];
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
51 * "message": [string],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
52 * "data":[{
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
53 * "id": [number],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
54 * "erzeuger": [string],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
55 * "messungsId": [number],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
56 * "status": [number],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
57 * "owner": [boolean],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
58 * "readonly": [boolean],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
59 * "treeModified": [timestamp],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
60 * "parentModified": [timestamp],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
61 * "sdatum": [timestamp],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
62 * "skommentar": [string]
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
63 * }],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
64 * "errors": [object],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
65 * "warnings": [object],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
66 * "readonly": [boolean],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
67 * "totalCount": [number]
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
68 * }
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
69 * </code>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
70 * </pre>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
71 *
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
72 * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
73 */
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
74 @Path("status")
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
75 @RequestScoped
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
76 public class StatusService {
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
77
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
78 /**
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
79 * The data repository granting read/write access.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
80 */
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
81 @Inject
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
82 @RepositoryConfig(type=RepositoryType.RW)
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
83 private Repository defaultRepo;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
84
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
85 /**
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
86 * The object lock mechanism.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
87 */
595
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
88 @Inject
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
89 @LockConfig(type=LockType.TIMESTAMP)
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
90 private ObjectLocker lock;
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
91
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
92 /**
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
93 * The authorization module.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
94 */
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
95 @Inject
582
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
96 @AuthorizationConfig(type=AuthorizationType.OPEN_ID)
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
97 private Authorization authorization;
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
98
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
99 /**
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
100 * Get all Status objects.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
101 * <p>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
102 * The requested objects can be filtered using a URL parameter named
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
103 * probeId.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
104 * <p>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
105 * Example: http://example.com/status?messungsId=[ID]
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
106 *
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
107 * @return Response object containing all Status objects.
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
108 */
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
109 @GET
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
110 @Path("/")
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
111 @Produces(MediaType.APPLICATION_JSON)
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
112 public Response get(
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
113 @Context HttpHeaders headers,
582
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
114 @Context UriInfo info,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
115 @Context HttpServletRequest request
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
116 ) {
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
117 MultivaluedMap<String, String> params = info.getQueryParameters();
556
4017d2c8dd24 Renamed all 'messungId' url parameters to 'messungsId'.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 488
diff changeset
118 if (params.isEmpty() || !params.containsKey("messungsId")) {
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
119 return defaultRepo.getAll(LStatus.class, "land");
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
120 }
556
4017d2c8dd24 Renamed all 'messungId' url parameters to 'messungsId'.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 488
diff changeset
121 String messungId = params.getFirst("messungsId");
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
122 QueryBuilder<LStatus> builder =
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
123 new QueryBuilder<LStatus>(
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
124 defaultRepo.entityManager("land"),
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
125 LStatus.class);
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
126 builder.and("messungsId", messungId);
582
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
127 return authorization.filter(
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
128 request,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
129 defaultRepo.filter(builder.getQuery(), "land"),
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
130 LStatus.class);
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
131 }
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
132
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
133 /**
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
134 * Get a single Status object by id.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
135 * <p>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
136 * The id is appended to the URL as a path parameter.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
137 * <p>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
138 * Example: http://example.com/status/{id}
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
139 *
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
140 * @return Response object containing a single Status.
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
141 */
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
142 @GET
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
143 @Path("/{id}")
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
144 @Produces(MediaType.APPLICATION_JSON)
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
145 public Response getById(
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
146 @Context HttpHeaders headers,
582
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
147 @Context HttpServletRequest request,
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
148 @PathParam("id") String id
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
149 ) {
582
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
150 return authorization.filter(
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
151 request,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
152 defaultRepo.getById(LStatus.class, Integer.valueOf(id), "land"),
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
153 LStatus.class);
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
154 }
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
155
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
156 /**
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
157 * Create a Status object.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
158 * <p>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
159 * The new object is embedded in the post data as JSON formatted string.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
160 * <p>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
161 * <pre>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
162 * <code>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
163 * {
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
164 * "owner": [boolean],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
165 * "messungsId": [number],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
166 * "erzeuger": [string],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
167 * "status": [number],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
168 * "skommentar": [string],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
169 * "treeModified":null,
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
170 * "parentModified":null,
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
171 * "sdatum": [date]
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
172 * }
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
173 * </code>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
174 * </pre>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
175 *
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
176 * @return A response object containing the created Status.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
177 */
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
178 @POST
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
179 @Path("/")
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
180 @Produces(MediaType.APPLICATION_JSON)
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
181 public Response create(
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
182 @Context HttpHeaders headers,
582
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
183 @Context HttpServletRequest request,
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
184 LStatus status
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
185 ) {
582
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
186 if (!authorization.isAuthorized(
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
187 request,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
188 status,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
189 RequestMethod.POST,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
190 LStatus.class)
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
191 ) {
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
192 return new Response(false, 699, null);
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
193 }
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
194 /* Persist the new object*/
601
ddab1ecb2898 Use the authorization filter in all REST operations.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 595
diff changeset
195 return authorization.filter(
ddab1ecb2898 Use the authorization filter in all REST operations.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 595
diff changeset
196 request,
ddab1ecb2898 Use the authorization filter in all REST operations.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 595
diff changeset
197 defaultRepo.create(status, "land"),
ddab1ecb2898 Use the authorization filter in all REST operations.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 595
diff changeset
198 LStatus.class);
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
199 }
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
200
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
201 /**
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
202 * Update an existing Status object.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
203 * <p>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
204 * The object to update should come as JSON formatted string.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
205 * <pre>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
206 * <code>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
207 * {
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
208 * "id": [number],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
209 * "owner": [boolean],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
210 * "messungsId": [number],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
211 * "erzeuger": [string],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
212 * "status": [number],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
213 * "skommentar": [string],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
214 * "treeModified": [timestamp],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
215 * "parentModified": [timestamp],
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
216 * "sdatum": [date]
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
217 * }
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
218 * </code>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
219 * </pre>
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
220 *
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
221 * @return Response object containing the updated Status object.
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
222 */
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
223 @PUT
557
61ce3ce0100e Allow /{id} in urls on PUT requests.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 556
diff changeset
224 @Path("/{id}")
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
225 @Produces(MediaType.APPLICATION_JSON)
582
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
226 public Response update(
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
227 @Context HttpHeaders headers,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
228 @Context HttpServletRequest request,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
229 LStatus status
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
230 ) {
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
231 if (!authorization.isAuthorized(
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
232 request,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
233 status,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
234 RequestMethod.PUT,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
235 LStatus.class)
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
236 ) {
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
237 return new Response(false, 699, null);
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
238 }
595
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
239 if (lock.isLocked(status)) {
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
240 return new Response(false, 697, null);
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
241 }
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
242 Response response = defaultRepo.update(status, "land");
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
243 Response updated = defaultRepo.getById(
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
244 LStatus.class,
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
245 ((LStatus)response.getData()).getId(), "land");
601
ddab1ecb2898 Use the authorization filter in all REST operations.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 595
diff changeset
246 return authorization.filter(
ddab1ecb2898 Use the authorization filter in all REST operations.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 595
diff changeset
247 request,
ddab1ecb2898 Use the authorization filter in all REST operations.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 595
diff changeset
248 updated,
ddab1ecb2898 Use the authorization filter in all REST operations.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 595
diff changeset
249 LStatus.class);
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
250 }
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
251
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
252 /**
628
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
253 * Delete an existing Status object by id.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
254 * <p>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
255 * The id is appended to the URL as a path parameter.
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
256 * <p>
21a49dc9984d Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 601
diff changeset
257 * Example: http://example.com/status/{id}
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
258 *
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
259 * @return Response object.
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
260 */
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
261 @DELETE
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
262 @Path("/{id}")
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
263 @Produces(MediaType.APPLICATION_JSON)
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
264 public Response delete(
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
265 @Context HttpHeaders headers,
582
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
266 @Context HttpServletRequest request,
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
267 @PathParam("id") String id
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
268 ) {
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
269 /* Get the object by id*/
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
270 Response object =
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
271 defaultRepo.getById(LStatus.class, Integer.valueOf(id), "land");
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
272 LStatus obj = (LStatus)object.getData();
582
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
273 if (!authorization.isAuthorized(
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
274 request,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
275 obj,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
276 RequestMethod.DELETE,
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
277 LStatus.class)
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
278 ) {
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
279 return new Response(false, 699, null);
a04658486ede Use authentication info for authorization of requested objects.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 557
diff changeset
280 }
595
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
281 if (lock.isLocked(obj)) {
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
282 return new Response(false, 697, null);
746e03da9fad Use timestamp locker in REST services.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 582
diff changeset
283 }
488
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
284 /* Delete the object*/
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
285 return defaultRepo.delete(obj, "land");
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
286 }
c1b0f4217488 Added status services.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
287 }
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)