Package org.silverpeas.core.webapi.rating

Class RatingResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.rating.RatingResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("rating/{componentId}/{contributionType}/{contributionId}")
@Authorized
public class RatingResource
extends RESTWebService

A REST Web resource representing a given rating. It is a web service that provides an access to a rating referenced by its URL.

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

Method Summary

Modifier and Type	Method	Description
protected RaterRatingEntity	asWebEntity(RaterRating raterRating)	Converts the rating into its corresponding web entity.
protected String	getBundleLocation()	Gets the location of the bundle to use.
String	getComponentId()	Gets the identifier of the component instance to which the requested resource belongs to.
RaterRatingEntity	getRaterRating()	Gets the JSON representation of the rating associated to defined content.
protected String	getResourceBasePath()	Gets the base path of the web resource relative to the root path of all the web resources in Silverpeas as given by SilverpeasWebResource.getBasePath().
javax.ws.rs.core.Response	saveRating(String note)

Methods inherited from class org.silverpeas.core.web.rs.RESTWebService

createWebResourceUri, fromPage, getBundle, 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

RatingResource

public RatingResource()

Method Detail

getBundleLocation

protected String getBundleLocation()

Description copied from class: RESTWebService

Gets the location of the bundle to use.

Overrides:

getBundleLocation in class RESTWebService

Returns:

the classpath location of the localization bundle used by this Web service.

getResourceBasePath

protected String getResourceBasePath()

Description copied from class: RESTWebService

Gets the base path of the web resource relative to the root path of all 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.

getRaterRating

@GET
@Produces("application/json")
public RaterRatingEntity getRaterRating()

Gets the JSON representation of the rating associated to defined content.

Returns:

the response to the HTTP GET request with the JSON representation of the rating.

saveRating

@POST
@Produces("application/json")
public javax.ws.rs.core.Response saveRating(String note)

asWebEntity

protected RaterRatingEntity asWebEntity(RaterRating raterRating)

Converts the rating into its corresponding web entity.

Parameters:

raterRating - the rater rating to convert.

Returns:

the corresponding rating entity.