Package org.silverpeas.core.webapi.attachment

Class SharedAttachmentResource

java.lang.Object

org.silverpeas.core.web.rs.RESTWebService

org.silverpeas.core.webapi.attachment.AbstractAttachmentResource

org.silverpeas.core.webapi.attachment.SharedAttachmentResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource

@WebService
@Path("sharing/attachments/{componentId}/{token}")
public class SharedAttachmentResource
extends AbstractAttachmentResource

A REST Web resource providing access to attachments through sharing mode.

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.webapi.attachment.AbstractAttachmentResource

componentId

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

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getFileContent(String attachmentId)
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().
protected String	getToken()
javax.ws.rs.core.Response	getZipContent(String zipFileName)
protected boolean	isFileReadable(SimpleDocument attachment)
ZipEntity	zipFiles(String attachmentIds)

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

getComponentId

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

Methods inherited from interface org.silverpeas.core.web.rs.WebAuthenticationValidation

validateUserAuthentication

Constructor Detail

SharedAttachmentResource

public SharedAttachmentResource()

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.

getFileContent

@GET
@Path("{id}/{name}")
@Produces("application/octet-stream")
public javax.ws.rs.core.Response getFileContent(@PathParam("id")
                                                String attachmentId)

Overrides:

getFileContent in class AbstractAttachmentResource

zipFiles

@GET
@Path("{ids}/zip")
@Produces("application/json")
public ZipEntity zipFiles(@PathParam("ids")
                          String attachmentIds)

getZipContent

@GET
@Path("zipcontent/{name}")
@Produces("application/octet-stream")
public javax.ws.rs.core.Response getZipContent(@PathParam("name")
                                               String zipFileName)

isFileReadable

protected boolean isFileReadable(SimpleDocument attachment)

Specified by:

isFileReadable in class AbstractAttachmentResource

getToken

protected String getToken()