Package org.silverpeas.core.webapi.media

Class EmbedMediaViewerResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.media.EmbedMediaViewerResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("media/viewer/embed")
@Authenticated
public class EmbedMediaViewerResource
extends RESTWebService

A common service to view resources with an embed viewer.

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

Method Summary

Modifier and Type	Method	Description
String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.
javax.ws.rs.core.Response	getFlowPaperContent(String documentId, String documentType, String language, String page)	Gets the content of the swf.
org.jboss.resteasy.plugins.providers.html.View	getFlowPaperEmbedViewer(String documentId, String documentType, String language)	Gets a view on the content with the embed flowpaper viewer.
javax.ws.rs.core.Response	getPdfContent(String documentId, String documentType, String language)	Gets the content of the pdf.
org.jboss.resteasy.plugins.providers.html.View	getPdfEmbedViewer(String documentId, String documentType, String language)	Gets a view on the content with the embed pdf viewer.
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.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

EmbedMediaViewerResource

public EmbedMediaViewerResource()

Method Detail

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.

getPdfEmbedViewer

@GET
@Path("pdf")
public org.jboss.resteasy.plugins.providers.html.View getPdfEmbedViewer(@QueryParam("documentId")
                                                                        String documentId,
                                                                        @QueryParam("documentType")
                                                                        String documentType,
                                                                        @QueryParam("language")
                                                                        String language)

Gets a view on the content with the embed pdf viewer.

Returns:

a descriptor of the renderer to use to view the document.

getPdfContent

@GET
@Path("pdf/content")
public javax.ws.rs.core.Response getPdfContent(@QueryParam("documentId")
                                               String documentId,
                                               @QueryParam("documentType")
                                               String documentType,
                                               @QueryParam("language")
                                               String language)

Gets the content of the pdf. The player URI MUST have be accessed before accessing this one.

getFlowPaperEmbedViewer

@GET
@Path("fp")
public org.jboss.resteasy.plugins.providers.html.View getFlowPaperEmbedViewer(@QueryParam("documentId")
                                                                              String documentId,
                                                                              @QueryParam("documentType")
                                                                              String documentType,
                                                                              @QueryParam("language")
                                                                              String language)

Gets a view on the content with the embed flowpaper viewer.

Returns:

a descriptor of the renderer to use to view the document.

getFlowPaperContent

@GET
@Path("fp/content/{documentId}/{language}/{page}")
public javax.ws.rs.core.Response getFlowPaperContent(@PathParam("documentId")
                                                     String documentId,
                                                     @QueryParam("documentType")
                                                     String documentType,
                                                     @PathParam("language")
                                                     String language,
                                                     @PathParam("page")
                                                     String page)

Gets the content of the swf. The player URI MUST have be accessed before accessing this one.

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.