Package org.silverpeas.core.webapi.viewer

Class DocumentViewResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.viewer.AbstractViewResource

org.silverpeas.core.webapi.viewer.DocumentViewResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("view")
@Authenticated
public class DocumentViewResource
extends AbstractViewResource

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	getDocumentView(String id, String type, String language)	Gets the JSON representation of document view information.
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().

Methods inherited from class org.silverpeas.core.webapi.viewer.AbstractViewResource

getAuthorizedResourceView, getComponentId

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

DocumentViewResource

public DocumentViewResource()

Method Detail

getDocumentView

@GET
@Path("{type}/{id}")
@Produces("application/json")
public DocumentViewEntity getDocumentView(@PathParam("id")
                                          String id,
                                          @PathParam("type")
                                          String type,
                                          @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 authenticated, 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 a resource handled into Silverpeas's context.

type - the type of the resource.

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

Returns:

the response to the HTTP GET request with the JSON representation of document view 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 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.