org.javaswift.joss.instructions

Class UploadInstructions

java.lang.Object

org.javaswift.joss.instructions.UploadInstructions

public class UploadInstructions
extends java.lang.Object

Specific instructions for uploading files. You can control the following aspects:

• md5 (aka etag); the hash of the file, which is useful when uploading from an InputStream, since it is not possible (desirable) to calculate a new MD5
• contentType; if you know better what content type the file is then the file extension matcher or content-sniffers, use this
• deleteAfter; order a file to be deleted after a certain number of seconds
• deleteAt; order a file to be deleted at a specific date
• objectManifest; if the file is to be a manifest for a number of segmented file that together comprise a single large file, use this
• segmentationSize; supply a custom segmentation size which determines how large a single segment can be

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Long	MAX_SEGMENTATION_SIZE Maximum segmentation size allowed by the ObjectStore.

Constructor Summary

Constructors

Constructor and Description
UploadInstructions(byte[] fileToUpload)
UploadInstructions(java.io.File fileToUpload)
UploadInstructions(java.io.InputStream inputStream)
UploadInstructions(java.io.InputStream inputStream, long length)
UploadInstructions(UploadPayload uploadPayload)

Method Summary

Modifier and Type	Method and Description
UploadInstructions	addHeader(Header header)
ObjectContentType	getContentType()
DeleteAfter	getDeleteAfter()
DeleteAt	getDeleteAt()
org.apache.http.HttpEntity	getEntity()
Etag	getEtag()
java.util.Map<java.lang.String,Header>	getHeaders()
java.lang.String	getMd5()
ObjectManifest	getObjectManifest()
SegmentationPlan	getSegmentationPlan() Facade method for determining the segmentation plan of the payload on the basis of the known segmentation size.
java.lang.Long	getSegmentationSize()
boolean	requiresSegmentation() Facade method for checking out the payload to see if must be segmented.
UploadInstructions	setContentType(ObjectContentType contentType)
UploadInstructions	setContentType(java.lang.String contentType)
UploadInstructions	setDeleteAfter(DeleteAfter deleteAfter)
UploadInstructions	setDeleteAt(DeleteAt deleteAt)
UploadInstructions	setMd5(java.lang.String md5)
UploadInstructions	setObjectManifest(ObjectManifest objectManifest)
UploadInstructions	setSegmentationSize(java.lang.Long segmentationSize)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SEGMENTATION_SIZE

public static java.lang.Long MAX_SEGMENTATION_SIZE

Maximum segmentation size allowed by the ObjectStore.

Constructor Detail

UploadInstructions

public UploadInstructions(UploadPayload uploadPayload)

UploadInstructions

public UploadInstructions(java.io.File fileToUpload)

UploadInstructions

public UploadInstructions(java.io.InputStream inputStream)

UploadInstructions

public UploadInstructions(byte[] fileToUpload)

UploadInstructions

public UploadInstructions(java.io.InputStream inputStream,
                          long length)

Method Detail

requiresSegmentation

public boolean requiresSegmentation()

Facade method for checking out the payload to see if must be segmented. Used internally.

Returns:

true if segmentation is required

getSegmentationPlan

public SegmentationPlan getSegmentationPlan()

Facade method for determining the segmentation plan of the payload on the basis of the known segmentation size. Used internally.

Returns:

full-fledged segmentation plan

setObjectManifest

public UploadInstructions setObjectManifest(ObjectManifest objectManifest)

setMd5

public UploadInstructions setMd5(java.lang.String md5)

setContentType

public UploadInstructions setContentType(java.lang.String contentType)

setContentType

public UploadInstructions setContentType(ObjectContentType contentType)

setDeleteAfter

public UploadInstructions setDeleteAfter(DeleteAfter deleteAfter)

setDeleteAt

public UploadInstructions setDeleteAt(DeleteAt deleteAt)

setSegmentationSize

public UploadInstructions setSegmentationSize(java.lang.Long segmentationSize)

getEntity

public org.apache.http.HttpEntity getEntity()

getSegmentationSize

public java.lang.Long getSegmentationSize()

getMd5

public java.lang.String getMd5()

getEtag

public Etag getEtag()
             throws java.io.IOException

Throws:

java.io.IOException

getObjectManifest

public ObjectManifest getObjectManifest()

getContentType

public ObjectContentType getContentType()

getDeleteAt

public DeleteAt getDeleteAt()

getDeleteAfter

public DeleteAfter getDeleteAfter()

addHeader

public UploadInstructions addHeader(Header header)

getHeaders

public java.util.Map<java.lang.String,Header> getHeaders()