Package software.amazon.awssdk.handlers

Class RequestHandler

java.lang.Object

software.amazon.awssdk.handlers.RequestHandler

All Implemented Interfaces:

IRequestHandler

Direct Known Subclasses:

AcceptJsonRequestHandler, AcceptJsonRequestHandler, AcceptJsonRequestHandler, CopyDbSnapshotPresignHandler, CreateBucketRequestHandler, CreateDbInstanceReadReplicaPresignHandler, DecodeUrlEncodedResponseRequestHandler, EC2RequestHandler, EndpointAddressRequestHandler, GeneratePreSignUrlRequestHandler, GlacierRequestHandler, MessageMD5ChecksumHandler, PredictEndpointHandler, QueueUrlHandler, RandomIdHandler, Route53IdRequestHandler, SqsRequestHandler, SwitchToPostHandler, TimestampFormatRequestHandler

public abstract class RequestHandler
extends Object
implements IRequestHandler

Interface that allows hooking into the lifecycle of a request and in certain cases, modifying the outbound request or inbound response. TODO: This shouldn't be coupled to AWS-specific concepts

Constructor Summary

Constructors

Constructor	Description
RequestHandler()

Method Summary

Modifier and Type	Method	Description
void	afterError(SdkHttpFullRequest request, Response<?> response, Exception e)	Runs any additional processing logic on a request after it has failed.
void	afterResponse(SdkHttpFullRequest request, Response<?> response)	Runs any additional processing logic on the specified request (after is has been executed by the client runtime).
AmazonWebServiceRequest	beforeMarshalling(AmazonWebServiceRequest request)	Runs any additional processing logic on the specified request object before it is marshaled into an HTTP request.
SdkHttpFullRequest	beforeRequest(SdkHttpFullRequest request)	Runs any additional processing logic on the specified request (before it is executed by the client runtime).
HttpResponse	beforeUnmarshalling(SdkHttpFullRequest request, HttpResponse httpResponse)	Runs any additional processing logic on the specified response before it's unmarshalled.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestHandler

public RequestHandler()

Method Detail

beforeMarshalling

public AmazonWebServiceRequest beforeMarshalling(AmazonWebServiceRequest request)

Description copied from interface: IRequestHandler

Runs any additional processing logic on the specified request object before it is marshaled into an HTTP request.

If you're going to modify the request, make sure to clone it first, modify the clone, and return it from this method. Otherwise your changes will leak out to the user, who might reuse the request object without realizing that it was modified as part of sending it the first time.

Super big hack: This may not be called if the request is not an AmazonWebServiceRequest.

Specified by:

beforeMarshalling in interface IRequestHandler

Parameters:

request - the request passed in by the user.

Returns:

the (possibly different) request to marshal

beforeRequest

public SdkHttpFullRequest beforeRequest(SdkHttpFullRequest request)

Description copied from interface: IRequestHandler

Runs any additional processing logic on the specified request (before it is executed by the client runtime).

Specified by:

beforeRequest in interface IRequestHandler

Parameters:

request - The low level request being processed.

beforeUnmarshalling

public HttpResponse beforeUnmarshalling(SdkHttpFullRequest request,
                                        HttpResponse httpResponse)

Description copied from interface: IRequestHandler

Runs any additional processing logic on the specified response before it's unmarshalled. This callback is only invoked on successful responses that will be unmarsahlled into an appropriate modeled class and not for unsuccessful responses that will be unmarshalled into a subclass of AmazonServiceException

Specified by:

beforeUnmarshalling in interface IRequestHandler

Parameters:

request - The low level request being processed.

httpResponse - The Raw HTTP response before being unmarshalled

Returns:

HttpResponse to replace the actual response. May be a mutated version of the original or a completely new HttpResponse object

afterResponse

public void afterResponse(SdkHttpFullRequest request,
                          Response<?> response)

Description copied from interface: IRequestHandler

Runs any additional processing logic on the specified request (after is has been executed by the client runtime).

Specified by:

afterResponse in interface IRequestHandler

Parameters:

request - The low level request being processed.

response - The response generated from the specified request.

afterError

public void afterError(SdkHttpFullRequest request,
                       Response<?> response,
                       Exception e)

Description copied from interface: IRequestHandler

Runs any additional processing logic on a request after it has failed.

Specified by:

afterError in interface IRequestHandler

Parameters:

request - The request that generated an error.

response - the response or null if the failure occurred before the response is made available

e - The error that resulted from executing the request.