com.dslplatform.storage

Class S3

java.lang.Object

com.dslplatform.storage.S3

All Implemented Interfaces:

java.io.Serializable

public class S3
extends java.lang.Object
implements java.io.Serializable

Data structure for working with S3 binaries. Instead of storing binaries in the database, S3 can be used to store bucket and key in the database which point to the binary on remote server.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
S3() Create new instance of S3.
S3(byte[] bytes) Create new instance of S3 from provided byte array.
S3(java.io.InputStream stream) Create new instance of S3 from provided stream.
S3(java.io.InputStream stream, long length) Create new instance of S3 from provided stream.
S3(S3Repository repository) Create new instance of S3.
S3(ServiceLocator locator, java.lang.String bucket, java.lang.String key, long length, java.lang.String name, java.lang.String mimeType, java.util.Map<java.lang.String,java.lang.String> metadata)
S3(java.lang.String key)
S3(java.lang.String bucket, java.lang.String key)

Method Summary

Modifier and Type	Method and Description
void	delete() Remote data from the remote S3 server.
java.lang.String	getBucket() Bucket under which data will be saved.
byte[]	getBytes() Get bytes saved on the remote server.
byte[]	getContent() Get bytes saved on the remote server.
java.lang.String	getKey() Key for bucket in which the data was saved.
long	getLength() Byte length of data.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() For convenience, various metadata can be associated with the remote data.
java.lang.String	getMimeType() For convenience, remote data can be assigned a mime type.
java.lang.String	getName() For convenience, remote data can be assigned a name.
java.io.InputStream	getStream() Get stream saved on the remote server.
java.lang.String	getURI()
S3	setMimeType(java.lang.String value) For convenience, remote data can be assigned a mime type.
S3	setName(java.lang.String value) For convenience, remote data can be assigned a name.
java.lang.String	upload(byte[] bytes) Upload provided bytes to remote S3 server.
java.lang.String	upload(java.io.ByteArrayInputStream stream) Upload provided stream to remote S3 server.
java.lang.String	upload(java.io.InputStream stream, long length) Upload provided stream to remote S3 server.
java.lang.String	upload(java.lang.String bucket, byte[] bytes) Upload provided bytes to remote S3 server.
java.lang.String	upload(java.lang.String bucket, java.io.InputStream stream, long length) Upload provided stream to remote S3 server.

Methods inherited from class java.lang.Object

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

Constructor Detail

S3

public S3()

Create new instance of S3. Upload must be called before persistence to the database.

S3

public S3(S3Repository repository)

Create new instance of S3. Provide custom S3 repository. Upload must be called before persistence to the database.

Parameters:

repository - custom S3 repository

S3

public S3(java.io.InputStream stream)
   throws java.io.IOException

Create new instance of S3 from provided stream. Upload will be called immediately. Stream will be read to check for length.

Parameters:

stream - Input stream which will be sent to the remote server

Throws:

java.io.IOException

S3

public S3(java.lang.String key)
   throws java.io.IOException

Throws:

java.io.IOException

S3

public S3(java.lang.String bucket,
          java.lang.String key)
   throws java.io.IOException

Throws:

java.io.IOException

S3

public S3(java.io.InputStream stream,
          long length)
   throws java.io.IOException

Create new instance of S3 from provided stream. Upload will be called immediately.

Parameters:

stream - Input stream which will be sent to the remote server

length - size of the stream

Throws:

java.io.IOException

S3

public S3(byte[] bytes)
   throws java.io.IOException

Create new instance of S3 from provided byte array. Upload will be called immediately.

Parameters:

bytes - Byte array which will be sent to the remote server

Throws:

java.io.IOException

S3

public S3(ServiceLocator locator,
          java.lang.String bucket,
          java.lang.String key,
          long length,
          java.lang.String name,
          java.lang.String mimeType,
          java.util.Map<java.lang.String,java.lang.String> metadata)

Method Detail

getBucket

public java.lang.String getBucket()

Bucket under which data will be saved. By default bucket is defined in the dsl-project.properties file under s3-bucket key

Returns:

bucket to remote server

getKey

public java.lang.String getKey()

Key for bucket in which the data was saved.

Returns:

key in bucket on the remote server

getURI

public java.lang.String getURI()

getLength

public long getLength()

Byte length of data.

Returns:

number of bytes

getName

public java.lang.String getName()

For convenience, remote data can be assigned a name.

Returns:

name associated with the remote data

setName

public S3 setName(java.lang.String value)

For convenience, remote data can be assigned a name.

Parameters:

value - name which will be associated with data

Returns:

itself

getMimeType

public java.lang.String getMimeType()

For convenience, remote data can be assigned a mime type.

Returns:

mime type associated with the remote data

setMimeType

public S3 setMimeType(java.lang.String value)

For convenience, remote data can be assigned a mime type.

Parameters:

value - mime type which will be associated with data

Returns:

itself

getMetadata

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

For convenience, various metadata can be associated with the remote data. Metadata is a map of string keys and values

Returns:

associated metadata

getContent

public byte[] getContent()
                  throws java.io.IOException

Get bytes saved on the remote server. Data will be cached, so subsequent request will reuse downloaded bytes.

Returns:

bytes saved on the remote server

Throws:

java.io.IOException - in case of communication failure

getStream

public java.io.InputStream getStream()
                              throws java.io.IOException

Get stream saved on the remote server. Data will not be cached, so subsequent request will download stream again.

Returns:

stream saved on the remote server

Throws:

java.io.IOException - in case of communication failure

getBytes

public byte[] getBytes()
                throws java.io.IOException

Get bytes saved on the remote server. Data will not be cached, so subsequent request will download bytes again.

Returns:

bytes saved on the remote server

Throws:

java.io.IOException - in case of communication failure

upload

public java.lang.String upload(java.io.ByteArrayInputStream stream)
                        throws java.io.IOException

Upload provided stream to remote S3 server. If key is already defined, this stream will overwrite remote stream, otherwise new key will be created.

Parameters:

stream - upload provided stream

Returns:

key under which data was saved

Throws:

java.io.IOException - in case of communication error

upload

public java.lang.String upload(java.io.InputStream stream,
                               long length)
                        throws java.io.IOException

Upload provided stream to remote S3 server. If key is already defined, this stream will overwrite remote stream, otherwise new key will be created.

Parameters:

stream - upload provided stream

length - size of provided stream

Returns:

key under which data was saved

Throws:

java.io.IOException - in case of communication error

upload

public java.lang.String upload(java.lang.String bucket,
                               java.io.InputStream stream,
                               long length)
                        throws java.io.IOException

Upload provided stream to remote S3 server. If key is already defined, this stream will overwrite remote stream, otherwise new key will be created. If key was already defined, bucket name can't be changed.

Parameters:

bucket - bucket under data will be saved

stream - upload provided stream

length - size of provided stream

Returns:

key under which data was saved

Throws:

java.io.IOException - in case of communication error

upload

public java.lang.String upload(byte[] bytes)
                        throws java.io.IOException

Upload provided bytes to remote S3 server. If key is already defined, this bytes will overwrite remote bytes, otherwise new key will be created.

Parameters:

bytes - upload provided bytes

Returns:

key under which data was saved

Throws:

java.io.IOException - in case of communication error

upload

public java.lang.String upload(java.lang.String bucket,
                               byte[] bytes)
                        throws java.io.IOException

Upload provided bytes to remote S3 server. If key is already defined, this bytes will overwrite remote bytes, otherwise new key will be created. If key was already defined, bucket name can't be changed.

Parameters:

bucket - bucket under data will be saved

bytes - upload provided bytes

Returns:

key under which data was saved

Throws:

java.io.IOException - in case of communication error

delete

public void delete()
            throws java.io.IOException

Remote data from the remote S3 server.

Throws:

java.io.IOException - in case of communication error