org.jets3t.service.multithread
Class DownloadPackage

java.lang.Object
  org.jets3t.service.multithread.DownloadPackage

public class DownloadPackage

extends java.lang.Object

A simple container object to associate one of an S3Object or a signed URL string with an output file, to which the S3 object's data will be written.

This class is used by S3ServiceMulti.downloadObjects(org.jets3t.service.model.S3Bucket, DownloadPackage[]) to download objects.

Constructor Summary

DownloadPackage(S3Object object, java.io.File outputFile)

DownloadPackage(S3Object object, java.io.File outputFile, boolean isUnzipping, EncryptionUtil encryptionUtil)

DownloadPackage(java.lang.String signedUrl, java.io.File outputFile, boolean isUnzipping, EncryptionUtil encryptionUtil)

Method Summary

java.io.File	getDataFile()
S3Object	getObject()
java.io.OutputStream	getOutputStream() Creates an output stream to receive the object's data.
java.lang.String	getSignedUrl()
boolean	isAppendToFile()
boolean	isSignedDownload()
void	setAppendToFile(boolean appendToFile)
void	setSignedUrl(java.lang.String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadPackage

public DownloadPackage(S3Object object,
                       java.io.File outputFile)

DownloadPackage

public DownloadPackage(S3Object object,
                       java.io.File outputFile,
                       boolean isUnzipping,
                       EncryptionUtil encryptionUtil)

DownloadPackage

public DownloadPackage(java.lang.String signedUrl,
                       java.io.File outputFile,
                       boolean isUnzipping,
                       EncryptionUtil encryptionUtil)

Method Detail

getObject

public S3Object getObject()

getDataFile

public java.io.File getDataFile()

getSignedUrl

public java.lang.String getSignedUrl()

setSignedUrl

public void setSignedUrl(java.lang.String url)

isSignedDownload

public boolean isSignedDownload()

isAppendToFile

public boolean isAppendToFile()

setAppendToFile

public void setAppendToFile(boolean appendToFile)

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.lang.Exception

Creates an output stream to receive the object's data. The output stream is based on a FileOutputStream, but will also be wrapped in a GZipInflatingOutputStream if isUnzipping is true and/or a decrypting output stream if this package has an associated non-null EncryptionUtil.

Returns:

an output stream that writes data to the output file managed by this class.

Throws:

java.lang.Exception