com.spectralogic.ds3client

Interface Ds3Client

public interface Ds3Client

The main interface for communicating with a DS3 appliance. All communication with a DS3 appliance starts with this class. See Ds3ClientBuilder on what options can be used to create a Ds3Client instance.

Method Summary

Methods

Modifier and Type	Method and Description
AllocateJobChunkResponse	allocateJobChunk(AllocateJobChunkRequest request) Requests that the server allocate space for a given ChunkId in a BulkPutResponse.
BulkGetResponse	bulkGet(BulkGetRequest request) Primes the Ds3 appliance for a Bulk Get.
BulkPutResponse	bulkPut(BulkPutRequest request) Primes the Ds3 appliance for a Bulk Put.
CancelJobResponse	cancelJob(CancelJobRequest request) Cancels an in-progress job.
DeleteBucketResponse	deleteBucket(DeleteBucketRequest request) Deletes a bucket from a DS3 endpoint.
DeleteObjectResponse	deleteObject(DeleteObjectRequest request) Deletes an object in a bucket from a DS3 endpoint
GetAvailableJobChunksResponse	getAvailableJobChunks(GetAvailableJobChunksRequest request) Returns all of the chunks immediately available for get from the server for a given JobId in a BulkGetResponse.
GetBucketResponse	getBucket(GetBucketRequest request) Gets the list of objects in a bucket.
ConnectionDetails	getConnectionDetails()
GetJobResponse	getJob(GetJobRequest request) Returns details about a bulk job given a job id.
GetJobsResponse	getJobs(GetJobsRequest request) Returns all of the jobs currently on the black pearl.
GetObjectResponse	getObject(GetObjectRequest request) Retrieves an object from DS3
GetServiceResponse	getService(GetServiceRequest request) Gets the list of buckets.
HeadBucketResponse	headBucket(HeadBucketRequest request) Performs a HTTP HEAD for a bucket.
ModifyJobResponse	modifyJob(ModifyJobRequest request) Updates the last modified date of a job and returns the job details.
Ds3Client	newForNode(Node node) Creates a new Ds3Client instance for the system pointed to by Node.
PutBucketResponse	putBucket(PutBucketRequest request) Puts a new bucket to a DS3 endpoint
PutObjectResponse	putObject(PutObjectRequest request) Puts a new object to an existing bucket.

Method Detail

getConnectionDetails

ConnectionDetails getConnectionDetails()

getService

GetServiceResponse getService(GetServiceRequest request)
                              throws java.io.IOException,
                                     java.security.SignatureException

Gets the list of buckets.

Parameters:

request - The Service Request object used to customize the HTTP request, GetServiceRequest

Returns:

The response object contains the list of buckets that the user has access to.

Throws:

java.io.IOException

java.security.SignatureException

getBucket

GetBucketResponse getBucket(GetBucketRequest request)
                            throws java.io.IOException,
                                   java.security.SignatureException

Gets the list of objects in a bucket.

Parameters:

request - The Get Bucket Request object used to customize the HTTP request. The bucket request object has several options for customizing the request. See GetBucketRequest for the full list of options that can be configured.

Returns:

The response object contains the list of objects that a bucket contains. There is some additional information that is returned which is used for pagination, GetBucketResponse for the full list of properties that are returned.

Throws:

java.io.IOException

java.security.SignatureException

putBucket

PutBucketResponse putBucket(PutBucketRequest request)
                            throws java.io.IOException,
                                   java.security.SignatureException

Puts a new bucket to a DS3 endpoint

Parameters:

request - The Put Bucket Request object used to customize the HTTP request. The put bucket request object has some options for customizing the request. See PutBucketRequest for the full list of options that can be configured.

Returns:

The response object is returned primarily to be consistent with the rest of the API. Additional data may be returned here in the future but nothing is currently. See PutBucketResponse for the most up to date information on what is returned.

Throws:

java.io.IOException

java.security.SignatureException

headBucket

HeadBucketResponse headBucket(HeadBucketRequest request)
                              throws java.io.IOException,
                                     java.security.SignatureException

Performs a HTTP HEAD for a bucket. The HEAD will return information about if the bucket exists, or if the user has access to that bucket.

Parameters:

request - The Head Bucket Request object used to customize the HTTP request. See HeadBucketRequest.

Returns:

The response object is returned and contains the status of the bucket. See HeadBucketResponse for the full list of status that a bucket can be in.

Throws:

java.io.IOException

java.security.SignatureException

deleteBucket

DeleteBucketResponse deleteBucket(DeleteBucketRequest request)
                                  throws java.io.IOException,
                                         java.security.SignatureException

Deletes a bucket from a DS3 endpoint. Note: all objects must be deleted first before deleteBucket will succeed.

Parameters:

request - The Delete Bucket Request object used to customize the HTTP request. The delete bucket request object has some options for customizing the request. See DeleteBucketRequest for the full list of options that can be configured.

Returns:

The response object is returned primarily to be consistent with the rest of the API. Additional data may be returned here in the future but nothing is currently. See DeleteBucketResponse for the most up to date information on what is returned.

Throws:

java.io.IOException

java.security.SignatureException

deleteObject

DeleteObjectResponse deleteObject(DeleteObjectRequest request)
                                  throws java.io.IOException,
                                         java.security.SignatureException

Deletes an object in a bucket from a DS3 endpoint

Parameters:

request - The Put Bucket Request object used to customize the HTTP request. The put bucket request object has some options for customizing the request. See PutBucketRequest for the full list of options that can be configured.

Returns:

The response object is returned primarily to be consistent with the rest of the API. Additional data may be returned here in the future but nothing is currently. See DeleteObjectResponse for the most up to date information on what is returned.

Throws:

java.io.IOException

java.security.SignatureException

getObject

GetObjectResponse getObject(GetObjectRequest request)
                            throws java.io.IOException,
                                   java.security.SignatureException

Retrieves an object from DS3

Parameters:

request - The Get Object Request object used to customize the HTTP request. The get object request object has some options for customizing the request. See GetObjectRequest for the full list of options that can be configured.

Returns:

The response object contains a stream that can be used to read the contents of the object from. See GetObjectResponse for any other properties.

Throws:

java.io.IOException

java.security.SignatureException

putObject

PutObjectResponse putObject(PutObjectRequest request)
                            throws java.io.IOException,
                                   java.security.SignatureException

Puts a new object to an existing bucket. The call will fail if the bucket does not exist.

Parameters:

request - The Put Object Request object used to customize the HTTP request. The put object request object has some options for customizing the request. See PutObjectRequest for the full list of options that can be configured.

Returns:

The response object is returned primarily to be consistent with the rest of the API. Additional data may be returned here in the future but nothing is currently. See PutObjectResponse for the most up to date information on what is returned.

Throws:

java.io.IOException

java.security.SignatureException

bulkGet

BulkGetResponse bulkGet(BulkGetRequest request)
                        throws java.io.IOException,
                               java.security.SignatureException

Primes the Ds3 appliance for a Bulk Get. This does not perform the gets for each individual files. See getObject(GetObjectRequest) for performing the get.

Parameters:

request - The Bulk Get Request object used to customize the HTTP request. The bulk get request object has some options for customizing the request. See BulkGetRequest for the full list of options that can be configured.

Returns:

The response object contains a list of lists of files to get from the DS3 endpoint. Make sure that the files are gotten in the order specified in the response.

Throws:

java.io.IOException

java.security.SignatureException

bulkPut

BulkPutResponse bulkPut(BulkPutRequest request)
                        throws java.io.IOException,
                               java.security.SignatureException

Primes the Ds3 appliance for a Bulk Put. This does not perform the puts for each individual files. See putObject(PutObjectRequest) for performing the put.

Parameters:

request - The Bulk Put Request object used to customize the HTTP request. The bulk put request object has some options for customizing the request. See BulkPutRequest for the full list of options that can be configured.

Returns:

The response object contains a list of lists of files to put to the DS3 endpoint. Make sure that the files are put in the order specified in the response.

Throws:

java.io.IOException

java.security.SignatureException

allocateJobChunk

AllocateJobChunkResponse allocateJobChunk(AllocateJobChunkRequest request)
                                          throws java.io.IOException,
                                                 java.security.SignatureException

Requests that the server allocate space for a given ChunkId in a BulkPutResponse. For best performance, run this call before putting objects for an object list.

Returns:

Whether the server responded with allocated, retry later, or not found.

Throws:

java.io.IOException

java.security.SignatureException

getAvailableJobChunks

GetAvailableJobChunksResponse getAvailableJobChunks(GetAvailableJobChunksRequest request)
                                                    throws java.io.IOException,
                                                           java.security.SignatureException

Returns all of the chunks immediately available for get from the server for a given JobId in a BulkGetResponse.

Returns:

Whether the server responded with the available chunks, retry later, or not found.

Throws:

java.io.IOException

java.security.SignatureException

getJobs

GetJobsResponse getJobs(GetJobsRequest request)
                        throws java.io.IOException,
                               java.security.SignatureException

Returns all of the jobs currently on the black pearl.

Returns:

A list of jobs.

Throws:

java.io.IOException

java.security.SignatureException

getJob

GetJobResponse getJob(GetJobRequest request)
                      throws java.io.IOException,
                             java.security.SignatureException

Returns details about a bulk job given a job id.

Returns:

A master object list.

Throws:

java.io.IOException

java.security.SignatureException

cancelJob

CancelJobResponse cancelJob(CancelJobRequest request)
                            throws java.io.IOException,
                                   java.security.SignatureException

Cancels an in-progress job.

Throws:

java.io.IOException

java.security.SignatureException

modifyJob

ModifyJobResponse modifyJob(ModifyJobRequest request)
                            throws java.io.IOException,
                                   java.security.SignatureException

Updates the last modified date of a job and returns the job details.

Returns:

A master object list.

Throws:

java.io.IOException

java.security.SignatureException

newForNode

Ds3Client newForNode(Node node)

Creates a new Ds3Client instance for the system pointed to by Node.