Package org.silverpeas.core.webapi.variables

Class VariablesResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.variables.VariablesResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("variables")
@Authenticated
public class VariablesResource
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
VariablesResource()

Method Summary

Modifier and Type	Method	Description
VariableEntity	createVariable(VariableEntity entity)
VariableScheduledValueEntity	createVariableValue(String variableId, VariableScheduledValueEntity entity)
void	deleteVariable(String variableId)
void	deleteVariables()
void	deleteVariableValues(String variableId, String valueId)
List<VariableEntity>	getAllVariables()
String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.
List<VariableEntity>	getCurrentVariables()
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().
VariableEntity	getVariable(String variableId)
VariableEntity	updateVariable(String variableId, VariableEntity entity)
VariableScheduledValueEntity	updateVariableValue(String variableId, String valueId, VariableScheduledValueEntity entity)

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

VariablesResource

public VariablesResource()

Method Detail

getAllVariables

@GET
@Produces("application/json")
public List<VariableEntity> getAllVariables()

getCurrentVariables

@GET
@Path("/currents")
@Produces("application/json")
public List<VariableEntity> getCurrentVariables()

getVariable

@GET
@Path("/{variableId}")
@Produces("application/json")
public VariableEntity getVariable(@PathParam("variableId")
                                  String variableId)

createVariable

@POST
@Consumes("application/json")
@Produces("application/json")
public VariableEntity createVariable(VariableEntity entity)

updateVariable

@POST
@Path("/{variableId}")
@Consumes("application/json")
@Produces("application/json")
public VariableEntity updateVariable(@PathParam("variableId")
                                     String variableId,
                                     VariableEntity entity)

deleteVariable

@DELETE
@Path("/{variableId}")
@Produces("application/json")
public void deleteVariable(@PathParam("variableId")
                           String variableId)

deleteVariables

@DELETE
@Produces("application/json")
public void deleteVariables()

createVariableValue

@POST
@Path("/{variableId}/values")
@Consumes("application/json")
@Produces("application/json")
public VariableScheduledValueEntity createVariableValue(@PathParam("variableId")
                                                        String variableId,
                                                        VariableScheduledValueEntity entity)

updateVariableValue

@POST
@Path("/{variableId}/values/{valueId}")
@Consumes("application/json")
@Produces("application/json")
public VariableScheduledValueEntity updateVariableValue(@PathParam("variableId")
                                                        String variableId,
                                                        @PathParam("valueId")
                                                        String valueId,
                                                        VariableScheduledValueEntity entity)

deleteVariableValues

@DELETE
@Path("/{variableId}/values/{valueId}")
@Produces("application/json")
public void deleteVariableValues(@PathParam("variableId")
                                 String variableId,
                                 @PathParam("valueId")
                                 String valueId)

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.