com.ibm.cloud.objectstorage.http

Class ExecutionContext

java.lang.Object

com.ibm.cloud.objectstorage.http.ExecutionContext

@NotThreadSafe
public class ExecutionContext
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecutionContext.Builder

Constructor Summary

Constructors

Constructor and Description
ExecutionContext() For testing purposes.
ExecutionContext(boolean isMetricEnabled) For testing purposes.
ExecutionContext(List<RequestHandler2> requestHandler2s, boolean isMetricEnabled, AmazonWebServiceClient awsClient) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ExecutionContext.Builder	builder()
AuthErrorRetryStrategy	getAuthErrorRetryStrategy() Returns the retry strategy for auth errors.
protected AmazonWebServiceClient	getAwsClient()
AWSRequestMetrics	getAwsRequestMetrics()
ClientExecutionAbortTrackerTask	getClientExecutionTrackerTask()
AWSCredentialsProvider	getCredentialsProvider() Returns the credentials provider used for fetching the credentials.
List<RequestHandler2>	getRequestHandler2s()
Signer	getSigner(SignerProviderContext context) Passes in the provided SignerProviderContext into a SignerProvider and returns a Signer instance.
Signer	getSignerByURI(URI uri) Deprecated.
void	markRetryCapacityConsumed() Marks that a retry during this request lifecycle has consumed retry capacity.
boolean	retryCapacityConsumed() Returns whether retry capacity was consumed during this request lifecycle.
void	setAuthErrorRetryStrategy(AuthErrorRetryStrategy authErrorRetryStrategy) Sets the optional auth error retry strategy for this request execution.
void	setClientExecutionTrackerTask(ClientExecutionAbortTrackerTask clientExecutionTrackerTask)
void	setCredentialsProvider(AWSCredentialsProvider credentialsProvider) Sets the credentials provider used for fetching the credentials.
void	setSigner(Signer signer) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExecutionContext

public ExecutionContext(boolean isMetricEnabled)

For testing purposes.

ExecutionContext

public ExecutionContext()

For testing purposes.

ExecutionContext

@Deprecated
public ExecutionContext(List<RequestHandler2> requestHandler2s,
                                    boolean isMetricEnabled,
                                    AmazonWebServiceClient awsClient)

Deprecated.

Method Detail

getRequestHandler2s

public List<RequestHandler2> getRequestHandler2s()

getAwsRequestMetrics

public AWSRequestMetrics getAwsRequestMetrics()

getAwsClient

protected AmazonWebServiceClient getAwsClient()

setSigner

@Deprecated
public void setSigner(Signer signer)

Deprecated.

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.

retryCapacityConsumed

public boolean retryCapacityConsumed()

Returns whether retry capacity was consumed during this request lifecycle. This can be inspected to determine whether capacity should be released if a retry succeeds.

Returns:

true if retry capacity was consumed

markRetryCapacityConsumed

public void markRetryCapacityConsumed()

Marks that a retry during this request lifecycle has consumed retry capacity. This is inspected when determining if capacity should be released if a retry succeeds.

getSigner

public Signer getSigner(SignerProviderContext context)

Passes in the provided SignerProviderContext into a SignerProvider and returns a Signer instance.

getSignerByURI

@Deprecated
public Signer getSignerByURI(URI uri)

Deprecated.

Returns the signer for the given uri. Note S3 in particular overrides this method.

setCredentialsProvider

public void setCredentialsProvider(AWSCredentialsProvider credentialsProvider)

Sets the credentials provider used for fetching the credentials. The credentials fetched is used for signing the request. If there is no credential provider, then the runtime will not attempt to sign (or resign on retries) requests.

Parameters:

credentialsProvider - the credentials provider to fetch AWSCredentials

getCredentialsProvider

public AWSCredentialsProvider getCredentialsProvider()

Returns the credentials provider used for fetching the credentials. The credentials fetched is used for signing the request. If there is no credential provider, then the runtime will not attempt to sign (or resign on retries) requests.

Returns:

the credentials provider to fetch AWSCredentials

getAuthErrorRetryStrategy

public AuthErrorRetryStrategy getAuthErrorRetryStrategy()

Returns the retry strategy for auth errors. This is currently only used by the S3 client for auto-resolving sigv4-required regions.

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.

setAuthErrorRetryStrategy

public void setAuthErrorRetryStrategy(AuthErrorRetryStrategy authErrorRetryStrategy)

Sets the optional auth error retry strategy for this request execution.

See Also:

ExecutionContext.getAuthErrorRetryStrategy()

getClientExecutionTrackerTask

public ClientExecutionAbortTrackerTask getClientExecutionTrackerTask()

setClientExecutionTrackerTask

public void setClientExecutionTrackerTask(ClientExecutionAbortTrackerTask clientExecutionTrackerTask)

builder

public static ExecutionContext.Builder builder()