Package org.silverpeas.core.webapi.wysiwyg

Class WysiwygEditorConfigResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.wysiwyg.WysiwygEditorConfigResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("wysiwyg/editor/{componentInstanceId}")
@Authorized
public class WysiwygEditorConfigResource
extends RESTWebService

A REST Web resource which permits to obtain volatile identifier scoped into a component instance.
Please consult VolatileResourceCacheService.

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

Method Summary

Modifier and Type	Method	Description
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().
javax.ws.rs.core.Response	getWysiwygEditorConfig(String resourceType, String resourceId)	Gets the wysiwyg editor configuration according to the component instance identifier included into the path URI and the optional configuration name.

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

validateUserAuthorization

Methods inherited from interface org.silverpeas.core.web.rs.WebAuthenticationValidation

validateUserAuthentication

Constructor Detail

WysiwygEditorConfigResource

public WysiwygEditorConfigResource()

Method Detail

getWysiwygEditorConfig

@GET
@Path("{resourceType}/{resourceId}")
@Produces("application/json")
public javax.ws.rs.core.Response getWysiwygEditorConfig(@PathParam("resourceType")
                                                        String resourceType,
                                                        @PathParam("resourceId")
                                                        String resourceId)

Gets the wysiwyg editor configuration according to the component instance identifier included into the path URI and the optional configuration name.

Returns:

the response to the HTTP GET request with the JSON representation of the asked calendars.

See Also:

RESTWebService.WebProcess.execute()

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.

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.