S3AAuditConstants (Apache Hadoop Amazon Web Services support 3.4.0 API)

java.lang.Object
- org.apache.hadoop.fs.s3a.audit.S3AAuditConstants

@InterfaceAudience.LimitedPrivate(value="S3A auditing extensions")
 @InterfaceStability.Unstable
public final class S3AAuditConstants
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUDIT_ENABLED` Is auditing enabled? Value: "fs.s3a.audit.enabled".
`static boolean`	`AUDIT_ENABLED_DEFAULT` Default auditing flag.
`static String`	`AUDIT_EXECUTION_INTERCEPTORS` List of extra AWS SDK execution interceptors: "fs.s3a.audit.execution.interceptors".
`static String`	`AUDIT_REQUEST_HANDLERS` Deprecated list of extra AWS SDK request handlers: "fs.s3a.audit.request.handlers".
`static String`	`AUDIT_SERVICE_CLASSNAME` Name of class used for audit logs: "fs.s3a.audit.service.classname".
`static String`	`INITIALIZE_SPAN` Span name used during initialization.
`static String`	`LOGGING_AUDIT_SERVICE` Classname of the logging auditor: "org.apache.hadoop.fs.s3a.audit.impl.LoggingAuditor".
`static String`	`NOOP_AUDIT_SERVICE` Classname of the No-op auditor: "org.apache.hadoop.fs.s3a.audit.impl.NoopAuditor".
`static String`	`OUTSIDE_SPAN` Operation name for any operation outside of an explicit span.
`static String`	`REFERRER_HEADER_ENABLED` Should the logging auditor add the HTTP Referrer header? "fs.s3a.audit.referrer.enabled".
`static boolean`	`REFERRER_HEADER_ENABLED_DEFAULT` Should the logging auditor add the HTTP Referrer header? Default value: true.
`static String`	`REFERRER_HEADER_FILTER` List of audit fields to strip from referrer headers.
`static String`	`REJECT_OUT_OF_SPAN_OPERATIONS` Should operations outside spans be rejected? This is for testing coverage of the span code; if used in production there's a risk of unexpected failures.
`static String`	`UNAUDITED_OPERATION` What to look for in logs for ops outside any audit.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNAUDITED_OPERATION
```
public static final String UNAUDITED_OPERATION
```
    What to look for in logs for ops outside any audit. "unaudited operation".
    
    See Also:
    
    Constant Field Values
  - AUDIT_ENABLED
```
public static final String AUDIT_ENABLED
```
    Is auditing enabled? Value: "fs.s3a.audit.enabled".
    
    See Also:
    
    Constant Field Values
  - AUDIT_ENABLED_DEFAULT
```
public static final boolean AUDIT_ENABLED_DEFAULT
```
    Default auditing flag. Value: true.
    
    See Also:
    
    Constant Field Values
  - AUDIT_SERVICE_CLASSNAME
```
public static final String AUDIT_SERVICE_CLASSNAME
```
    Name of class used for audit logs: "fs.s3a.audit.service.classname".
    
    See Also:
    
    Constant Field Values
  - LOGGING_AUDIT_SERVICE
```
public static final String LOGGING_AUDIT_SERVICE
```
    Classname of the logging auditor: "org.apache.hadoop.fs.s3a.audit.impl.LoggingAuditor".
    
    See Also:
    
    Constant Field Values
  - NOOP_AUDIT_SERVICE
```
public static final String NOOP_AUDIT_SERVICE
```
    Classname of the No-op auditor: "org.apache.hadoop.fs.s3a.audit.impl.NoopAuditor".
    
    See Also:
    
    Constant Field Values
  - AUDIT_REQUEST_HANDLERS
```
public static final String AUDIT_REQUEST_HANDLERS
```
    Deprecated list of extra AWS SDK request handlers: "fs.s3a.audit.request.handlers". Use AUDIT_EXECUTION_INTERCEPTORS instead.
    
    See Also:
    
    Constant Field Values
  - AUDIT_EXECUTION_INTERCEPTORS
```
public static final String AUDIT_EXECUTION_INTERCEPTORS
```
    List of extra AWS SDK execution interceptors: "fs.s3a.audit.execution.interceptors". These are added to the SDK request chain after any audit service.
    
    See Also:
    
    Constant Field Values
  - REJECT_OUT_OF_SPAN_OPERATIONS
```
public static final String REJECT_OUT_OF_SPAN_OPERATIONS
```
    Should operations outside spans be rejected? This is for testing coverage of the span code; if used in production there's a risk of unexpected failures. "fs.s3a.audit.reject.out.of.span.operations".
    
    See Also:
    
    Constant Field Values
  - REFERRER_HEADER_ENABLED
```
public static final String REFERRER_HEADER_ENABLED
```
    Should the logging auditor add the HTTP Referrer header? "fs.s3a.audit.referrer.enabled".
    
    See Also:
    
    Constant Field Values
  - REFERRER_HEADER_ENABLED_DEFAULT
```
public static final boolean REFERRER_HEADER_ENABLED_DEFAULT
```
    Should the logging auditor add the HTTP Referrer header? Default value: true.
    
    See Also:
    
    Constant Field Values
  - REFERRER_HEADER_FILTER
```
public static final String REFERRER_HEADER_FILTER
```
    List of audit fields to strip from referrer headers. "fs.s3a.audit.referrer.filter".
    
    See Also:
    
    Constant Field Values
  - INITIALIZE_SPAN
```
public static final String INITIALIZE_SPAN
```
    Span name used during initialization.
    
    See Also:
    
    Constant Field Values
  - OUTSIDE_SPAN
```
public static final String OUTSIDE_SPAN
```
    Operation name for any operation outside of an explicit span.
    
    See Also:
    
    Constant Field Values

Class S3AAuditConstants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNAUDITED_OPERATION

AUDIT_ENABLED

AUDIT_ENABLED_DEFAULT

AUDIT_SERVICE_CLASSNAME

LOGGING_AUDIT_SERVICE

NOOP_AUDIT_SERVICE

AUDIT_REQUEST_HANDLERS

AUDIT_EXECUTION_INTERCEPTORS

REJECT_OUT_OF_SPAN_OPERATIONS

REFERRER_HEADER_ENABLED

REFERRER_HEADER_ENABLED_DEFAULT

REFERRER_HEADER_FILTER

INITIALIZE_SPAN

OUTSIDE_SPAN