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

Class AttachmentResourceHelper

java.lang.Object

com.communote.plugins.api.rest.v22.resource.attachment.AttachmentResourceHelper

public final class AttachmentResourceHelper
extends Object

Helper for AttachmentResourceHandler

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	MULTIPART_FORM_DATA Form type multipart/form-data.

Method Summary

Modifier and Type	Method and Description
static void	assertAttachmentSize(String contentType, Long fileSize, boolean isBase64) Check attachment size and throw MaxLengthReachedException
static AttachmentResource	buildAttachmentResource(AttachmentData attachment) Converts a list item describing an attachment into an attachment resource
static AttachmentResource	buildAttachmentResource(AttachmentTO attachment) Builds an attachment resource for REST-API out of the core attachment.
static AttachmentResource[]	buildAttachmentResources(Collection<AttachmentData> attachments) Converts a collection of attachment list items into an array of attachment resources
static void	checkAttachmentUploadSessionId(String attachmentUploadSessionId) Check for attachmentUploadSessionId Parameter and throw ParameterValidationException
static javax.ws.rs.core.Response	getAttachmentAsBinary(AttachmentTO attachment) Builds a byte array response of a given attachment.
static ResourceStoringManagement	getResourceStoringManagement() Get the resource storing management.

Methods inherited from class java.lang.Object

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

Field Detail

MULTIPART_FORM_DATA

public static final String MULTIPART_FORM_DATA

Form type multipart/form-data.

Method Detail

assertAttachmentSize

public static void assertAttachmentSize(String contentType,
                                        Long fileSize,
                                        boolean isBase64)
                                 throws MaxLengthReachedException

Check attachment size and throw MaxLengthReachedException

Parameters:

contentType - type of content

fileSize - size of file

isBase64 - is file encoded

Throws:

MaxLengthReachedException - exception for file is to large

buildAttachmentResource

public static AttachmentResource buildAttachmentResource(AttachmentData attachment)

Converts a list item describing an attachment into an attachment resource

Parameters:

attachment - a list item to convert

Returns:

the created resource

buildAttachmentResource

public static AttachmentResource buildAttachmentResource(AttachmentTO attachment)

Builds an attachment resource for REST-API out of the core attachment.

Parameters:

attachment - the attachment of the core

Returns:

attachment resource for REST-API

buildAttachmentResources

public static AttachmentResource[] buildAttachmentResources(Collection<AttachmentData> attachments)

Converts a collection of attachment list items into an array of attachment resources

Parameters:

attachments - the list items to convert, can be null which will result in an empty array

Returns:

the converted resources

checkAttachmentUploadSessionId

public static void checkAttachmentUploadSessionId(String attachmentUploadSessionId)
                                           throws ParameterValidationException

Check for attachmentUploadSessionId Parameter and throw ParameterValidationException

Parameters:

attachmentUploadSessionId - identifier of attribute in session

Throws:

ParameterValidationException - attachmentUploadSessionId was not set

getAttachmentAsBinary

public static javax.ws.rs.core.Response getAttachmentAsBinary(AttachmentTO attachment)
                                                       throws IOException

Builds a byte array response of a given attachment.

Parameters:

attachment - attachment to be responded

Returns:

response containing the attachment as binary

Throws:

IOException - if streaming of the attachment failed.

getResourceStoringManagement

public static ResourceStoringManagement getResourceStoringManagement()

Get the resource storing management.

Returns:

resource storing management