org.apache.hadoop.fs.s3a.audit

Class AuditIntegration

java.lang.Object

org.apache.hadoop.fs.s3a.audit.AuditIntegration

public final class AuditIntegration
extends Object

Support for integrating auditing within the S3A code.

Method Summary

Modifier and Type	Method and Description
static <T extends com.amazonaws.HandlerContextAware> void	attachSpanToRequest(T request, AWSAuditEventCallbacks span) Attach a span to a handler context.
static OperationAuditor	createAndInitAuditor(org.apache.hadoop.conf.Configuration conf, String key, OperationAuditorOptions options) Create and initialize an audit service.
static AuditManagerS3A	createAndStartAuditManager(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.statistics.impl.IOStatisticsStore iostatistics) Create and start an audit manager.
static <T extends com.amazonaws.HandlerContextAware> AWSAuditEventCallbacks	retrieveAttachedSpan(T request) Get the span from a handler context.
static AuditManagerS3A	stubAuditManager() Return a stub audit manager.

Methods inherited from class java.lang.Object

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

Method Detail

createAndStartAuditManager

public static AuditManagerS3A createAndStartAuditManager(org.apache.hadoop.conf.Configuration conf,
                                                         org.apache.hadoop.fs.statistics.impl.IOStatisticsStore iostatistics)

Create and start an audit manager.

Parameters:

conf - configuration

iostatistics - IOStatistics source.

Returns:

audit manager.

stubAuditManager

public static AuditManagerS3A stubAuditManager()

Return a stub audit manager.

Returns:

an audit manager.

createAndInitAuditor

public static OperationAuditor createAndInitAuditor(org.apache.hadoop.conf.Configuration conf,
                                                    String key,
                                                    OperationAuditorOptions options)
                                             throws IOException

Create and initialize an audit service. The service start operation is not called: that is left to the caller.

Parameters:

conf - configuration to read the key from and to use to init the service.

key - key containing the classname

options - options to initialize with.

Returns:

instantiated class.

Throws:

IOException - failure to initialise.

retrieveAttachedSpan

public static <T extends com.amazonaws.HandlerContextAware> AWSAuditEventCallbacks retrieveAttachedSpan(T request)

Get the span from a handler context.

Type Parameters:

T - type of request.

Parameters:

request - request

Returns:

the span callbacks or null

attachSpanToRequest

public static <T extends com.amazonaws.HandlerContextAware> void attachSpanToRequest(T request,
                                                                                     AWSAuditEventCallbacks span)

Attach a span to a handler context.

Type Parameters:

T - type of request.

Parameters:

request - request

span - span to attach