org.javaswift.joss.instructions

Class UploadPayloadInputStream

java.lang.Object

org.javaswift.joss.instructions.UploadPayload

org.javaswift.joss.instructions.UploadPayloadInputStream

public class UploadPayloadInputStream
extends UploadPayload

Constructor Summary

Constructors

Constructor and Description
UploadPayloadInputStream(java.io.InputStream inputStream)

Method Summary

Modifier and Type	Method and Description
org.apache.http.HttpEntity	getEntity() Returns the payload as an HttpEntity, so it can be uploaded to the ObjectStore
Etag	getEtag() Returns the MD5 hash value in an Etag header
SegmentationPlan	getSegmentationPlan(java.lang.Long segmentationSize) Sets up the plan to upload the payload in segments
boolean	mustBeSegmented(java.lang.Long segmentationSize) Checks whether the payload must be segmented into two or more separate objects to circumvent the max object size

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadPayloadInputStream

public UploadPayloadInputStream(java.io.InputStream inputStream)

Method Detail

getEntity

public org.apache.http.HttpEntity getEntity()

Description copied from class: UploadPayload

Returns the payload as an HttpEntity, so it can be uploaded to the ObjectStore

Specified by:

getEntity in class UploadPayload

Returns:

HttpEntity of the payload

mustBeSegmented

public boolean mustBeSegmented(java.lang.Long segmentationSize)

Description copied from class: UploadPayload

Checks whether the payload must be segmented into two or more separate objects to circumvent the max object size

Specified by:

mustBeSegmented in class UploadPayload

Parameters:

segmentationSize - size to check the current payload size against

Returns:

true if the payload must be segmented

getEtag

public Etag getEtag()
             throws java.io.IOException

Description copied from class: UploadPayload

Returns the MD5 hash value in an Etag header

Specified by:

getEtag in class UploadPayload

Returns:

Etag header with MD5 hash

Throws:

java.io.IOException - when DigestUtils.md5Hex fails

getSegmentationPlan

public SegmentationPlan getSegmentationPlan(java.lang.Long segmentationSize)
                                     throws java.io.IOException

Description copied from class: UploadPayload

Sets up the plan to upload the payload in segments

Specified by:

getSegmentationPlan in class UploadPayload

Parameters:

segmentationSize - the size of an individual segment

Returns:

the segmentation plan

Throws:

java.io.IOException - when the segmentation plan cannot be drawn up