/*
* Copyright 2011-2014 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.http;
import java.net.URI;
import java.util.List;
import org.apache.http.annotation.NotThreadSafe;
import com.amazonaws.AmazonWebServiceClient;
import com.amazonaws.auth.AWSCredentials;
import com.amazonaws.auth.Signer;
import com.amazonaws.handlers.RequestHandler2;
import com.amazonaws.retry.internal.AuthErrorRetryStrategy;
import com.amazonaws.util.AWSRequestMetrics;
import com.amazonaws.util.AWSRequestMetricsFullSupport;
@NotThreadSafe
public class ExecutionContext {
private final AWSRequestMetrics awsRequestMetrics;
private final List<RequestHandler2> requestHandler2s;
private String contextUserAgent;
private final AmazonWebServiceClient awsClient;
/** Optional credentials to enable the runtime layer to handle signing requests (and resigning on retries). */
private AWSCredentials credentials;
/**
* An internal retry strategy for auth errors. This is currently only used
* by the S3 client for auto-resolving V4-required regions.
*/
private AuthErrorRetryStrategy authErrorRetryStrategy;
/** For testing purposes. */
public ExecutionContext(boolean isMetricEnabled) {
this(null, isMetricEnabled, null);
}
/** For testing purposes. */
public ExecutionContext() { this(null, false, null); }
public ExecutionContext(List<RequestHandler2> requestHandler2s,
boolean isMetricEnabled,
AmazonWebServiceClient awsClient) {
this.requestHandler2s = requestHandler2s;
awsRequestMetrics = isMetricEnabled
? new AWSRequestMetricsFullSupport()
: new AWSRequestMetrics();
this.awsClient = awsClient;
}
public String getContextUserAgent() {
return contextUserAgent;
}
public void setContextUserAgent(String contextUserAgent) {
this.contextUserAgent = contextUserAgent;
}
public List<RequestHandler2> getRequestHandler2s() {
return requestHandler2s;
}
public AWSRequestMetrics getAwsRequestMetrics() {
return awsRequestMetrics;
}
protected AmazonWebServiceClient getAwsClient() {
return awsClient;
}
/**
* There is in general no need to set the signer in the execution context,
* since the signer for each request may differ depending on the URI of
* the request.
* The exception is S3 where the signer is currently determined only when
* the S3 client is constructed. Hence the need for this method.
* We may consider supporting a per request level signer determination
* for S3 later on.
*/
public void setSigner(Signer signer) {}
/**
* Returns the signer for the given uri.
* Note S3 in particular overrides this method.
*/
public Signer getSignerByURI(URI uri) {
return awsClient == null ? null : awsClient.getSignerByURI(uri);
}
/**
* Returns the optional credentials used to sign the associated request.
*
* @return The optional credentials used to sign the associated request.
*/
public AWSCredentials getCredentials() {
return credentials;
}
/**
* Sets the optional credentials used to sign the associated request. If no
* credentials are specified as part of a request's ExecutionContext, then
* the runtime layer will not attempt to sign (or resign on retries)
* requests.
*
* @param credentials
* The optional credentials used to sign the associated request.
*/
public void setCredentials(AWSCredentials credentials) {
this.credentials = credentials;
}
/**
* Returns the retry strategy for auth errors. This is currently only used
* by the S3 client for auto-resolving sigv4-required regions.
* <p>
* Note that this will be checked BEFORE the HTTP client consults the
* user-specified RetryPolicy. i.e. if the configured AuthErrorRetryStrategy
* says the request should be retried, the retry will be performed
* internally and the effect is transparent to the user's RetryPolicy.
*/
public AuthErrorRetryStrategy getAuthErrorRetryStrategy() {
return authErrorRetryStrategy;
}
/**
* Sets the optional auth error retry strategy for this request execution.
* @see #getAuthErrorRetryStrategy()
*/
public void setAuthErrorRetryStrategy(
AuthErrorRetryStrategy authErrorRetryStrategy) {
this.authErrorRetryStrategy = authErrorRetryStrategy;
}
}