com.amazonaws.services.cloudsearchdomain.AmazonCloudSearchDomainClient Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudsearch Show documentation
/*
* Copyright 2010-2015 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.cloudsearchdomain;
import java.io.*;
import java.net.*;
import java.util.*;
import org.apache.commons.logging.*;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.auth.*;
import com.amazonaws.handlers.*;
import com.amazonaws.http.*;
import com.amazonaws.regions.*;
import com.amazonaws.internal.*;
import com.amazonaws.metrics.*;
import com.amazonaws.transform.*;
import com.amazonaws.util.*;
import com.amazonaws.util.AWSRequestMetrics.Field;
import com.amazonaws.util.json.*;
import com.amazonaws.services.cloudsearchdomain.model.*;
import com.amazonaws.services.cloudsearchdomain.model.transform.*;
/**
* Client for accessing AmazonCloudSearchDomain. All service calls made
* using this client are blocking, and will not return until the service call
* completes.
*
*
* You use the AmazonCloudSearch2013 API to upload documents to a search
* domain and search those documents.
*
*
* The endpoints for submitting UploadDocuments ,
* Search , and Suggest
* requests are domain-specific. To get the endpoints for your domain,
* use the Amazon CloudSearch configuration service
* DescribeDomains action. The domain endpoints are also
* displayed on the domain dashboard in the Amazon CloudSearch console.
* You submit suggest requests to the search endpoint.
*
*
* For more information, see the
* Amazon CloudSearch Developer Guide
* .
*
*/
public class AmazonCloudSearchDomainClient extends AmazonWebServiceClient implements AmazonCloudSearchDomain {
/** Provider for AWS credentials. */
private AWSCredentialsProvider awsCredentialsProvider;
private static final Log log = LogFactory.getLog(AmazonCloudSearchDomain.class);
/**
* List of exception unmarshallers for all AmazonCloudSearchDomain exceptions.
*/
protected List jsonErrorUnmarshallers;
/**
* Constructs a new client to invoke service methods on
* AmazonCloudSearchDomain. A credentials provider chain will be used
* that searches for credentials in this order:
*
* - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
* - Java System Properties - aws.accessKeyId and aws.secretKey
* - Instance profile credentials delivered through the Amazon EC2 metadata service
*
*
*
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @see DefaultAWSCredentialsProviderChain
*/
public AmazonCloudSearchDomainClient() {
this(new DefaultAWSCredentialsProviderChain(), new ClientConfiguration());
}
/**
* Constructs a new client to invoke service methods on
* AmazonCloudSearchDomain. A credentials provider chain will be used
* that searches for credentials in this order:
*
* - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
* - Java System Properties - aws.accessKeyId and aws.secretKey
* - Instance profile credentials delivered through the Amazon EC2 metadata service
*
*
*
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param clientConfiguration The client configuration options controlling how this
* client connects to AmazonCloudSearchDomain
* (ex: proxy settings, retry counts, etc.).
*
* @see DefaultAWSCredentialsProviderChain
*/
public AmazonCloudSearchDomainClient(ClientConfiguration clientConfiguration) {
this(new DefaultAWSCredentialsProviderChain(), clientConfiguration);
}
/**
* Constructs a new client to invoke service methods on
* AmazonCloudSearchDomain 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 AmazonCloudSearchDomainClient(AWSCredentials awsCredentials) {
this(awsCredentials, new ClientConfiguration());
}
/**
* Constructs a new client to invoke service methods on
* AmazonCloudSearchDomain 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 AmazonCloudSearchDomain
* (ex: proxy settings, retry counts, etc.).
*/
public AmazonCloudSearchDomainClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) {
super(adjustClientConfiguration(clientConfiguration));
this.awsCredentialsProvider = new StaticCredentialsProvider(awsCredentials);
init();
}
/**
* Constructs a new client to invoke service methods on
* AmazonCloudSearchDomain using the specified AWS account credentials provider.
*
*
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials
* to authenticate requests with AWS services.
*/
public AmazonCloudSearchDomainClient(AWSCredentialsProvider awsCredentialsProvider) {
this(awsCredentialsProvider, new ClientConfiguration());
}
/**
* Constructs a new client to invoke service methods on
* AmazonCloudSearchDomain using the specified AWS account credentials
* provider 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 awsCredentialsProvider
* The AWS credentials provider which will provide credentials
* to authenticate requests with AWS services.
* @param clientConfiguration The client configuration options controlling how this
* client connects to AmazonCloudSearchDomain
* (ex: proxy settings, retry counts, etc.).
*/
public AmazonCloudSearchDomainClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) {
this(awsCredentialsProvider, clientConfiguration, null);
}
/**
* Constructs a new client to invoke service methods on
* AmazonCloudSearchDomain using the specified AWS account credentials
* provider, client configuration options and request metric collector.
*
*
* All service calls made using this new client object are blocking, and will not
* return until the service call completes.
*
* @param awsCredentialsProvider
* The AWS credentials provider which will provide credentials
* to authenticate requests with AWS services.
* @param clientConfiguration The client configuration options controlling how this
* client connects to AmazonCloudSearchDomain
* (ex: proxy settings, retry counts, etc.).
* @param requestMetricCollector optional request metric collector
*/
public AmazonCloudSearchDomainClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector) {
super(adjustClientConfiguration(clientConfiguration), requestMetricCollector);
this.awsCredentialsProvider = awsCredentialsProvider;
init();
}
private void init() {
jsonErrorUnmarshallers = new ArrayList();
jsonErrorUnmarshallers.add(new DocumentServiceExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new SearchExceptionUnmarshaller());
jsonErrorUnmarshallers.add(new JsonErrorUnmarshaller());
HandlerChainFactory chainFactory = new HandlerChainFactory();
requestHandler2s.addAll(chainFactory.newRequestHandlerChain(
"/com/amazonaws/services/cloudsearchdomain/request.handlers"));
requestHandler2s.addAll(chainFactory.newRequestHandler2Chain(
"/com/amazonaws/services/cloudsearchdomain/request.handler2s"));
}
private static ClientConfiguration adjustClientConfiguration(ClientConfiguration orig) {
ClientConfiguration config = orig;
return config;
}
/**
*
* Posts a batch of documents to a search domain for indexing. A
* document batch is a collection of add and delete operations that
* represent the documents you want to add, update, or delete from your
* domain. Batches can be described in either JSON or XML. Each item that
* you want Amazon CloudSearch to return as a search result (such as a
* product) is represented as a document. Every document has a unique ID
* and one or more fields that contain the data that you want to search
* and return in results. Individual documents cannot contain more than
* 1 MB of data. The entire batch cannot exceed 5 MB. To get the best
* possible upload performance, group add and delete operations in
* batches that are close the 5 MB limit. Submitting a large volume of
* single-document batches can overload a domain's document service.
*
*
* The endpoint for submitting UploadDocuments requests is
* domain-specific. To get the document endpoint for your domain, use the
* Amazon CloudSearch configuration service DescribeDomains
* action. A domain's endpoints are also displayed on the domain
* dashboard in the Amazon CloudSearch console.
*
*
* For more information about formatting your data for Amazon
* CloudSearch, see
* Preparing Your Data in the Amazon CloudSearch Developer Guide . For more information about uploading data for indexing, see Uploading Data
* in the Amazon CloudSearch Developer Guide .
*
*
* @param uploadDocumentsRequest Container for the necessary parameters
* to execute the UploadDocuments service method on
* AmazonCloudSearchDomain.
*
* @return The response from the UploadDocuments service method, as
* returned by AmazonCloudSearchDomain.
*
* @throws DocumentServiceException
*
* @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 AmazonCloudSearchDomain indicating
* either a problem with the data in the request, or a server side issue.
*/
public UploadDocumentsResult uploadDocuments(UploadDocumentsRequest uploadDocumentsRequest) {
ExecutionContext executionContext = createExecutionContext(uploadDocumentsRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
final InputStream isOrig = uploadDocumentsRequest.getDocuments();
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new UploadDocumentsRequestMarshaller().marshall(super.beforeMarshalling(uploadDocumentsRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller =
new UploadDocumentsResultJsonUnmarshaller();
JsonResponseHandler responseHandler =
new JsonResponseHandler(unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
// Restore the original input stream, so that the caller
// (who is responsible) can close it
uploadDocumentsRequest.setDocuments(isOrig);
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* Retrieves autocomplete suggestions for a partial query string. You
* can use suggestions enable you to display likely matches before users
* finish typing. In Amazon CloudSearch, suggestions are based on the
* contents of a particular text field. When you request suggestions,
* Amazon CloudSearch finds all of the documents whose values in the
* suggester field start with the specified query string. The beginning
* of the field must match the query string to be considered a match.
*
*
* For more information about configuring suggesters and retrieving
* suggestions, see
* Getting Suggestions
* in the Amazon CloudSearch Developer Guide .
*
*
* The endpoint for submitting Suggest requests is
* domain-specific. You submit suggest requests to a domain's search
* endpoint. To get the search endpoint for your domain, use the Amazon
* CloudSearch configuration service DescribeDomains action.
* A domain's endpoints are also displayed on the domain dashboard in the
* Amazon CloudSearch console.
*
*
* @param suggestRequest Container for the necessary parameters to
* execute the Suggest service method on AmazonCloudSearchDomain.
*
* @return The response from the Suggest service method, as returned by
* AmazonCloudSearchDomain.
*
* @throws SearchException
*
* @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 AmazonCloudSearchDomain indicating
* either a problem with the data in the request, or a server side issue.
*/
public SuggestResult suggest(SuggestRequest suggestRequest) {
ExecutionContext executionContext = createExecutionContext(suggestRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new SuggestRequestMarshaller().marshall(super.beforeMarshalling(suggestRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller =
new SuggestResultJsonUnmarshaller();
JsonResponseHandler responseHandler =
new JsonResponseHandler(unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
/**
*
* Retrieves a list of documents that match the specified search
* criteria. How you specify the search criteria depends on which query
* parser you use. Amazon CloudSearch supports four query parsers:
*
*
*
* -
simple : search all text and
* text-array fields for the specified string. Search for
* phrases, individual terms, and prefixes.
* -
structured : search specific fields, construct
* compound queries using Boolean operators, and use advanced features
* such as term boosting and proximity searching.
* -
lucene : specify search criteria using the Apache
* Lucene query parser syntax.
* -
dismax : specify search criteria using the
* simplified subset of the Apache Lucene query parser syntax defined by
* the DisMax query parser.
*
*
*
* For more information, see
* Searching Your Data
* in the Amazon CloudSearch Developer Guide .
*
*
* The endpoint for submitting Search requests is
* domain-specific. You submit search requests to a domain's search
* endpoint. To get the search endpoint for your domain, use the Amazon
* CloudSearch configuration service DescribeDomains action.
* A domain's endpoints are also displayed on the domain dashboard in the
* Amazon CloudSearch console.
*
*
* @param searchRequest Container for the necessary parameters to execute
* the Search service method on AmazonCloudSearchDomain.
*
* @return The response from the Search service method, as returned by
* AmazonCloudSearchDomain.
*
* @throws SearchException
*
* @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 AmazonCloudSearchDomain indicating
* either a problem with the data in the request, or a server side issue.
*/
public SearchResult search(SearchRequest searchRequest) {
ExecutionContext executionContext = createExecutionContext(searchRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new SearchRequestMarshaller().marshall(super.beforeMarshalling(searchRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
Unmarshaller unmarshaller =
new SearchResultJsonUnmarshaller();
JsonResponseHandler responseHandler =
new JsonResponseHandler(unmarshaller);
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response, LOGGING_AWS_REQUEST_METRIC);
}
}
@Override
public void setEndpoint(String endpoint) {
super.setEndpoint(endpoint);
}
@Override
public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException {
super.setEndpoint(endpoint, serviceName, regionId);
}
/**
* 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 Response invoke(Request request,
HttpResponseHandler> responseHandler,
ExecutionContext executionContext) {
request.setEndpoint(endpoint);
request.setTimeOffset(timeOffset);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
AWSCredentials credentials;
awsRequestMetrics.startEvent(Field.CredentialsRequestTime);
try {
credentials = awsCredentialsProvider.getCredentials();
} finally {
awsRequestMetrics.endEvent(Field.CredentialsRequestTime);
}
AmazonWebServiceRequest originalRequest = request.getOriginalRequest();
if (originalRequest != null && originalRequest.getRequestCredentials() != null) {
credentials = originalRequest.getRequestCredentials();
}
executionContext.setCredentials(credentials);
JsonErrorResponseHandler errorResponseHandler = new JsonErrorResponseHandler(jsonErrorUnmarshallers);
Response result = client.execute(request, responseHandler,
errorResponseHandler, executionContext);
return result;
}
}