com.emc.vipr.services.s3

Interface ViPRS3

All Known Implementing Classes:

ViPRS3Client

public interface ViPRS3

This interface contains the ViPR extensions above and beyond standard S3 functionality. This includes object update, object append, and file access (e.g. NFS).

Method Summary

Methods

Modifier and Type	Method and Description
AppendObjectResult	appendObject(AppendObjectRequest request) Appends to an existing object.
AppendObjectResult	appendObject(java.lang.String bucketName, java.lang.String key, java.io.File file) Appends to an existing object.
AppendObjectResult	appendObject(java.lang.String bucketName, java.lang.String key, java.io.InputStream input, com.amazonaws.services.s3.model.ObjectMetadata metadata) Appends to an existing object.
BucketFileAccessModeResult	getBucketFileAccessMode(java.lang.String bucketName) Checks the current file access mode on a bucket.
GetFileAccessResult	getFileAccess(GetFileAccessRequest request) Gets file access information for the keys in a bucket.
ListDataNodesResult	listDataNodes(ListDataNodesRequest request) Lists all active ViPR data services nodes (hosts) in the ViPR cluster.
BucketFileAccessModeResult	setBucketFileAccessMode(SetBucketFileAccessModeRequest request) Initiates a set file access mode request on a bucket.
UpdateObjectResult	updateObject(java.lang.String bucketName, java.lang.String key, java.io.File file, long startOffset) Updates an existing object.
UpdateObjectResult	updateObject(java.lang.String bucketName, java.lang.String key, java.io.InputStream input, com.amazonaws.services.s3.model.ObjectMetadata metadata, long startOffset) Updates an existing object.
UpdateObjectResult	updateObject(UpdateObjectRequest request) Updates an existing object.

Method Detail

updateObject

UpdateObjectResult updateObject(java.lang.String bucketName,
                              java.lang.String key,
                              java.io.File file,
                              long startOffset)
                                throws com.amazonaws.AmazonClientException

Updates an existing object. The given file will be overlaid on the existing object starting at startOffset.

Parameters:

bucketName - The name of an existing bucket, to which you have Permission.Write permission.

key - The key in the bucket to update.

file - The file containing the data to use for the update.

startOffset - The starting offset within the object to apply the update.

Returns:

A UpdateObjectResult containing the data returned from ViPR.

Throws:

com.amazonaws.AmazonClientException - If any errors are encountered in the client while making the request or handling the response.

com.amazonaws.AmazonServiceException - If any errors occurred in on the server while processing the request.

updateObject

UpdateObjectResult updateObject(java.lang.String bucketName,
                              java.lang.String key,
                              java.io.InputStream input,
                              com.amazonaws.services.s3.model.ObjectMetadata metadata,
                              long startOffset)
                                throws com.amazonaws.AmazonClientException

Updates an existing object. The given stream will be overlaid on the existing object starting at startOffset.

Parameters:

bucketName - The name of an existing bucket, to which you have Permission.Write permission.

key - The key in the bucket to update.

input - The input stream containing the data to be uploaded.

metadata - Additional metadata for the upload. Generally, the most important property here is the Content-Length of the input stream. If you do not size the input stream, the client will be forced to buffer the entire stream into memory and size it before uploading. This can lead to OutOfMemoryErrors.

startOffset - The starting offset within the object to apply the update.

Returns:

A UpdateObjectResult containing the data returned from ViPR.

Throws:

com.amazonaws.AmazonClientException - If any errors are encountered in the client while making the request or handling the response.

com.amazonaws.AmazonServiceException - If any errors occurred in on the server while processing the request.

updateObject

UpdateObjectResult updateObject(UpdateObjectRequest request)
                                throws com.amazonaws.AmazonClientException

Updates an existing object. The given data will be overlaid on the existing object starting at startOffset.

Parameters:

request - The configured UpdateObjectRequest to execute.

Returns:

A UpdateObjectResult containing the data returned from ViPR.

Throws:

com.amazonaws.AmazonClientException - If any errors are encountered in the client while making the request or handling the response.

com.amazonaws.AmazonServiceException - If any errors occurred in on the server while processing the request.

appendObject

AppendObjectResult appendObject(java.lang.String bucketName,
                              java.lang.String key,
                              java.io.File file)
                                throws com.amazonaws.AmazonClientException

Appends to an existing object. The given file will be appended to the end of the object. Note that multiple append requests may be executed concurrently and will be executed serially. Therefore, you must check the actual append offset in the response, see AppendObjectResult.getAppendOffset(). If you must append at an exact location, use updateObject but note in that case with concurrent writes, the last writer will "win".

Parameters:

bucketName - The name of an existing bucket, to which you have Permission.Write permission.

key - The key in the bucket to append to.

file - The file containing the data to use for the append.

Returns:

A AppendObjectResult containing the data returned from ViPR including the actual append offset.

Throws:

com.amazonaws.AmazonClientException - If any errors are encountered in the client while making the request or handling the response.

com.amazonaws.AmazonServiceException - If any errors occurred in on the server while processing the request.

appendObject

AppendObjectResult appendObject(java.lang.String bucketName,
                              java.lang.String key,
                              java.io.InputStream input,
                              com.amazonaws.services.s3.model.ObjectMetadata metadata)
                                throws com.amazonaws.AmazonClientException

Appends to an existing object. The given stream will be appended to the end of the object. Note that multiple append requests may be executed concurrently and will be executed serially. Therefore, you must check the actual append offset in the response, see AppendObjectResult.getAppendOffset(). If you must append at an exact location, use updateObject but note in that case with concurrent writes, the last writer will "win".

Parameters:

bucketName - The name of an existing bucket, to which you have Permission.Write permission.

key - The key in the bucket to append to.

input - The input stream containing the data to be appended.

metadata - Additional metadata for the upload. Generally, the most important property here is the Content-Length of the input stream. If you do not size the input stream, the client will be forced to buffer the entire stream into memory and size it before sending. This can lead to OutOfMemoryErrors.

Returns:

A AppendObjectResult containing the data returned from ViPR including the actual append offset.

Throws:

com.amazonaws.AmazonClientException - If any errors are encountered in the client while making the request or handling the response.

com.amazonaws.AmazonServiceException - If any errors occurred in on the server while processing the request.

appendObject

AppendObjectResult appendObject(AppendObjectRequest request)
                                throws com.amazonaws.AmazonClientException

Appends to an existing object. The given data will be appended to the end of the object. Note that multiple append requests may be executed concurrently and will be executed serially. Therefore, you must check the actual append offset in the response, see AppendObjectResult.getAppendOffset(). If you must append at an exact location, use updateObject but note in that case with concurrent writes, the last writer will "win".

Parameters:

request - the configured AppendObjectRequest to execute.

Returns:

A AppendObjectResult containing the data returned from ViPR including the actual append offset.

Throws:

com.amazonaws.AmazonClientException - If any errors are encountered in the client while making the request or handling the response.

com.amazonaws.AmazonServiceException - If any errors occurred in on the server while processing the request.

setBucketFileAccessMode

BucketFileAccessModeResult setBucketFileAccessMode(SetBucketFileAccessModeRequest request)
                                                   throws com.amazonaws.AmazonClientException

Initiates a set file access mode request on a bucket.

Parameters:

request - The configured SetBucketFileAccessModeRequest request to execute.

Returns:

A BucketFileAccessModeResult containing the results of the access mode change.

Throws:

com.amazonaws.AmazonClientException - If any errors are encountered in the client while making the request or handling the response.

com.amazonaws.AmazonServiceException - If any errors occurred in on the server while processing the request. Generally, this will happen if the given transition is not valid.

getBucketFileAccessMode

BucketFileAccessModeResult getBucketFileAccessMode(java.lang.String bucketName)
                                                   throws com.amazonaws.AmazonClientException

Checks the current file access mode on a bucket.

Parameters:

bucketName - the name of the bucket to check.

Returns:

a BucketFileAccessModeResult object containing the current file access mode for the bucket.

Throws:

com.amazonaws.AmazonClientException - If any errors are encountered in the client while making the request or handling the response.

com.amazonaws.AmazonServiceException - If any errors occurred in on the server while processing the request.

getFileAccess

GetFileAccessResult getFileAccess(GetFileAccessRequest request)
                                  throws com.amazonaws.AmazonClientException

Gets file access information for the keys in a bucket. This includes the current state of the key and the location on the file server to access the object. Note that this request is paginated so be sure to check the results to see if there are more results with GetFileAccessResult.isTruncated().

Parameters:

request - the configured GetFileAccessRequest request to execute.

Returns:

a GetFileAccessResult object containing the object file access information.

Throws:

com.amazonaws.AmazonClientException - If any errors are encountered in the client while making the request or handling the response.

com.amazonaws.AmazonServiceException - If any errors occurred in on the server while processing the request.

listDataNodes

ListDataNodesResult listDataNodes(ListDataNodesRequest request)
                                  throws com.amazonaws.AmazonClientException

Lists all active ViPR data services nodes (hosts) in the ViPR cluster. Useful for load balancing.

Parameters:

request - the configured ListDataNodesRequest request to execute.

Returns:

a ListDataNodesResult object containing the list of data services endpoints (hosts).

Throws:

com.amazonaws.AmazonClientException - If any errors are encountered in the client while making the request or handling the response.

com.amazonaws.AmazonServiceException - If any errors occurred in on the server while processing the request.