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

Class Log4jAuditor

java.lang.Object

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

All Implemented Interfaces:

Auditor

public class Log4jAuditor
extends Object
implements Auditor

Field Summary

Fields

Modifier and Type	Field and Description
static String	MASKED_QUERY_PARAMS_OPTION Comma seperated list of query parameters who's values will be masked e.g.

Constructor Summary

Constructors

Constructor and Description
Log4jAuditor(String loggerName, String componentName, String serviceName)

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.
static String	maskTokenFromURL(String originalUrl) If the url contains knoxtoken parameter, mask it when logging.

Methods inherited from class java.lang.Object

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

Field Detail

MASKED_QUERY_PARAMS_OPTION

public static final String MASKED_QUERY_PARAMS_OPTION

Comma seperated list of query parameters who's values will be masked e.g. -Dmasked_params=knoxtoken,ccNumber

See Also:

Constant Field Values

Constructor Detail

Log4jAuditor

public Log4jAuditor(String loggerName,
                    String componentName,
                    String serviceName)

Method Detail

audit

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

Description copied from interface: Auditor

Records a single audit event.

Specified by:

audit in interface Auditor

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

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

Description copied from interface: Auditor

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

Specified by:

audit in interface Auditor

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

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

Description copied from interface: Auditor

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

Specified by:

audit in interface Auditor

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.

getComponentName

public String getComponentName()

Description copied from interface: Auditor

The component name established when the Auditor was acquired.

Specified by:

getComponentName in interface Auditor

Returns:

The component name established when the Auditor was acquired.

getServiceName

public String getServiceName()

Description copied from interface: Auditor

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

Specified by:

getServiceName in interface Auditor

Returns:

The service name established when the Auditor was acquired.

getAuditorName

public String getAuditorName()

Description copied from interface: Auditor

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

Specified by:

getAuditorName in interface Auditor

Returns:

The auditor name established when the Auditor was acquired.

maskTokenFromURL

public static String maskTokenFromURL(String originalUrl)

If the url contains knoxtoken parameter, mask it when logging.

Parameters:

originalUrl - original url to try to mask

Returns:

originalUrl masking token value