S3Link (AWS SDK for Android

java.lang.Object
- com.amazonaws.mobileconnectors.dynamodbv2.dynamodbmapper.S3Link

public class S3Link
extends java.lang.Object

An S3 Link that works with DynamoDBMapper. An S3 link is persisted as a JSON string in DynamoDB. This link object can be used directly to upload/download files to S3. Alternatively, the underlying AmazonS3Client can be retrieved to provide full access API to S3.

For example:

 AWSCredentialsProvider s3CredentialProvider = ...;
 DynamoDBMapper mapper = new DynamoDBMapper(..., s3CredentialProvider);
 String username = "jamestkirk";

 User user = new User();
 user.setUsername(username);

 // S3 region can be specified, but is optional
 S3Link s3link = mapper.createS3Link("my-company-user-avatars", username + ".jpg");
 user.setAvatar(s3link);

 // All meta information of the S3 resource is persisted in DynamoDB, including
 // region, bucket, and key
 mapper.save(user);

 // Upload file to S3 with the link saved in DynamoDB
 s3link.uploadFrom(new File("/path/to/all/those/user/avatars/" + username + ".jpg"));
 // Download file from S3 via an S3Link
 s3link.downloadTo(new File("/path/to/downloads/" + username + ".jpg"));

 // Full S3 API is available via the canonical AmazonS3Client API.
 // For example:
 AmazonS3Client s3 = s3link.getAmazonS3Client();
 // etc.

The User pojo class used above:

 @DynamoDBTable(tableName = "user-table")
 public class User {
     private String username;
     private S3Link avatar;

     @DynamoDBHashKey
     public String getUsername() {
         return username;
     }

     public void setUsername(String username) {
         this.username = username;
     }

     public S3Link getAvatar() {
         return avatar;
     }

     public void setAvatar(S3Link avatar) {
         this.avatar = avatar;
     }
 }

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectMetadata`	`downloadTo(java.io.File destination)` Convenient method to synchronously download to the specified file from the S3 object represented by this S3Link.
`ObjectMetadata`	`downloadTo(java.io.File destination, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)` Same as `downloadTo(File)` but allows specifying a request metric collector.
`ObjectMetadata`	`downloadTo(java.io.OutputStream output)` Downloads the data from the object represented by this S3Link to the specified output stream.
`ObjectMetadata`	`downloadTo(java.io.OutputStream output, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)` Same as `downloadTo(OutputStream)` but allows specifying a request metric collector.
`static S3Link`	`fromJson(S3ClientCache s3cc, java.lang.String json)` Deserializes from a JSON string.
`AmazonS3Client`	`getAmazonS3Client()`
`java.lang.String`	`getBucketName()` Gets the name of the bucket containing the object to be downloaded.
`java.lang.String`	`getKey()` Gets the key under which the object to be downloaded is stored.
`Region`	`getS3Region()`
`java.net.URL`	`getUrl()` Returns a URL for the location of the object represented by this S3Link.
`void`	`setAcl(AccessControlList acl)` Sets the access control list for the object represented by this S3Link.
`void`	`setAcl(AccessControlList acl, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)` Same as `setAcl(AccessControlList)` but allows specifying a request metric collector.
`void`	`setAcl(CannedAccessControlList acl)` Sets the access control list for the object represented by this S3Link.
`void`	`setAcl(CannedAccessControlList acl, com.amazonaws.metrics.RequestMetricCollector col)` Sets the access control list for the object represented by this S3Link.
`java.lang.String`	`toJson()` Serializes into a JSON string.
`PutObjectResult`	`uploadFrom(byte[] buffer)` Convenience method to synchronously upload from the given buffer to the Amazon S3 object represented by this S3Link.
`PutObjectResult`	`uploadFrom(byte[] buffer, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)` Same as `uploadFrom(byte[])` but allows specifying a request metric collector.
`PutObjectResult`	`uploadFrom(java.io.File source)` Convenience method to synchronously upload from the given file to the Amazon S3 object represented by this S3Link.
`PutObjectResult`	`uploadFrom(java.io.File source, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)` Same as `uploadFrom(File)` but allows specifying a request metric collector.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getKey
```
public java.lang.String getKey()
```
    Gets the key under which the object to be downloaded is stored.
    
    Returns:
    
    The key under which the object to be downloaded is stored.
  - getBucketName
```
public java.lang.String getBucketName()
```
    Gets the name of the bucket containing the object to be downloaded.
    
    Returns:
    
    The name of the bucket containing the object to be downloaded.
  - getS3Region
```
public Region getS3Region()
```
  - toJson
```
public java.lang.String toJson()
```
    Serializes into a JSON string.
    
    Returns:
    
    The string representation of the link to the S3 resource.
  - fromJson
```
public static S3Link fromJson(S3ClientCache s3cc,
                              java.lang.String json)
```
    Deserializes from a JSON string.
    
    Parameters:
    
    s3cc - the s3 client cache S3ClientCache
    
    json - the json representation of the s3 link.
    
    Returns:
    
    an instance of S3Link
  - getAmazonS3Client
```
public AmazonS3Client getAmazonS3Client()
```
  - uploadFrom
```
public PutObjectResult uploadFrom(java.io.File source)
```
    Convenience method to synchronously upload from the given file to the Amazon S3 object represented by this S3Link.
    
    Parameters:
    
    source - source file to upload from
    
    Returns:
    
    A PutObjectResult object containing the information returned by Amazon S3 for the newly created object.
  - uploadFrom
```
public PutObjectResult uploadFrom(java.io.File source,
                                  com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
```
    Same as uploadFrom(File) but allows specifying a request metric collector.
    
    Parameters:
    
    source - the file to upload from.
    
    requestMetricCollector - the request metric collector.
    
    Returns:
    
    instance of PutObjectRequest
  - uploadFrom
```
public PutObjectResult uploadFrom(byte[] buffer)
```
    Convenience method to synchronously upload from the given buffer to the Amazon S3 object represented by this S3Link.
    
    Parameters:
    
    buffer - The buffer containing the data to upload.
    
    Returns:
    
    A PutObjectResult object containing the information returned by Amazon S3 for the newly created object.
  - uploadFrom
```
public PutObjectResult uploadFrom(byte[] buffer,
                                  com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
```
    Same as uploadFrom(byte[]) but allows specifying a request metric collector.
    
    Parameters:
    
    buffer - the byte buffer.
    
    requestMetricCollector - the request metrics collector.
    
    Returns:
    
    an instance of PutObjectResult
  - setAcl
```
public void setAcl(CannedAccessControlList acl)
```
    Sets the access control list for the object represented by this S3Link. Note: Executing this method requires that the object already exists in Amazon S3.
    
    Parameters:
    
    acl - The access control list describing the new permissions for the object represented by this S3Link.
  - setAcl
```
public void setAcl(CannedAccessControlList acl,
                   com.amazonaws.metrics.RequestMetricCollector col)
```
    Sets the access control list for the object represented by this S3Link. Note: Executing this method requires that the object already exists in Amazon S3.
    
    Parameters:
    
    acl - The access control list describing the new permissions for the object represented by this S3Link.
    
    col - the request metrics collector.
  - setAcl
```
public void setAcl(AccessControlList acl)
```
    Sets the access control list for the object represented by this S3Link. Note: Executing this method requires that the object already exists in Amazon S3.
    
    Parameters:
    
    acl - The access control list describing the new permissions for the object represented by this S3Link.
  - setAcl
```
public void setAcl(AccessControlList acl,
                   com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
```
    Same as setAcl(AccessControlList) but allows specifying a request metric collector.
    
    Parameters:
    
    acl - an access control list.
    
    requestMetricCollector - the request metrics collector.
  - getUrl
```
public java.net.URL getUrl()
```
    Returns a URL for the location of the object represented by this S3Link.
    If the object represented by this S3Link has public read permissions (ex: CannedAccessControlList.PublicRead), then this URL can be directly accessed to retrieve the object data.
    
    Returns:
    
    A URL for the location of the object represented by this S3Link.
  - downloadTo
```
public ObjectMetadata downloadTo(java.io.File destination)
```
    Convenient method to synchronously download to the specified file from the S3 object represented by this S3Link.
    
    Parameters:
    
    destination - destination file to download to
    
    Returns:
    
    All S3 object metadata for the specified object. Returns null if constraints were specified but not met.
  - downloadTo
```
public ObjectMetadata downloadTo(java.io.File destination,
                                 com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
```
    Same as downloadTo(File) but allows specifying a request metric collector.
    
    Parameters:
    
    destination - the file to download to.
    
    requestMetricCollector - the request metrics collector.
    
    Returns:
    
    an instance of ObjectMetadata
  - downloadTo
```
public ObjectMetadata downloadTo(java.io.OutputStream output)
```
    Downloads the data from the object represented by this S3Link to the specified output stream.
    
    Parameters:
    
    output - The output stream to write the object's data to.
    
    Returns:
    
    The object's metadata.
  - downloadTo
```
public ObjectMetadata downloadTo(java.io.OutputStream output,
                                 com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
```
    Same as downloadTo(OutputStream) but allows specifying a request metric collector.
    
    Parameters:
    
    output - the outputstream to downloadto.
    
    requestMetricCollector - the request metrics collector.
    
    Returns:
    
    an instance of ObjectMetadata

Class S3Link

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getKey

getBucketName

getS3Region

toJson

fromJson

getAmazonS3Client

uploadFrom

uploadFrom

uploadFrom

uploadFrom

setAcl

setAcl

setAcl

setAcl

getUrl

downloadTo

downloadTo

downloadTo

downloadTo