software.amazon.awssdk.core.internal.http.pipeline.stages.utils

Class RetryableStageHelper

java.lang.Object

software.amazon.awssdk.core.internal.http.pipeline.stages.utils.RetryableStageHelper

public class RetryableStageHelper
extends java.lang.Object

Contains the logic shared by RetryableStage and AsyncRetryableStage when querying and interacting with a RetryPolicy.

Constructor Summary

Constructors

Constructor and Description
RetryableStageHelper(software.amazon.awssdk.http.SdkHttpFullRequest request, software.amazon.awssdk.core.internal.http.RequestExecutionContext context, software.amazon.awssdk.core.internal.http.HttpClientDependencies dependencies)

Method Summary

Modifier and Type	Method and Description
void	adjustClockIfClockSkew(software.amazon.awssdk.core.Response<?> response) Adjust the client-side clock skew if the provided response indicates that there is a large skew between the client and service.
void	attemptSucceeded() Notify the retry policy that the request attempt succeeded.
int	getAttemptNumber() Retrieve the current attempt number, updated whenever startingAttempt() is invoked.
java.time.Duration	getBackoffDelay() Get the amount of time that the request should be delayed before being sent.
software.amazon.awssdk.core.exception.SdkException	getLastException() Retrieve the last call failure exception encountered by this execution, updated whenever setLastException(java.lang.Throwable) is invoked.
void	logBackingOff(java.time.Duration backoffDelay) Log a message to the user at the debug level to indicate how long we will wait before retrying the request.
void	logSendingRequest() Log a message to the user at the debug level to indicate that we are sending the request to the service.
software.amazon.awssdk.http.SdkHttpFullRequest	requestToSend() Retrieve the request to send to the service, including any detailed retry information headers.
boolean	retryPolicyAllowsRetry() Returns true if the retry policy allows this attempt.
software.amazon.awssdk.core.exception.SdkException	retryPolicyDisallowedRetryException() Return the exception that should be thrown, because the retry policy did not allow the request to be retried.
void	setLastException(java.lang.Throwable lastException) Update the getLastException() value for this helper.
void	setLastResponse(software.amazon.awssdk.http.SdkHttpResponse lastResponse) Set the last HTTP response returned by the service.
void	startingAttempt() Invoke when starting a request attempt, before querying the retry policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryableStageHelper

public RetryableStageHelper(software.amazon.awssdk.http.SdkHttpFullRequest request,
                            software.amazon.awssdk.core.internal.http.RequestExecutionContext context,
                            software.amazon.awssdk.core.internal.http.HttpClientDependencies dependencies)

Method Detail

startingAttempt

public void startingAttempt()

Invoke when starting a request attempt, before querying the retry policy.

retryPolicyAllowsRetry

public boolean retryPolicyAllowsRetry()

Returns true if the retry policy allows this attempt. This will always return true if the current attempt is not a retry (i.e. it's the first request in the execution).

retryPolicyDisallowedRetryException

public software.amazon.awssdk.core.exception.SdkException retryPolicyDisallowedRetryException()

Return the exception that should be thrown, because the retry policy did not allow the request to be retried.

getBackoffDelay

public java.time.Duration getBackoffDelay()

Get the amount of time that the request should be delayed before being sent. This may be Duration.ZERO, such as for the first request in the request series.

logBackingOff

public void logBackingOff(java.time.Duration backoffDelay)

Log a message to the user at the debug level to indicate how long we will wait before retrying the request.

requestToSend

public software.amazon.awssdk.http.SdkHttpFullRequest requestToSend()

Retrieve the request to send to the service, including any detailed retry information headers.

logSendingRequest

public void logSendingRequest()

Log a message to the user at the debug level to indicate that we are sending the request to the service.

adjustClockIfClockSkew

public void adjustClockIfClockSkew(software.amazon.awssdk.core.Response<?> response)

Adjust the client-side clock skew if the provided response indicates that there is a large skew between the client and service. This will allow a retried request to be signed with what is likely to be a more accurate time.

attemptSucceeded

public void attemptSucceeded()

Notify the retry policy that the request attempt succeeded.

getAttemptNumber

public int getAttemptNumber()

Retrieve the current attempt number, updated whenever startingAttempt() is invoked.

getLastException

public software.amazon.awssdk.core.exception.SdkException getLastException()

Retrieve the last call failure exception encountered by this execution, updated whenever setLastException(java.lang.Throwable) is invoked.

setLastException

public void setLastException(java.lang.Throwable lastException)

Update the getLastException() value for this helper. This will be used to determine whether the request should be retried.

setLastResponse

public void setLastResponse(software.amazon.awssdk.http.SdkHttpResponse lastResponse)

Set the last HTTP response returned by the service. This will be used to determine whether the request should be retried.