Package swiss.trustbroker.audit.service

Class BaseAuditLogger

java.lang.Object

swiss.trustbroker.audit.service.BaseAuditLogger

All Implemented Interfaces:

AuditLogger

Direct Known Subclasses:

DefaultAuditLogger, OpsAuditLogger

public abstract class BaseAuditLogger
extends Object
implements AuditLogger

Base class of loggers that perrform the actual logging. Separate class to allow mocking in tests.
Audit entries emitted as follows:

• INFO: RP.AuthnRequest, RP.Response, RP.LogoutRequest
• DEBUG: CP.AuthnRequest, CP.Response
• TRACE: AttributeValue marked with FQ name
• If AuditLoggerDetails=TRACE the full SAML message is attached as a detail field (large).

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DETAILS_LOGGER_POSTFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseAuditLogger()

Method Summary

Modifier and Type	Method	Description
String	getAuditDetail(org.opensaml.core.xml.XMLObject xmlObject)	Convert OpenSAML object to details for logging.
protected abstract org.slf4j.Logger	getDetailLogger()
protected abstract org.slf4j.Logger	getLogger()
protected boolean	isDetailAuditingEnabled()
void	log(EventType eventType, boolean inbound, String message)	Audit message and context data to analyze login traffic and record what's needed for compliance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface swiss.trustbroker.audit.service.AuditLogger

createAuditLogBuilder

Field Details

DETAILS_LOGGER_POSTFIX

protected static final String DETAILS_LOGGER_POSTFIX

See Also:

• Constant Field Values

Constructor Details

BaseAuditLogger

protected BaseAuditLogger()

Method Details

log

public void log(EventType eventType,
 boolean inbound,
 String message)

Description copied from interface: AuditLogger

Audit message and context data to analyze login traffic and record what's needed for compliance.

Specified by:

log in interface AuditLogger

Parameters:

eventType - is SAML AuthnRequest or Response

inbound - means messages coming in (AuthnRequest from RP or Response from CP)

message - contains the data already mapped via AuditMapper and formatted by AuditLogBuilder

getLogger

protected abstract org.slf4j.Logger getLogger()

Returns:

logger to use

getDetailLogger

protected abstract org.slf4j.Logger getDetailLogger()

Returns:

logger to use for details

getAuditDetail

public String getAuditDetail(org.opensaml.core.xml.XMLObject xmlObject)

Description copied from interface: AuditLogger

Convert OpenSAML object to details for logging.

Specified by:

getAuditDetail in interface AuditLogger

Parameters:

xmlObject -

Returns:

Extracted part of object for detail logging.

isDetailAuditingEnabled

protected boolean isDetailAuditingEnabled()