Package org.silverpeas.core.webapi.attachment

Class SimpleDocumentListResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.attachment.AbstractSimpleDocumentResource

org.silverpeas.core.webapi.attachment.SimpleDocumentListResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("documents/{componentId}/resource/{id}")
@Authorized
public class SimpleDocumentListResource
extends AbstractSimpleDocumentResource

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

Method Summary

Modifier and Type	Method	Description
List<SimpleDocumentEntity>	getDocuments(String lang)	Returns documents of specified resource in the specified language
List<SimpleDocumentEntity>	getDocumentsByType(String type, String lang)	Returns documents of specified resource in the specified language
String	getResourceId()
void	validateUserAuthorization(UserPrivilegeValidation validation)	Validates the authorization of the user to request this web service.

Methods inherited from class org.silverpeas.core.webapi.attachment.AbstractSimpleDocumentResource

checkUploadedFile, getBundleLocation, getComponentId, getResourceBasePath, performRuntimeException

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

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

validateUserAuthentication

Constructor Detail

SimpleDocumentListResource

public SimpleDocumentListResource()

Method Detail

getResourceId

public String getResourceId()

getDocuments

@GET
@Path("{lang}")
@Produces("application/json")
public List<SimpleDocumentEntity> getDocuments(@PathParam("lang")
                                               String lang)

Returns documents of specified resource in the specified language

Parameters:

lang - the wanted language.

Returns:

documents of specified resource

getDocumentsByType

@GET
@Path("types/{type}/{lang}")
@Produces("application/json")
public List<SimpleDocumentEntity> getDocumentsByType(@PathParam("type")
                                                     String type,
                                                     @PathParam("lang")
                                                     String lang)

Returns documents of specified resource in the specified language

Parameters:

lang - the wanted language.

Returns:

documents of specified resource

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