Package org.silverpeas.core.webapi.subscribe

Class SubscribeResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.subscribe.AbstractSubscriptionResource

org.silverpeas.core.webapi.subscribe.SubscribeResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("subscribe/{componentId}")
@Authorized
public class SubscribeResource
extends AbstractSubscriptionResource

A REST Web resource representing a given subscription. It is a web service that provides an access to a subscription referenced by its URL.

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
SubscribeResource()

Method Summary

Modifier and Type	Method	Description
protected String	getResourceBasePath()	Gets the base path of the web resource relative to the root path of all the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().
protected URI	identifiedBy(URI uri)
String	subscribeToComponent()
String	subscribeToResource(String subscriptionType, String id)

Methods inherited from class org.silverpeas.core.webapi.subscribe.AbstractSubscriptionResource

decodeSubscriptionResourceType, getComponentId, getSubscription, getSubscriptionResource

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

createWebResourceUri, 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

SubscribeResource

public SubscribeResource()

Method Detail

subscribeToComponent

@POST
@Produces("application/json")
public String subscribeToComponent()

subscribeToResource

@POST
@Path("{subscriptionType}/{id}")
@Produces("application/json")
public String subscribeToResource(@PathParam("subscriptionType")
                                  String subscriptionType,
                                  @PathParam("id")
                                  String id)

identifiedBy

protected URI identifiedBy(URI uri)

getResourceBasePath

protected String getResourceBasePath()

Description copied from class: RESTWebService

Gets the base path of the web resource relative to the root path of all 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.