org.apache.knox.gateway.audit.api

Interface AuditService

All Known Implementing Classes:

Log4jAuditService

public interface AuditService

Manipulates the audit context associated with the current thread.

Method Summary

Modifier and Type	Method and Description
void	attachContext(AuditContext context) Attaches the provided audit context to the current thread.
AuditContext	createContext() Creates and attaches an "empty" audit context.
AuditContext	detachContext() Detaches the current audit context, if any, from the current thread.
<T> T	execute(AuditContext context, Callable<T> callable) Executes the callable within the provided audit context.
Auditor	getAuditor(String auditorName, String componentName, String serviceName) Retrieves an auditor configured with the the provided component and service names.
AuditContext	getContext() Retrieves the current attached audit context, if any.

Method Detail

createContext

AuditContext createContext()

Creates and attaches an "empty" audit context.

Returns:

A new, empty, attached audit context. Will never be null.

getContext

AuditContext getContext()

Retrieves the current attached audit context, if any.

Returns:

The current attached audit context if any. May be null.

attachContext

void attachContext(AuditContext context)

Attaches the provided audit context to the current thread. Providing a null value will have no effect and the currently attached context if any will remain.

Parameters:

context - The audit context to attach to the current thread. May be null.

detachContext

AuditContext detachContext()

Detaches the current audit context, if any, from the current thread. This will typically be used when an audit context needs to be propagated between threads.

Returns:

The now detached audit context, if any. May be null.

getAuditor

Auditor getAuditor(String auditorName,
                   String componentName,
                   String serviceName)

Retrieves an auditor configured with the the provided component and service names. Will never be null.

Parameters:

auditorName - The name of auditor. Can be used to separate audit events to different destinations. For example security audit, operations audit, etc

componentName - The name of component that will be placed used in every audit event generated by Auditor instance

serviceName - The name of service that will be placed used in every audit event generated by Auditor instance

Returns:

Auditor configured with the component and service names. Will never be null.

execute

<T> T execute(AuditContext context,
              Callable<T> callable)
       throws Exception

Executes the callable within the provided audit context. The provided context is attached and detached around the invocation of the callable.

Type Parameters:

T - Type of callable

Parameters:

context - The context to establish around the invocation of the callable. May not be null.

callable - The callable to invoke after establishing the correlation context. May not be null.

Returns:

The result of the callable's call method.

Throws:

Exception - Thrown if thrown by the callable's call method.