Mercurial > lada > lada-server

annotate src/main/java/de/intevation/lada/rest/VersionService.java @ 718:1fa184bc2768 2.1.0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated version numbers.
author Raimund Renkert <raimund.renkert@intevation.de>
date Thu, 06 Aug 2015 09:59:15 +0200
parents 3ec358698b4d
children 9ff0882d73d8
rev   line source
667
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
1 /* Copyright (C) 2013 by Bundesamt fuer Strahlenschutz
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
2 * Software engineering by Intevation GmbH
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
3 *
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
4 * This file is Free Software under the GNU GPL (v>=3)
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
6 * the documentation coming with IMIS-Labordaten-Application for details.
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
7 */
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
8 package de.intevation.lada.rest;
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
9
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
10 import javax.enterprise.context.RequestScoped;
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
11 import javax.servlet.http.HttpServletRequest;
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
12 import javax.ws.rs.GET;
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
13 import javax.ws.rs.Path;
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
14 import javax.ws.rs.Produces;
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
15 import javax.ws.rs.core.Context;
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
16 import javax.ws.rs.core.HttpHeaders;
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
17 import javax.ws.rs.core.MediaType;
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
18 import javax.ws.rs.core.UriInfo;
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
19
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
20 import de.intevation.lada.util.rest.Response;
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
21
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
22 /**
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
23 * REST service returning the server version.
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
24 * <p>
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
25 * The services produce data in the application/json media type.
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
26 * A typical response holds information about the action performed and the data.
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
27 * <pre>
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
28 * <code>
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
29 * {
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
30 * "success": [boolean];
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
31 * "message": [string],
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
32 * "data":{
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
33 * version: [string]
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
34 * },
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
35 * "errors": [object],
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
36 * "warnings": [object],
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
37 * "readonly": [boolean],
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
38 * "totalCount": [number]
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
39 * }
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
40 * </code>
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
41 * </pre>
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
42 *
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
43 * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a>
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
44 */
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
45 @Path("version")
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
46 @RequestScoped
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
47 public class VersionService {
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
48
718
1fa184bc2768 Updated version numbers.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 711
diff changeset
49 private static final String VERSION = "2.1.0";
667
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
50
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
51 /**
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
52 * Get server Version.
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
53 * <p>
711
3ec358698b4d Code style and documentation.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 705
diff changeset
54 * Example: http://example.com/version
667
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
55 *
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
56 * @return Response object containing all MessStelle objects.
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
57 */
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
58 @GET
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
59 @Path("/")
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
60 @Produces(MediaType.APPLICATION_JSON)
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
61 public Response get(
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
62 @Context HttpHeaders headers,
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
63 @Context HttpServletRequest request,
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
64 @Context UriInfo info
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
65 ) {
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
66 return new Response(true, 200, VERSION);
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
67 }
d92abc9bcd41 New REST service delivering the server version.
Raimund Renkert <raimund.renkert@intevation.de>
parents:
diff changeset
68 }
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)