Package org.silverpeas.core.webapi.subscribe

Class UnsubscribeResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.subscribe.AbstractSubscriptionResource

org.silverpeas.core.webapi.subscribe.UnsubscribeResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("unsubscribe/{componentId}")
@Authorized
public class UnsubscribeResource
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
UnsubscribeResource()

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 of the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().
javax.ws.rs.core.Response	unsubscribeGroupFromComponent(String groupId)
javax.ws.rs.core.Response	unsubscribeGroupFromResource(String subscriptionType, String id, String groupId)
javax.ws.rs.core.Response	unsubscribeUserFromComponent()
javax.ws.rs.core.Response	unsubscribeUserFromComponent(String userId)
javax.ws.rs.core.Response	unsubscribeUserFromResource(String subscriptionType, String id)
javax.ws.rs.core.Response	unsubscribeUserFromResource(String subscriptionType, String id, String userId)

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

decodeSubscriptionResourceType, getComponentId, getSubscription, getSubscriptionResource

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

UnsubscribeResource

public UnsubscribeResource()

Method Detail

unsubscribeUserFromComponent

@POST
@Produces("application/json")
public javax.ws.rs.core.Response unsubscribeUserFromComponent()

unsubscribeUserFromComponent

@POST
@Path("user/{userId}")
@Produces("application/json")
public javax.ws.rs.core.Response unsubscribeUserFromComponent(@PathParam("userId")
                                                              String userId)

unsubscribeGroupFromComponent

@POST
@Path("group/{groupId}")
@Produces("application/json")
public javax.ws.rs.core.Response unsubscribeGroupFromComponent(@PathParam("groupId")
                                                               String groupId)

unsubscribeUserFromResource

@POST
@Path("{subscriptionType}/{id}")
@Produces("application/json")
public javax.ws.rs.core.Response unsubscribeUserFromResource(@PathParam("subscriptionType")
                                                             String subscriptionType,
                                                             @PathParam("id")
                                                             String id)

unsubscribeUserFromResource

@POST
@Path("{subscriptionType}/{id}/user/{userId}")
@Produces("application/json")
public javax.ws.rs.core.Response unsubscribeUserFromResource(@PathParam("subscriptionType")
                                                             String subscriptionType,
                                                             @PathParam("id")
                                                             String id,
                                                             @PathParam("userId")
                                                             String userId)

unsubscribeGroupFromResource

@POST
@Path("{subscriptionType}/{id}/group/{groupId}")
@Produces("application/json")
public javax.ws.rs.core.Response unsubscribeGroupFromResource(@PathParam("subscriptionType")
                                                              String subscriptionType,
                                                              @PathParam("id")
                                                              String id,
                                                              @PathParam("groupId")
                                                              String groupId)

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.