org.silverpeas.look.web
Class DisplayResource

java.lang.Object
  com.silverpeas.web.RESTWebService
      org.silverpeas.look.web.AbstractLookResource
          org.silverpeas.look.web.DisplayResource

@Service
@RequestScoped
@Authenticated
public class DisplayResource
extends AbstractLookResource

A REST Web resource giving space data.

Author:

Yohann Chastagnier

Nested Class Summary

Nested classes/interfaces inherited from class com.silverpeas.web.RESTWebService

RESTWebService.WebProcess<RETURN_VALUE>, RESTWebService.WebTreatment<RETURN_VALUE>

Field Summary

Fields inherited from class com.silverpeas.web.RESTWebService

RESPONSE_HEADER_ARRAYSIZE, REST_WEB_SERVICES_URI_BASE

Constructor Summary

DisplayResource()

Method Summary

String	getComponentId() Gets the identifier of the component instance to which the requested resource belongs to.
DisplayUserContextEntity	getUserContext() Gets the JSON representation of the user display context.

Methods inherited from class org.silverpeas.look.web.AbstractLookResource

asWebEntity, getLookDelegate, isUserAuthorizedToAccessLookContext, verifyUserAuthorizedToAccessLookContext

Methods inherited from class com.silverpeas.web.RESTWebService

getBundle, getBundleLocation, getGreaterUserRole, getHttpRequest, getHttpServletRequest, getHttpServletResponse, getOrganisationController, getUriInfo, getUserDetail, getUserPreferences, getUserRoles, process, validateUserAuthentication, validateUserAuthorization

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DisplayResource

public DisplayResource()

Method Detail

getUserContext

public DisplayUserContextEntity getUserContext()

Gets the JSON representation of the user display context. If it doesn't exist, a 404 HTTP code is returned. If the user isn't authentified, a 401 HTTP code is returned. If the user isn't authorized to access the space, a 403 HTTP code is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.

Returns:

the response to the HTTP GET request with the JSON representation of display context.

getComponentId

public String getComponentId()

Description copied from class: RESTWebService

Gets the identifier of the component instance to which the requested resource belongs to.

Specified by:

getComponentId in class RESTWebService

Returns:

the identifier of the Silverpeas component instance.