com.communote.plugins.api.rest.v30.resource.attachment

Class AttachmentResourceHandler

java.lang.Object

com.communote.plugins.api.rest.v30.resource.AbstractResourceHandler<C,E,D,G,L>

com.communote.plugins.api.rest.v30.resource.DefaultResourceHandler<CreateAttachmentParameter,DefaultParameter,DeleteAttachmentParameter,GetAttachmentParameter,DefaultParameter>

com.communote.plugins.api.rest.v30.resource.attachment.AttachmentResourceHandler

public class AttachmentResourceHandler
extends DefaultResourceHandler<CreateAttachmentParameter,DefaultParameter,DeleteAttachmentParameter,GetAttachmentParameter,DefaultParameter>

A handler class to provide data for an image resource to the resource class. All the list parameter are collected in a parameter map.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
AttachmentResourceHandler()

Method Summary

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response	handleCreateInternally(CreateAttachmentParameter createParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) hook method, which should be implemented by subclasses, in order to perform actual resource creation
protected javax.ws.rs.core.Response	handleDeleteInternally(DeleteAttachmentParameter deleteParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) hook method, which should be implemented by subclasses, in order to perform actual resource removal
javax.ws.rs.core.Response	handleGetInternally(GetAttachmentParameter getAttachmentParameter, String requestedMimeType, javax.ws.rs.core.UriInfo uriInfo, String requestSessionId, javax.ws.rs.core.Request request) Returns an existing attachment of a given note.

Methods inherited from class com.communote.plugins.api.rest.v30.resource.DefaultResourceHandler

handleEditInternally, handleListInternally

Methods inherited from class com.communote.plugins.api.rest.v30.resource.AbstractResourceHandler

handleCreate, handleDelete, handleEdit, handleGet, handleList, setValidator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttachmentResourceHandler

public AttachmentResourceHandler()

Method Detail

handleCreateInternally

protected javax.ws.rs.core.Response handleCreateInternally(CreateAttachmentParameter createParameter,
                                                           String requestedMimeType,
                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                           String requestSessionId,
                                                           javax.ws.rs.core.Request request)
                                                    throws ParameterValidationException,
                                                           ResponseBuildException,
                                                           ExtensionNotSupportedException,
                                                           org.apache.commons.fileupload.FileUploadException,
                                                           IOException,
                                                           IllegalRequestParameterException,
                                                           AttachmentIsEmptyException,
                                                           AuthorizationException

Description copied from class: DefaultResourceHandler

hook method, which should be implemented by subclasses, in order to perform actual resource creation

Overrides:

handleCreateInternally in class DefaultResourceHandler<CreateAttachmentParameter,DefaultParameter,DeleteAttachmentParameter,GetAttachmentParameter,DefaultParameter>

Parameters:

createParameter - create parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

ParameterValidationException

ResponseBuildException

ExtensionNotSupportedException

org.apache.commons.fileupload.FileUploadException

IOException

IllegalRequestParameterException

AttachmentIsEmptyException

AuthorizationException

handleDeleteInternally

protected javax.ws.rs.core.Response handleDeleteInternally(DeleteAttachmentParameter deleteParameter,
                                                           String requestedMimeType,
                                                           javax.ws.rs.core.UriInfo uriInfo,
                                                           String requestSessionId,
                                                           javax.ws.rs.core.Request request)
                                                    throws Exception

Description copied from class: DefaultResourceHandler

hook method, which should be implemented by subclasses, in order to perform actual resource removal

Overrides:

handleDeleteInternally in class DefaultResourceHandler<CreateAttachmentParameter,DefaultParameter,DeleteAttachmentParameter,GetAttachmentParameter,DefaultParameter>

Parameters:

deleteParameter - delete parameter

requestedMimeType - mimeType

uriInfo - uri

requestSessionId - session id

request - request

Returns:

result of creation

Throws:

Exception - if anything goes wrong

handleGetInternally

public javax.ws.rs.core.Response handleGetInternally(GetAttachmentParameter getAttachmentParameter,
                                                     String requestedMimeType,
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     String requestSessionId,
                                                     javax.ws.rs.core.Request request)
                                              throws ResponseBuildException,
                                                     ExtensionNotSupportedException,
                                                     ContentRepositoryException,
                                                     AuthorizationException,
                                                     IOException,
                                                     NotFoundException

Returns an existing attachment of a given note.

Overrides:

handleGetInternally in class DefaultResourceHandler<CreateAttachmentParameter,DefaultParameter,DeleteAttachmentParameter,GetAttachmentParameter,DefaultParameter>

Parameters:

getAttachmentParameter - the parameters of the attachment

requestedMimeType - MIME type requested by client

uriInfo - additional information about request

requestSessionId - the session id

request - - javax request

Returns:

response for client

Throws:

ResponseBuildException - exception while building the response

ExtensionNotSupportedException - extension is not supported

AuthorizationException - user is not authorizated

ContentRepositoryException - internal exception.

IOException - exception while i/o operation.

NotFoundException - in case the attachment does not exist