EmbedMediaPlayerResource (Silverpeas Core 6.4 API)

java.lang.Object
- org.silverpeas.core.web.rs.RESTWebService
- - org.silverpeas.core.webapi.media.EmbedMediaPlayerResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource
```
@WebService
@Path("media/player/embed")
public class EmbedMediaPlayerResource
extends RESTWebService
```
A common service to play video or sound (for now) with an embed player.

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

EmbedMediaPlayerResource()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getComponentId()`	Gets the identifier of the component instance to which the requested resource belongs to.
`org.jboss.resteasy.plugins.providers.html.View`	`getEmbedContent()`	Gets a view on the content with the embed media player.
`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
  - EmbedMediaPlayerResource
```
public EmbedMediaPlayerResource()
```
- 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.
  - getEmbedContent
```
@GET
public org.jboss.resteasy.plugins.providers.html.View getEmbedContent()
```
    Gets a view on the content with the embed media player.
    
    Returns:
    
    a descriptor of the renderer to use to display the media content.
  - 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.