info.magnolia.cache.browser.rest.endpoint

Class CacheEndpoint

java.lang.Object

info.magnolia.rest.AbstractEndpoint<CacheEndpointDefinition>

info.magnolia.cache.browser.rest.endpoint.CacheEndpoint

@Path(value="/cache/v1")
public class CacheEndpoint
extends info.magnolia.rest.AbstractEndpoint<CacheEndpointDefinition>

Endpoint for retrieving, downloading and deleting cache entries.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASCENDING_ORDER
static String	DEFAULT_REST_URL
static String	DESCENDING_ORDER
static String	PROPERTY_CONTENT_TYPE
static String	PROPERTY_ERROR_MESSAGE
static String	PROPERTY_ORIGINAL_URL
static String	PROPERTY_PLAIN_CONTENT
static String	PROPERTY_SIZE
static String	PROPERTY_UNSUPPORTED_CACHED_ENTRY_TYPE

Constructor Summary

Constructors

Constructor and Description
CacheEndpoint(CacheEndpointDefinition endpointDefinition, info.magnolia.module.cache.inject.CacheFactoryProvider cacheFactoryProvider, info.magnolia.i18nsystem.SimpleTranslator i18n) Deprecated. since 5.5.3, Please use CacheEndpoint(CacheEndpointDefinition, CacheFactoryProvider, SimpleTranslator, CacheBrowserAppModule) instead.
CacheEndpoint(CacheEndpointDefinition endpointDefinition, info.magnolia.module.cache.inject.CacheFactoryProvider cacheFactoryProvider, info.magnolia.i18nsystem.SimpleTranslator i18n, CacheBrowserAppModule module)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	delete(String cacheName, String json)
javax.ws.rs.core.Response	getAllKeys(String cacheName)
javax.ws.rs.core.Response	getCacheContent(String cacheName, String json)
javax.ws.rs.core.Response	getCacheSize(String cacheName)
javax.ws.rs.core.Response	getKeys(String cacheName, int offset, int pageLength, String sortOrder, String sortProperty)
javax.ws.rs.core.Response	ping()

Methods inherited from class info.magnolia.rest.AbstractEndpoint

getEndpointDefinition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_REST_URL

public static final String DEFAULT_REST_URL

See Also:

Constant Field Values

PROPERTY_ERROR_MESSAGE

public static final String PROPERTY_ERROR_MESSAGE

See Also:

Constant Field Values

PROPERTY_SIZE

public static final String PROPERTY_SIZE

See Also:

Constant Field Values

PROPERTY_ORIGINAL_URL

public static final String PROPERTY_ORIGINAL_URL

See Also:

Constant Field Values

PROPERTY_CONTENT_TYPE

public static final String PROPERTY_CONTENT_TYPE

See Also:

Constant Field Values

PROPERTY_PLAIN_CONTENT

public static final String PROPERTY_PLAIN_CONTENT

See Also:

Constant Field Values

PROPERTY_UNSUPPORTED_CACHED_ENTRY_TYPE

public static final String PROPERTY_UNSUPPORTED_CACHED_ENTRY_TYPE

See Also:

Constant Field Values

ASCENDING_ORDER

public static final String ASCENDING_ORDER

See Also:

Constant Field Values

DESCENDING_ORDER

public static final String DESCENDING_ORDER

See Also:

Constant Field Values

Constructor Detail

CacheEndpoint

@Inject
public CacheEndpoint(CacheEndpointDefinition endpointDefinition,
                             info.magnolia.module.cache.inject.CacheFactoryProvider cacheFactoryProvider,
                             info.magnolia.i18nsystem.SimpleTranslator i18n,
                             CacheBrowserAppModule module)

CacheEndpoint

@Deprecated
public CacheEndpoint(CacheEndpointDefinition endpointDefinition,
                                 info.magnolia.module.cache.inject.CacheFactoryProvider cacheFactoryProvider,
                                 info.magnolia.i18nsystem.SimpleTranslator i18n)

Deprecated. since 5.5.3, Please use CacheEndpoint(CacheEndpointDefinition, CacheFactoryProvider, SimpleTranslator, CacheBrowserAppModule) instead.

Method Detail

ping

@GET
 @Path(value="/ping")
 @Produces(value="application/json")
public javax.ws.rs.core.Response ping()

getAllKeys

@GET
 @Path(value="/{cacheName}/getAll")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getAllKeys(@PathParam(value="cacheName")
                                                                                                                          String cacheName)

getKeys

@GET
 @Path(value="/{cacheName}/get")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getKeys(@PathParam(value="cacheName")
                                                                                                                    String cacheName,
                                                                                                                    @QueryParam(value="offset")
                                                                                                                    int offset,
                                                                                                                    @QueryParam(value="pageLength")
                                                                                                                    int pageLength,
                                                                                                                    @QueryParam(value="sortOrder")
                                                                                                                    String sortOrder,
                                                                                                                    @QueryParam(value="sortProperty")
                                                                                                                    String sortProperty)

getCacheSize

@GET
 @Path(value="/{cacheName}/size")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getCacheSize(@PathParam(value="cacheName")
                                                                                                                          String cacheName)

delete

@DELETE
 @Path(value="/{cacheName}/delete")
public javax.ws.rs.core.Response delete(@PathParam(value="cacheName")
                                                                                    String cacheName,
                                                                                    @QueryParam(value="cacheKey")
                                                                                    String json)

getCacheContent

@GET
 @Path(value="/{cacheName}/download")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getCacheContent(@PathParam(value="cacheName")
                                                                                                                                 String cacheName,
                                                                                                                                 @QueryParam(value="cacheKey")
                                                                                                                                 String json)