1 /**
2 * This file Copyright (c) 2015-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cache.browser.rest.client;
35
36 import javax.ws.rs.DELETE;
37 import javax.ws.rs.GET;
38 import javax.ws.rs.Path;
39 import javax.ws.rs.PathParam;
40 import javax.ws.rs.QueryParam;
41
42 import com.fasterxml.jackson.databind.JsonNode;
43
44 /**
45 * Client service that connects to the {@link info.magnolia.cache.browser.rest.endpoint.CacheEndpoint}.
46 */
47 public interface CacheService {
48
49 @GET
50 @Path("/ping")
51 public String ping();
52
53 @GET
54 @Path("/{cacheName}/getAll")
55 public String getAllKeys(@PathParam("cacheName") String cacheName);
56
57 @GET
58 @Path("/{cacheName}/get")
59 public String getKeys(@PathParam("cacheName") String cacheName, @QueryParam("offset") int offset, @QueryParam("pageLength") int pageLength, @QueryParam("sortOrder") final String sortOrder, @QueryParam("sortProperty") final String sortProperty);
60
61 @GET
62 @Path("/{cacheName}/size")
63 public JsonNode getCacheSize(@PathParam("cacheName") String cacheName);
64
65 @GET
66 @Path("/{cacheName}/download")
67 public JsonNode getCacheContent(@PathParam("cacheName") String cacheName, @QueryParam("cacheKey") String cacheKey);
68
69 @DELETE
70 @Path("/{cacheName}/delete")
71 public void delete(@PathParam("cacheName") String cacheName, @QueryParam("cacheKey") String cacheKey);
72 }