Package org.silverpeas.core.webapi.notification

Class MessageResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.notification.AbstractMessageResource

org.silverpeas.core.webapi.notification.MessageResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("messages")
@Authenticated
public class MessageResource
extends AbstractMessageResource

A REST Web resource giving gallery data.

Author:

Yohann Chastagnier

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

Method Summary

Modifier and Type	Method	Description
MessageContainerEntity	getMessageContainer(String registredKey)	Gets the JSON representation of message container.
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().
void	validateUserAuthentication(UserPrivilegeValidation validation)	User authentication is not necessary for this WEB Service.

Methods inherited from class org.silverpeas.core.webapi.notification.AbstractMessageResource

asWebEntity, getComponentId, getLanguage

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

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

Constructor Detail

MessageResource

public MessageResource()

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

validateUserAuthentication

public void validateUserAuthentication(UserPrivilegeValidation validation)
                                throws javax.ws.rs.WebApplicationException

User authentication is not necessary for this WEB Service. The authentication processing is used here to identify the user behind the call if possible.

Parameters:

validation - the validation instance to use.

Throws:

javax.ws.rs.WebApplicationException

See Also:

UserPrivilegeValidator

getMessageContainer

@GET
@Path("{registredKey}")
@Produces("application/json")
public MessageContainerEntity getMessageContainer(@PathParam("registredKey")
                                                  String registredKey)

Gets the JSON representation of message container. If it doesn't exist, a 404 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 asked photo.