Package org.silverpeas.core.webapi.cache

Class VolatileCacheResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.cache.VolatileCacheResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("volatile/{componentInstanceId}")
@Authorized
public class VolatileCacheResource
extends RESTWebService

A REST Web resource which permits to obtain volatile identifier scoped into a component instance.
Please consule VolatileResourceCacheService.

Author:

Yohann Chastagnier

Nested Class Summary

Nested classes/interfaces inherited from class org.silverpeas.core.web.rs.RESTWebService

RESTWebService.WebProcess<R>, RESTWebService.WebTreatment<R>

Field Summary

Fields inherited from class org.silverpeas.core.web.rs.RESTWebService

RESPONSE_HEADER_ARRAYSIZE

Fields inherited from interface org.silverpeas.core.web.SilverpeasWebResource

BASE_PATH

Constructor Summary

Constructors

Constructor	Description
VolatileCacheResource()

Method Summary

Modifier and Type	Method	Description
String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.
protected String	getResourceBasePath()	Gets the base path of the web resource relative to the root path of all of the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().
String	newVolatileStringIdentifier()	Gets a new volatile identifier into the context of componentInstanceId retrieved from the URI.

Methods inherited from class org.silverpeas.core.web.rs.RESTWebService

fromPage, getBundle, getBundleLocation, getHighestUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getSilverpeasContext, getUri, getUser, getUserPreferences, getUserRoles, identifiedBy, identifiedBy, initContext, initWebResourceUri, isUserDefined, process

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.silverpeas.core.web.rs.ProtectedWebResource

validateUserAuthorization

Methods inherited from interface org.silverpeas.core.web.rs.WebAuthenticationValidation

validateUserAuthentication

Constructor Detail

VolatileCacheResource

public VolatileCacheResource()

Method Detail

newVolatileStringIdentifier

@GET
@Path("new")
@Produces("text/plain")
public String newVolatileStringIdentifier()

Gets a new volatile identifier into the context of componentInstanceId retrieved from the URI.

Returns:

the response to the HTTP GET request with the JSON representation of the asked calendars.

See Also:

RESTWebService.WebProcess.execute()

getComponentId

public String getComponentId()

Description copied from interface: SilverpeasWebResource

Gets the identifier of the component instance to which the requested resource belongs to.

Returns:

the identifier of the Silverpeas component instance.

getResourceBasePath

protected String getResourceBasePath()

Description copied from class: RESTWebService

Gets the base path of the web resource relative to the root path of all of the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().

Specified by:

getResourceBasePath in class RESTWebService

Returns:

the relative path that identifies this REST web service among all other REST web services.