Package org.silverpeas.core.webapi.subscribe

Class AbstractSubscriptionResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.subscribe.AbstractSubscriptionResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

Direct Known Subclasses:

SubscribeResource, SubscriptionResource, UnsubscribeResource

public abstract class AbstractSubscriptionResource
extends RESTWebService

Author:

silveryocha

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

Method Summary

Modifier and Type	Method	Description
protected SubscriptionResourceType	decodeSubscriptionResourceType(String type)	Decodes from the given type as string the right SubscriptionResourceType instance.
String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.
protected Subscription	getSubscription(SubscriptionSubscriber subscriber, SubscriptionResourceType type, String resourceId)	Gets the Subscription instance from given parameters.
protected SubscriptionResource	getSubscriptionResource(SubscriptionResourceType type, String resourceId)	Gets the SubscriptionResource instance from given SubscriptionResourceType and ressource identifier.

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

fromPage, getBundle, getBundleLocation, getHighestUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getResourceBasePath, 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

AbstractSubscriptionResource

public AbstractSubscriptionResource()

Method Detail

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.

decodeSubscriptionResourceType

protected SubscriptionResourceType decodeSubscriptionResourceType(String type)

Decodes from the given type as string the right SubscriptionResourceType instance.

Parameters:

type - type as string.

Returns:

the corresponding SubscriptionResourceType instance.

getSubscriptionResource

protected SubscriptionResource getSubscriptionResource(SubscriptionResourceType type,
                                                       String resourceId)

Gets the SubscriptionResource instance from given SubscriptionResourceType and ressource identifier.

Parameters:

type - the subscription resource type.

resourceId - the identifier of a resource.

Returns:

the right SubscriptionResource instance.

getSubscription

protected Subscription getSubscription(SubscriptionSubscriber subscriber,
                                       SubscriptionResourceType type,
                                       String resourceId)

Gets the Subscription instance from given parameters.

Parameters:

subscriber - the subscription subscriber.

type - the subscription resource type.

resourceId - the identifier of a resource.

Returns:

the right SubscriptionResource instance.