com.amazonaws.services.importexport.AmazonImportExportClient Maven / Gradle / Ivy
/*
* Copyright 2010-2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.importexport;
import org.w3c.dom.Node;
import java.util.ArrayList;
import java.util.List;
import java.util.Map.Entry;
import java.security.SignatureException;
import com.amazonaws.*;
import com.amazonaws.auth.AWSCredentials;
import com.amazonaws.auth.AWS3Signer;
import com.amazonaws.auth.QueryStringSigner;
import com.amazonaws.handlers.HandlerChainFactory;
import com.amazonaws.handlers.RequestHandler;
import com.amazonaws.http.StaxResponseHandler;
import com.amazonaws.http.DefaultErrorResponseHandler;
import com.amazonaws.http.HttpClient;
import com.amazonaws.http.HttpMethodName;
import com.amazonaws.http.HttpRequest;
import com.amazonaws.transform.Unmarshaller;
import com.amazonaws.transform.StaxUnmarshallerContext;
import com.amazonaws.transform.StandardErrorUnmarshaller;
import com.amazonaws.services.importexport.model.*;
import com.amazonaws.services.importexport.model.transform.*;
/**
* Client for accessing AmazonImportExport. All service calls made
* using this client are blocking, and will not return until the service call
* completes.
*
* AWS Import/Export Service
* AWS Import/Export accelerates transferring large amounts of data
* between the AWS cloud and portable storage devices that you mail to
* us. AWS Import/Export transfers data directly onto and off of your
* storage devices using Amazon's high-speed internal network and
* bypassing the Internet. For large data sets, AWS Import/Export is
* often faster than Internet transfer and more cost effective than
* upgrading your connectivity.
*
*/
public class AmazonImportExportClient extends AmazonWebServiceClient implements AmazonImportExport {
/**
* The AWS credentials (access key ID and secret key) to use when
* authenticating with AWS services.
*/
private AWSCredentials awsCredentials;
/**
* List of exception unmarshallers for all AmazonImportExport exceptions.
*/
protected final List> exceptionUnmarshallers;
/** Low level client for sending requests to AWS services. */
protected final HttpClient client;
/** Optional request handlers for additional request processing. */
private List requestHandlers = new ArrayList();
/** AWS signer for authenticating requests. */
private QueryStringSigner signer;
/**
* Constructs a new client to invoke service methods on
* AmazonImportExport using the specified AWS account credentials.
*
*
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentials The AWS credentials (access key ID and secret key) to use
* when authenticating with AWS services.
*/
public AmazonImportExportClient(AWSCredentials awsCredentials) {
this(awsCredentials, new ClientConfiguration());
}
/**
* Constructs a new client to invoke service methods on
* AmazonImportExport using the specified AWS account credentials
* and client configuration options.
*
*
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentials The AWS credentials (access key ID and secret key) to use
* when authenticating with AWS services.
* @param clientConfiguration The client configuration options controlling how this
* client connects to AmazonImportExport
* (ex: proxy settings, retry counts, etc.).
*/
public AmazonImportExportClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) {
super(clientConfiguration);
this.awsCredentials = awsCredentials;
exceptionUnmarshallers = new ArrayList>();
exceptionUnmarshallers.add(new BucketPermissionExceptionUnmarshaller());
exceptionUnmarshallers.add(new InvalidFileSystemExceptionUnmarshaller());
exceptionUnmarshallers.add(new MissingCustomsExceptionUnmarshaller());
exceptionUnmarshallers.add(new ExpiredJobIdExceptionUnmarshaller());
exceptionUnmarshallers.add(new InvalidManifestFieldExceptionUnmarshaller());
exceptionUnmarshallers.add(new MissingManifestFieldExceptionUnmarshaller());
exceptionUnmarshallers.add(new MalformedManifestExceptionUnmarshaller());
exceptionUnmarshallers.add(new InvalidAddressExceptionUnmarshaller());
exceptionUnmarshallers.add(new InvalidParameterExceptionUnmarshaller());
exceptionUnmarshallers.add(new MultipleRegionsExceptionUnmarshaller());
exceptionUnmarshallers.add(new UnableToCancelJobIdExceptionUnmarshaller());
exceptionUnmarshallers.add(new CanceledJobIdExceptionUnmarshaller());
exceptionUnmarshallers.add(new InvalidJobIdExceptionUnmarshaller());
exceptionUnmarshallers.add(new NoSuchBucketExceptionUnmarshaller());
exceptionUnmarshallers.add(new InvalidAccessKeyIdExceptionUnmarshaller());
exceptionUnmarshallers.add(new MissingParameterExceptionUnmarshaller());
exceptionUnmarshallers.add(new InvalidCustomsExceptionUnmarshaller());
exceptionUnmarshallers.add(new StandardErrorUnmarshaller());
setEndpoint("importexport.amazonaws.com");
signer = new QueryStringSigner(awsCredentials);
requestHandlers = new HandlerChainFactory().newRequestHandlerChain(
"/com/amazonaws/services/importexport/request.handlers");
client = new HttpClient(clientConfiguration);
}
/**
*
* This operation initiates the process of scheduling an upload or
* download of your data. You include in the request a manifest that
* describes the data transfer specifics. The response to the request
* includes a job ID, which you can use in other operations, a signature
* that you use to identify your storage device, and the address where
* you should ship your storage device.
*
*
* @param createJobRequest Container for the necessary parameters to
* execute the CreateJob service method on AmazonImportExport.
*
* @return The response from the CreateJob service method, as returned by
* AmazonImportExport.
*
* @throws MalformedManifestException
* @throws InvalidAddressException
* @throws BucketPermissionException
* @throws InvalidParameterException
* @throws MultipleRegionsException
* @throws MissingParameterException
* @throws InvalidFileSystemException
* @throws MissingCustomsException
* @throws NoSuchBucketException
* @throws InvalidAccessKeyIdException
* @throws InvalidManifestFieldException
* @throws InvalidCustomsException
* @throws MissingManifestFieldException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonImportExport indicating
* either a problem with the data in the request, or a server side issue.
*/
public CreateJobResult createJob(CreateJobRequest createJobRequest)
throws AmazonServiceException, AmazonClientException {
Request request = new CreateJobRequestMarshaller().marshall(createJobRequest);
return invoke(request, new CreateJobResultStaxUnmarshaller());
}
/**
*
* This operation cancels a specified job. Only the job owner can cancel
* it. The operation fails if the job has already started or is complete.
*
*
* @param cancelJobRequest Container for the necessary parameters to
* execute the CancelJob service method on AmazonImportExport.
*
* @return The response from the CancelJob service method, as returned by
* AmazonImportExport.
*
* @throws CanceledJobIdException
* @throws ExpiredJobIdException
* @throws InvalidAccessKeyIdException
* @throws InvalidJobIdException
* @throws UnableToCancelJobIdException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonImportExport indicating
* either a problem with the data in the request, or a server side issue.
*/
public CancelJobResult cancelJob(CancelJobRequest cancelJobRequest)
throws AmazonServiceException, AmazonClientException {
Request request = new CancelJobRequestMarshaller().marshall(cancelJobRequest);
return invoke(request, new CancelJobResultStaxUnmarshaller());
}
/**
*
* This operation returns information about a job, including where the
* job is in the processing pipeline, the status of the results, and the
* signature value associated with the job. You can only return
* information about jobs you own.
*
*
* @param getStatusRequest Container for the necessary parameters to
* execute the GetStatus service method on AmazonImportExport.
*
* @return The response from the GetStatus service method, as returned by
* AmazonImportExport.
*
* @throws CanceledJobIdException
* @throws ExpiredJobIdException
* @throws InvalidAccessKeyIdException
* @throws InvalidJobIdException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonImportExport indicating
* either a problem with the data in the request, or a server side issue.
*/
public GetStatusResult getStatus(GetStatusRequest getStatusRequest)
throws AmazonServiceException, AmazonClientException {
Request request = new GetStatusRequestMarshaller().marshall(getStatusRequest);
return invoke(request, new GetStatusResultStaxUnmarshaller());
}
/**
*
* This operation returns the jobs associated with the requester. AWS
* Import/Export lists the jobs in reverse chronological order based on
* the date of creation. For example if Job Test1 was created 2009Dec30
* and Test2 was created 2010Feb05, the ListJobs operation would return
* Test2 followed by Test1.
*
*
* @param listJobsRequest Container for the necessary parameters to
* execute the ListJobs service method on AmazonImportExport.
*
* @return The response from the ListJobs service method, as returned by
* AmazonImportExport.
*
* @throws InvalidParameterException
* @throws InvalidAccessKeyIdException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonImportExport indicating
* either a problem with the data in the request, or a server side issue.
*/
public ListJobsResult listJobs(ListJobsRequest listJobsRequest)
throws AmazonServiceException, AmazonClientException {
Request request = new ListJobsRequestMarshaller().marshall(listJobsRequest);
return invoke(request, new ListJobsResultStaxUnmarshaller());
}
/**
*
* You use this operation to change the parameters specified in the
* original manifest file by supplying a new manifest file. The manifest
* file attached to this request replaces the original manifest file. You
* can only use the operation after a CreateJob request but before the
* data transfer starts and you can only use it on jobs you own.
*
*
* @param updateJobRequest Container for the necessary parameters to
* execute the UpdateJob service method on AmazonImportExport.
*
* @return The response from the UpdateJob service method, as returned by
* AmazonImportExport.
*
* @throws MalformedManifestException
* @throws BucketPermissionException
* @throws InvalidAddressException
* @throws InvalidParameterException
* @throws MultipleRegionsException
* @throws MissingParameterException
* @throws InvalidFileSystemException
* @throws CanceledJobIdException
* @throws MissingCustomsException
* @throws NoSuchBucketException
* @throws ExpiredJobIdException
* @throws InvalidAccessKeyIdException
* @throws InvalidCustomsException
* @throws InvalidManifestFieldException
* @throws MissingManifestFieldException
* @throws InvalidJobIdException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonImportExport indicating
* either a problem with the data in the request, or a server side issue.
*/
public UpdateJobResult updateJob(UpdateJobRequest updateJobRequest)
throws AmazonServiceException, AmazonClientException {
Request request = new UpdateJobRequestMarshaller().marshall(updateJobRequest);
return invoke(request, new UpdateJobResultStaxUnmarshaller());
}
/**
*
* This operation returns the jobs associated with the requester. AWS
* Import/Export lists the jobs in reverse chronological order based on
* the date of creation. For example if Job Test1 was created 2009Dec30
* and Test2 was created 2010Feb05, the ListJobs operation would return
* Test2 followed by Test1.
*
*
* @return The response from the ListJobs service method, as returned by
* AmazonImportExport.
*
* @throws InvalidParameterException
* @throws InvalidAccessKeyIdException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AmazonImportExport indicating
* either a problem with the data in the request, or a server side issue.
*/
public ListJobsResult listJobs() throws AmazonServiceException, AmazonClientException {
return listJobs(new ListJobsRequest());
}
/**
* Returns additional metadata for a previously executed successful, request, typically used for
* debugging issues where a service isn't acting as expected. This data isn't considered part
* of the result data returned by an operation, so it's available through this separate,
* diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access
* this extra diagnostic information for an executed request, you should use this method
* to retrieve it as soon as possible after executing the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
private X invoke(Request request, Unmarshaller unmarshaller) {
request.setEndpoint(endpoint);
for (Entry entry : request.getOriginalRequest().copyPrivateRequestParameters().entrySet()) {
request.addParameter(entry.getKey(), entry.getValue());
}
// Apply any additional service specific request handlers that need to be run
if (requestHandlers != null) {
for (RequestHandler requestHandler : requestHandlers) {
request = requestHandler.handleRequest(request);
}
}
try {
signer.sign(request);
} catch (SignatureException e) {
throw new AmazonServiceException("Unable to sign request", e);
}
HttpRequest httpRequest = convertToHttpRequest(request, HttpMethodName.POST);
StaxResponseHandler responseHandler = new StaxResponseHandler(unmarshaller);
DefaultErrorResponseHandler errorResponseHandler = new DefaultErrorResponseHandler(exceptionUnmarshallers);
return (X)client.execute(httpRequest, responseHandler, errorResponseHandler);
}
}