org.apache.hadoop.fs.s3a.audit.impl

Class NoopAuditor

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.fs.s3a.audit.impl.AbstractOperationAuditor

org.apache.hadoop.fs.s3a.audit.impl.NoopAuditor

All Implemented Interfaces:

Closeable, AutoCloseable, OperationAuditor, org.apache.hadoop.fs.statistics.IOStatisticsSource, org.apache.hadoop.fs.store.audit.AuditSpanSource<AuditSpanS3A>, org.apache.hadoop.service.Service

public class NoopAuditor
extends AbstractOperationAuditor

An audit service which returns the NoopSpan. Even though the spans are no-ops, each span is still created with a unique span ID.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Field Summary

Fields inherited from class org.apache.hadoop.fs.s3a.audit.impl.AbstractOperationAuditor

BASE

Constructor Summary

Constructors

Constructor and Description
NoopAuditor()
NoopAuditor(String name) Constructor.
NoopAuditor(String name, NoopSpan.SpanActivationCallbacks activationCallbacks) Constructor when explicitly created within the NoopAuditManagerS3A.

Method Summary

Modifier and Type	Method and Description
static NoopAuditor	createAndStartNoopAuditor(org.apache.hadoop.conf.Configuration conf, NoopSpan.SpanActivationCallbacks activationCallbacks) Create, init and start an instance.
AuditSpanS3A	createSpan(String operation, String path1, String path2)
AuditSpanS3A	getUnbondedSpan() Get the unbonded span to use after deactivating an active span.

Methods inherited from class org.apache.hadoop.fs.s3a.audit.impl.AbstractOperationAuditor

auditorFlagsChanged, createSpanID, getAuditorFlags, getAuditorId, getIOStatistics, getOptions, init, isRejectOutOfSpan, serviceInit, setAuditFlags, setRejectOutOfSpan

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, serviceStart, serviceStop, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.fs.s3a.audit.OperationAuditor

checkAccess, noteSpanReferenceLost

Methods inherited from interface org.apache.hadoop.service.Service

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, registerServiceListener, start, stop, unregisterServiceListener, waitForServiceToStop

Constructor Detail

NoopAuditor

public NoopAuditor(String name)

Constructor. This will be used when the auditor is created through configuration and classloading.

Parameters:

name - auditor name

NoopAuditor

public NoopAuditor(String name,
                   NoopSpan.SpanActivationCallbacks activationCallbacks)

Constructor when explicitly created within the NoopAuditManagerS3A.

Parameters:

name - auditor name

activationCallbacks - Activation callbacks.

NoopAuditor

public NoopAuditor()

Method Detail

createSpan

public AuditSpanS3A createSpan(String operation,
                               @Nullable
                               String path1,
                               @Nullable
                               String path2)

getUnbondedSpan

public AuditSpanS3A getUnbondedSpan()

Description copied from interface: OperationAuditor

Get the unbonded span to use after deactivating an active span.

Returns:

a span.

createAndStartNoopAuditor

public static NoopAuditor createAndStartNoopAuditor(org.apache.hadoop.conf.Configuration conf,
                                                    NoopSpan.SpanActivationCallbacks activationCallbacks)

Create, init and start an instance.

Parameters:

conf - configuration.

activationCallbacks - Activation callbacks.

Returns:

a started instance.