Package org.silverpeas.core.webapi.viewer

Class DocumentViewResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.viewer.DocumentViewResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("view/{componentId}")
@Authorized
public class DocumentViewResource
extends RESTWebService

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

Method Summary

Modifier and Type	Method	Description
protected DocumentViewEntity	asWebEntity(DocumentView documentView)	Converts the document view into its corresponding web entity.
DocumentViewEntity	getAttachmentView(String id, String language)	Gets the JSON representation of document view information.
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().
void	validateUserAuthorization(UserPrivilegeValidation validation)	Validates the authorization of the user to request this web service.

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.WebAuthenticationValidation

validateUserAuthentication

Constructor Detail

DocumentViewResource

public DocumentViewResource()

Method Detail

getAttachmentView

@GET
@Path("attachment/{id}")
@Produces("application/json")
public DocumentViewEntity getAttachmentView(@PathParam("id")
                                            String id,
                                            @QueryParam("lang")
                                            String language)

Gets the JSON representation of document view information. If it doesn't exist, a 404 HTTP code is returned. If the user isn't authentified, a 401 HTTP code is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.

Parameters:

id - the identifier of the JCR master node under which the document is handled.

language - the language used to select the content to view.

Returns:

the response to the HTTP GET request with the JSON representation of preview information.

asWebEntity

protected DocumentViewEntity asWebEntity(DocumentView documentView)

Converts the document view into its corresponding web entity.

Parameters:

documentView - the view to convert.

Returns:

the corresponding view entity.

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.

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.

validateUserAuthorization

public void validateUserAuthorization(UserPrivilegeValidation validation)

Description copied from interface: ProtectedWebResource

Validates the authorization of the user to request this web service. For doing, the user must have the rights to access the component instance that manages this web resource. If no such component instance exists, a Not Found HTTP error is thrown (status code 404). Otherwise the validation is delegated to the validation service by passing it the required information.

This method should be invoked for web service requiring an authorized access. For doing, the authentication of the user must be first valdiated. Otherwise, the annotation Authorized can be also used instead at class level for both authentication and authorization.

Parameters:

validation - the validation instance to use.

See Also:

UserPrivilegeValidator