Package org.silverpeas.core.webapi.thesaurus

Class ThesaurusResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.thesaurus.ThesaurusResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("thesaurus")
@Authorized
public class ThesaurusResource
extends RESTWebService

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

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().
void	setSynonyms(String vocabularyId, String axisId, String valueId, Set<String> synonyms)
void	validateUserAuthorization(UserPrivilegeValidation validation)	Validates the authorization of the user to request this web service.

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

validateUserAuthentication

Constructor Detail

ThesaurusResource

public ThesaurusResource()

Method Detail

validateUserAuthorization

public void validateUserAuthorization(UserPrivilegeValidation validation)

Description copied from interface: ProtectedWebResource

Validates the authorization of the user to request this web service. For doing, the user must have the rights to access the component instance that manages this web resource. If no such component instance exists, a Not Found HTTP error is thrown (status code 404). Otherwise the validation is delegated to the validation service by passing it the required information.

This method should be invoked for web service requiring an authorized access. For doing, the authentication of the user must be first valdiated. Otherwise, the annotation Authorized can be also used instead at class level for both authentication and authorization.

Parameters:

validation - the validation instance to use.

See Also:

UserPrivilegeValidator

setSynonyms

@POST
@Path("/vocabulary/{vocabularyId}/axis/{axisId}/values/{valueId}/synonyms")
@Produces("application/json")
public void setSynonyms(@PathParam("vocabularyId")
                        String vocabularyId,
                        @PathParam("axisId")
                        String axisId,
                        @PathParam("valueId")
                        String valueId,
                        @FormParam("synonym")
                        Set<String> synonyms)

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.

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.