org.apache.hadoop.fs.s3a.audit

Interface AWSAuditEventCallbacks

All Superinterfaces:

software.amazon.awssdk.core.interceptor.ExecutionInterceptor

All Known Subinterfaces:

AuditManagerS3A, AuditSpanS3A

All Known Implementing Classes:

AbstractAuditSpanImpl, ActiveAuditManagerS3A, NoopAuditManagerS3A, NoopSpan

public interface AWSAuditEventCallbacks
extends software.amazon.awssdk.core.interceptor.ExecutionInterceptor

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 ExecutionInterceptor for details on the callbacks.

Method Summary

Modifier and Type	Method and Description
String	getOperationName() Get the name of the operation.
String	getSpanId() Return a span ID which must be unique for all spans within everywhere.
default void	requestCreated(software.amazon.awssdk.core.SdkRequest.Builder builder) Callback when a request is created in the S3A code.

Methods inherited from interface software.amazon.awssdk.core.interceptor.ExecutionInterceptor

afterExecution, afterMarshalling, afterTransmission, afterUnmarshalling, beforeExecution, beforeMarshalling, beforeTransmission, beforeUnmarshalling, modifyAsyncHttpContent, modifyAsyncHttpResponseContent, modifyException, modifyHttpContent, modifyHttpRequest, modifyHttpResponse, modifyHttpResponseContent, modifyRequest, modifyResponse, onExecutionFailure

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 void requestCreated(software.amazon.awssdk.core.SdkRequest.Builder builder)

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.

Parameters:

builder - the request builder.