org.apache.hadoop.fs.s3a.audit

Interface AWSAuditEventCallbacks

All Known Subinterfaces:

AuditManagerS3A, AuditSpanS3A

All Known Implementing Classes:

AbstractAuditSpanImpl, ActiveAuditManagerS3A, NoopAuditManagerS3A, NoopSpan

public interface AWSAuditEventCallbacks

Callbacks for audit spans. This is implemented in the span manager as well as individual audit spans. If any of the code in a callback raises an InterruptedException, it must be caught and Thread.interrupt() called to redeclare the thread as interrupted. The AWS SDK will detect this and raise an exception. Look at the documentation for com.amazonaws.handlers.IRequestHandler2 for details on the callbacks.

Method Summary

Modifier and Type	Method and Description
default void	afterAttempt(com.amazonaws.handlers.HandlerAfterAttemptContext context) After any attempt is made.
default void	afterError(com.amazonaws.Request<?> request, com.amazonaws.Response<?> response, Exception exception) Callback after a request resulted in an error.
default void	afterResponse(com.amazonaws.Request<?> request, com.amazonaws.Response<?> response) Callback after S3 responded to a request.
default void	beforeAttempt(com.amazonaws.handlers.HandlerBeforeAttemptContext context) Before any attempt is made.
default <T extends com.amazonaws.AmazonWebServiceRequest> T	beforeExecution(T request) Preflight preparation of AWS request.
default com.amazonaws.AmazonWebServiceRequest	beforeMarshalling(com.amazonaws.AmazonWebServiceRequest request) Request before marshalling.
default void	beforeRequest(com.amazonaws.Request<?> request) Request before marshalling.
default com.amazonaws.http.HttpResponse	beforeUnmarshalling(com.amazonaws.Request<?> request, com.amazonaws.http.HttpResponse httpResponse) Before unmarshalling the response.
String	getOperationName() Get the name of the operation.
String	getSpanId() Return a span ID which must be unique for all spans within everywhere.
default <T extends com.amazonaws.AmazonWebServiceRequest> T	requestCreated(T request) Callback when a request is created in the S3A code.

Method Detail

getSpanId

String getSpanId()

Return a span ID which must be unique for all spans within everywhere. That effectively means part of the span SHOULD be derived from a UUID. Callers MUST NOT make any assumptions about the actual contents or structure of this string other than the uniqueness.

Returns:

a non-empty string

getOperationName

String getOperationName()

Get the name of the operation.

Returns:

the operation name.

requestCreated

default <T extends com.amazonaws.AmazonWebServiceRequest> T requestCreated(T request)

Callback when a request is created in the S3A code. This is called in RequestFactoryImpl after each request is created. It is not invoked on any AWS requests created in the SDK. Avoid raising exceptions or talking to any remote service; this callback is for annotation rather than validation.

Type Parameters:

T - type of request

Parameters:

request - request request.

Returns:

the request, possibly modified.

beforeExecution

@Retries.OnceRaw
default <T extends com.amazonaws.AmazonWebServiceRequest> T beforeExecution(T request)
                                                                                      throws AuditFailureException,
                                                                                             com.amazonaws.SdkBaseException

Preflight preparation of AWS request.

Type Parameters:

T - type of request

Parameters:

request - request

Returns:

an updated request.

Throws:

AuditFailureException - for generic audit failures

com.amazonaws.SdkBaseException - for other reasons.

afterResponse

default void afterResponse(com.amazonaws.Request<?> request,
                           com.amazonaws.Response<?> response)
                    throws AuditFailureException,
                           com.amazonaws.SdkBaseException

Callback after S3 responded to a request.

Parameters:

request - request

response - response.

Throws:

AuditFailureException - for generic audit failures

com.amazonaws.SdkBaseException - for other reasons.

afterError

default void afterError(com.amazonaws.Request<?> request,
                        com.amazonaws.Response<?> response,
                        Exception exception)
                 throws AuditFailureException,
                        com.amazonaws.SdkBaseException

Callback after a request resulted in an error.

Parameters:

request - request

response - response.

exception - exception raised.

Throws:

AuditFailureException - for generic audit failures

com.amazonaws.SdkBaseException - for other reasons.

beforeMarshalling

default com.amazonaws.AmazonWebServiceRequest beforeMarshalling(com.amazonaws.AmazonWebServiceRequest request)

Request before marshalling.

Parameters:

request - request

Returns:

possibly modified request.

beforeRequest

default void beforeRequest(com.amazonaws.Request<?> request)

Request before marshalling.

Parameters:

request - request

beforeAttempt

default void beforeAttempt(com.amazonaws.handlers.HandlerBeforeAttemptContext context)

Before any attempt is made.

Parameters:

context - full context, including the request.

afterAttempt

default void afterAttempt(com.amazonaws.handlers.HandlerAfterAttemptContext context)

After any attempt is made.

Parameters:

context - full context, including the request.

beforeUnmarshalling

default com.amazonaws.http.HttpResponse beforeUnmarshalling(com.amazonaws.Request<?> request,
                                                            com.amazonaws.http.HttpResponse httpResponse)

Before unmarshalling the response.

Parameters:

request - request made.

httpResponse - response received

Returns:

updated response.