Mercurial > lada > lada-server

annotate src/main/java/de/intevation/lada/rest/stamm/DatenbasisService.java @ 1097:186d602e031a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merged branch schema-update into default.
author Tom Gottfried <tom@intevation.de>
date Fri, 14 Oct 2016 18:17:42 +0200
parents 5bdd1631a451
children
rev   line source
496
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
1 /* Copyright (C) 2013 by Bundesamt fuer Strahlenschutz
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
2 * Software engineering by Intevation GmbH
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
3 *
629
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
4 * This file is Free Software under the GNU GPL (v>=3)
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
6 * the documentation coming with IMIS-Labordaten-Application for details.
496
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
7 */
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
8 package de.intevation.lada.rest.stamm;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
9
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
10 import javax.enterprise.context.RequestScoped;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
11 import javax.inject.Inject;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
12 import javax.ws.rs.GET;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
13 import javax.ws.rs.Path;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
14 import javax.ws.rs.PathParam;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
15 import javax.ws.rs.Produces;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
16 import javax.ws.rs.core.Context;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
17 import javax.ws.rs.core.HttpHeaders;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
18 import javax.ws.rs.core.MediaType;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
19 import javax.ws.rs.core.UriInfo;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
20
1097
186d602e031a Merged branch schema-update into default.
Tom Gottfried <tom@intevation.de>
parents: 827
diff changeset
21 import de.intevation.lada.model.stammdaten.Datenbasis;
496
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
22 import de.intevation.lada.util.annotation.RepositoryConfig;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
23 import de.intevation.lada.util.data.Repository;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
24 import de.intevation.lada.util.data.RepositoryType;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
25 import de.intevation.lada.util.rest.Response;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
26
629
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
27 /**
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
28 * REST service for Datenbasis objects.
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
29 * <p>
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
30 * The services produce data in the application/json media type.
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
31 * A typical response holds information about the action performed and the data.
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
32 * <pre>
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
33 * <code>
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
34 * {
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
35 * "success": [boolean];
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
36 * "message": [string],
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
37 * "data":[{
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
38 * "id": [number],
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
39 * "beschreibung": [string],
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
40 * "datenbasis": [string}
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
41 * }],
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
42 * "errors": [object],
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
43 * "warnings": [object],
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
44 * "readonly": [boolean],
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
45 * "totalCount": [number]
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
46 * }
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
47 * </code>
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
48 * </pre>
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
49 *
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
50 * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a>
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
51 */
827
5bdd1631a451 !!!CAUTION!!! changed services path!
Raimund Renkert <raimund.renkert@intevation.de>
parents: 630
diff changeset
52 @Path("rest/datenbasis")
496
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
53 @RequestScoped
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
54 public class DatenbasisService {
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
55
629
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
56 /**
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
57 * The data repository granting read access.
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
58 */
496
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
59 @Inject
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
60 @RepositoryConfig(type=RepositoryType.RO)
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
61 private Repository defaultRepo;
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
62
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
63 /**
629
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
64 * Get all Datenbasis objects.
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
65 * <p>
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
66 * Example: http://example.com/datenbasis
496
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
67 *
629
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
68 * @return Response object containing all Datenbasis objects.
496
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
69 */
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
70 @GET
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
71 @Path("/")
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
72 @Produces(MediaType.APPLICATION_JSON)
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
73 public Response get(
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
74 @Context HttpHeaders headers,
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
75 @Context UriInfo info
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
76 ) {
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
77 return defaultRepo.getAll(Datenbasis.class, "stamm");
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
78 }
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
79
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
80 /**
630
44d7ff0461f2 Code documentation.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 629
diff changeset
81 * Get a single Datenbasis object by id.
629
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
82 * <p>
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
83 * The id is appended to the URL as a path parameter.
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
84 * <p>
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
85 * Example: http://example.com/datenbasis/{id}
496
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
86 *
629
3bbfdef05ee1 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 583
diff changeset
87 * @return Response object containing a single Datenabasis.
496
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
88 */
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
89 @GET
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
90 @Path("/{id}")
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
91 @Produces(MediaType.APPLICATION_JSON)
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
92 public Response getById(
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
93 @Context HttpHeaders headers,
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
94 @PathParam("id") String id
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
95 ) {
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
96 return defaultRepo.getById(
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
97 Datenbasis.class,
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
98 Integer.valueOf(id),
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
99 "stamm");
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
100 }
f61377527561 Added service for datenbasis.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
101 }
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)