org.apache.knox.gateway.audit.api

Interface Auditor

All Known Implementing Classes:

Log4jAuditor

public interface Auditor

Used to record audit events.

Method Summary

Modifier and Type	Method and Description
void	audit(CorrelationContext correlationContext, AuditContext auditContext, String action, String resourceName, String resourceType, String outcome, String message) Records a single audit event.
void	audit(String action, String resourceName, String resourceType, String outcome) Records a single audit event using context information associated with the current thread.
void	audit(String action, String resourceName, String resourceType, String outcome, String message) Records a single audit event using context information associated with the current thread.
String	getAuditorName() The auditor name established when the Auditor was acquired.
String	getComponentName() The component name established when the Auditor was acquired.
String	getServiceName() The service name established when the Auditor was acquired.

Method Detail

audit

void audit(CorrelationContext correlationContext,
           AuditContext auditContext,
           String action,
           String resourceName,
           String resourceType,
           String outcome,
           String message)

Records a single audit event.

Parameters:

correlationContext - The explicit correlation context to use when recording this audit event. May not be null.

auditContext - The explicit audit context to use when recording this audit event. May not be null.

action - The action being recorded for this audit event. May not be null.

resourceName - The resource identifier to record for this audit event. May not be null.

resourceType - The resource type to record for this audit event. May not be null.

outcome - The outcome to record for this audit event. Typically the result of a authorization check. May not be null.

message - An arbitrary message to record with the audit event. May be null.

audit

void audit(String action,
           String resourceName,
           String resourceType,
           String outcome,
           String message)

Records a single audit event using context information associated with the current thread.

Parameters:

action - The action being recorded for this audit event. May not be null.

resourceName - The resource identifier to record for this audit event. May not be null.

resourceType - The resource type to record for this audit event. May not be null.

outcome - The outcome to record for this audit event. Typically the result of a authorization check. May not be null.

message - An arbitrary message to record with the audit event. May be null.

audit

void audit(String action,
           String resourceName,
           String resourceType,
           String outcome)

Records a single audit event using context information associated with the current thread.

Parameters:

action - The action being recorded for this audit event. May not be null.

resourceName - The resource identifier to record for this audit event. May not be null.

resourceType - The resource type to record for this audit event. May not be null.

outcome - The outcome to record for this audit event. Typically the result of a authorization check. May not be null.

getServiceName

String getServiceName()

The service name established when the Auditor was acquired. Every event logged by auditor instance will contain data about service that generated event.

Returns:

The service name established when the Auditor was acquired.

getComponentName

String getComponentName()

The component name established when the Auditor was acquired.

Returns:

The component name established when the Auditor was acquired.

getAuditorName

String getAuditorName()

The auditor name established when the Auditor was acquired. As an example, authentication/authorization operations may be logged to separate security log. Or actions on some resources shouldn't be logged into central storage. Auditor name provide an ability to logically group audit events, configure theirs filtration and persistence

Returns:

The auditor name established when the Auditor was acquired.