org.apache.knox.gateway.audit.log4j.audit

Class Log4jAuditService

java.lang.Object

org.apache.knox.gateway.audit.log4j.audit.Log4jAuditService

All Implemented Interfaces:

AuditService

public class Log4jAuditService
extends Object
implements AuditService

Field Summary

Fields

Modifier and Type	Field and Description
static String	MDC_AUDIT_CONTEXT_KEY

Constructor Summary

Constructors

Constructor and Description
Log4jAuditService()

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.

Methods inherited from class java.lang.Object

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

Field Detail

MDC_AUDIT_CONTEXT_KEY

public static final String MDC_AUDIT_CONTEXT_KEY

See Also:

Constant Field Values

Constructor Detail

Log4jAuditService

public Log4jAuditService()

Method Detail

createContext

public AuditContext createContext()

Description copied from interface: AuditService

Creates and attaches an "empty" audit context.

Specified by:

createContext in interface AuditService

Returns:

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

getContext

public AuditContext getContext()

Description copied from interface: AuditService

Retrieves the current attached audit context, if any.

Specified by:

getContext in interface AuditService

Returns:

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

attachContext

public void attachContext(AuditContext context)

Description copied from interface: AuditService

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.

Specified by:

attachContext in interface AuditService

Parameters:

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

detachContext

public AuditContext detachContext()

Description copied from interface: AuditService

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.

Specified by:

detachContext in interface AuditService

Returns:

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

execute

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

Description copied from interface: AuditService

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

Specified by:

execute in interface AuditService

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.

getAuditor

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

Description copied from interface: AuditService

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

Specified by:

getAuditor in interface AuditService

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.