Mercurial > lada > lada-server
view src/main/java/de/intevation/lada/rest/QueryService.java @ 628:21a49dc9984d
Code documentation.
author | Raimund Renkert <rrenkert@intevation.de> |
---|---|
date | Wed, 22 Apr 2015 14:03:53 +0200 |
parents | c5ae1eb3ff92 |
children | cdcb7a141529 |
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.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.Produces; import de.intevation.lada.query.QueryTools; import de.intevation.lada.util.rest.Response; /** * REST-Service for preconfigured queries. * <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": [string], * "name": [string], * "description": [string], * "sql": [string], * "filters": [array], * "results": [array] * }], * "errors": [object], * "warnings": [object], * "readonly": [boolean], * "totalCount": [number] * } * </code> * </pre> * * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a> */ @Path("/query") @RequestScoped public class QueryService { /** * Request all configured queries. */ @GET @Produces("application/json") public Response get() { return new Response(true, 200, QueryTools.getConfig()); } }