AttachmentResource (Silverpeas Core 6.4 API)

java.lang.Object
- org.silverpeas.core.web.rs.RESTWebService
- - org.silverpeas.core.webapi.attachment.AbstractAttachmentResource
  - - org.silverpeas.core.webapi.attachment.AttachmentResource

All Implemented Interfaces:

ProtectedWebResource, WebAuthenticationValidation, WebAuthorizationValidation, SilverpeasWebResource
```
@WebService
@Path("private/attachments/{componentId}")
@Authorized
public class AttachmentResource
extends AbstractAttachmentResource
```
A REST Web resource providing access to attachments through private 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

AttachmentResource()

Method Summary

All Methods Instance Methods Concrete Methods
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 boolean`	`isFileReadable(SimpleDocument attachment)`

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
  - AttachmentResource
```
public AttachmentResource()
```
- 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
  - isFileReadable
```
protected boolean isFileReadable(SimpleDocument attachment)
```
    Specified by:
    
    isFileReadable in class AbstractAttachmentResource