Package org.apache.hadoop.fs.store.audit

Annotation Interface AuditEntryPoint

@Documented
@Retention(SOURCE)
public @interface AuditEntryPoint

A marker attribute simply to highlight which of the methods in a FileSystem why are audit entry points.

1. A FS method is an AuditEntryPoint if, on invocation it creates and activates an Audit Span for that FS.
2. The audit span SHOULD be deactivated before returning,
3. Objects returned by the API call which go on to make calls of the filesystem MUST perform all IO within the same audit span.
4. Audit Entry points SHOULD NOT invoke other Audit Entry Points. This is to ensure the original audit span information is not replaced.

FileSystem methods the entry point then invokes SHOULD NOT invoke audit entry points internally. All external methods MUST be audit entry points.