Package org.silverpeas.core.webapi.admin

Class ComponentsResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.admin.AbstractAdminResource

org.silverpeas.core.webapi.admin.ComponentsResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("components")
@Authenticated
public class ComponentsResource
extends AbstractAdminResource

A REST Web resource giving components.

Author:

Nicolas EYSSERIC

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

Method Summary

Modifier and Type	Method	Description
String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.
Collection<ComponentEntity>	getComponentsByFilterOrParameterValue(String filter, String param, String value)	Gets the JSON representation of the existing ComponentInstLight known as "image banks".
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().
protected WebResourceUri	initWebResourceUri()	Default initialization of WebResourceUri instance for all WEB services extending RESTWebService class.

Methods inherited from class org.silverpeas.core.webapi.admin.AbstractAdminResource

asWebEntities, asWebEntities, asWebEntity, asWebEntity, asWebEntity, asWebEntity, asWebPersonalEntities, asWebPersonalEntity, asWebPersonalEntity, asWebPersonalEntity, getAdminPersonalDelegate, getAdminServices, getLookDelegate, isUserAuthorizedToAccessLookContext, loadComponent, loadComponents, loadSpace, loadSpaces, verifyUserAuthorizedToAccessLookContext, verifyUserAuthorizedToAccessSpace

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, 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

ComponentsResource

public ComponentsResource()

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

initWebResourceUri

protected WebResourceUri initWebResourceUri()

Description copied from class: RESTWebService

Default initialization of WebResourceUri instance for all WEB services extending RESTWebService class.

This method can be overrated in case the default initialization is not satisfying a right behavior.

In any case, the WebResourceUri is computed one time (and only one) per request and the result of computation is provided by RESTWebService.getUri() method.

Overrides:

initWebResourceUri in class RESTWebService

Returns:

a WebResourceUri instance.

getComponentsByFilterOrParameterValue

@GET
@Produces("application/json")
public Collection<ComponentEntity> getComponentsByFilterOrParameterValue(@QueryParam("filter")
                                                                         String filter,
                                                                         @QueryParam("param")
                                                                         String param,
                                                                         @QueryParam("value")
                                                                         String value)

Gets the JSON representation of the existing ComponentInstLight known as "image banks". If the user isn't authentified, a 401 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 the ComponentInstLight.

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.