Package org.silverpeas.core.webapi.viewer

Class AbstractViewResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.viewer.AbstractViewResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

Direct Known Subclasses:

DocumentViewResource, PreviewResource

public abstract class AbstractViewResource
extends RESTWebService

This abstraction centralizes the commons stuffs between the WEB services of view and preview of documents.

In particular, it provides a method for checking user authorizations to access a target resource.

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

Method Summary

Modifier and Type	Method	Description
protected ResourceView	getAuthorizedResourceView(String id, String type, String language)
String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.

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

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

AbstractViewResource

public AbstractViewResource()

Method Detail

getAuthorizedResourceView

protected ResourceView getAuthorizedResourceView(String id,
                                                 String type,
                                                 String language)

See Also:

ResourceViewProvider.getAuthorizedResourceView(String, String, String)

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.