net.shibboleth.idp.profile.audit.impl

Class WriteAuditLog

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction<InboundMessageType,OutboundMessageType>

org.opensaml.profile.action.AbstractConditionalProfileAction<InboundMessageType,OutboundMessageType>

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.profile.audit.impl.WriteAuditLog

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, org.opensaml.profile.action.ProfileAction, org.springframework.beans.factory.Aware, org.springframework.context.MessageSource, org.springframework.context.MessageSourceAware, org.springframework.webflow.execution.Action

public class WriteAuditLog
extends AbstractProfileAction

Action that produces audit log entries based on an AuditContext and one or more formatting strings.

Event:

EventIds.PROCEED_EVENT_ID

Field Summary

Fields

Modifier and Type	Field and Description
private Function<org.opensaml.profile.context.ProfileRequestContext,AuditContext>	auditContextLookupStrategy Strategy used to locate the AuditContext associated with a given ProfileRequestContext.
private AuditContext	auditCtx The AuditContext to operate on.
private String	dateTimeFormat Formatting string for DateTime fields.
private Map<String,List<String>>	formattingMap Map of log category to formatting tokens and literals to output.
private HttpServletRequest	httpRequest HttpServletRequest object.
private org.slf4j.Logger	log Class logger.
private org.springframework.webflow.execution.RequestContext	requestContext The Spring RequestContext to operate on.
private boolean	useDefaultTimeZone Convert DateTime fields to default time zone.
private static DateTimeFormatter	v2Formatter Formatter used to convert timestamps to strings.

Constructor Summary

Constructors

Constructor and Description
WriteAuditLog() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
protected org.springframework.webflow.execution.Event	doExecute(org.springframework.webflow.execution.RequestContext springRequestContext, org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
protected void	filter(StringBuilder entry) Optional override to filter the outgoing log message, does nothing by default.
Map<String,List<String>>	getFormattingMap() Get the map of logging category to formatting tokens for log entries.
void	setAuditContextLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,AuditContext> strategy) Set the strategy used to locate the AuditContext associated with a given ProfileRequestContext.
void	setDateTimeFormat(String format) Set the DateTime formatting string to apply when extracting DateTime-valued fields.
void	setFormattingMap(Map<String,String> map) Set the map of logging category to formatting strings for log entries.
void	setUseDefaultTimeZone(boolean flag) Convert DateTime-valued fields to default time zone.

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

execute, getMessage, getMessage, getMessage, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

v2Formatter

private static DateTimeFormatter v2Formatter

Formatter used to convert timestamps to strings.

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

auditContextLookupStrategy

@Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,AuditContext> auditContextLookupStrategy

Strategy used to locate the AuditContext associated with a given ProfileRequestContext.

formattingMap

@Nonnull
@NotEmpty
private Map<String,List<String>> formattingMap

Map of log category to formatting tokens and literals to output.

dateTimeFormat

@Nullable
private String dateTimeFormat

Formatting string for DateTime fields.

useDefaultTimeZone

private boolean useDefaultTimeZone

Convert DateTime fields to default time zone.

requestContext

@Nullable
private org.springframework.webflow.execution.RequestContext requestContext

The Spring RequestContext to operate on.

auditCtx

@Nullable
private AuditContext auditCtx

The AuditContext to operate on.

httpRequest

@Nullable
private HttpServletRequest httpRequest

HttpServletRequest object.

Constructor Detail

WriteAuditLog

public WriteAuditLog()

Constructor.

Method Detail

setAuditContextLookupStrategy

public void setAuditContextLookupStrategy(@Nonnull
                                 Function<org.opensaml.profile.context.ProfileRequestContext,AuditContext> strategy)

Set the strategy used to locate the AuditContext associated with a given ProfileRequestContext.

Parameters:

strategy - lookup strategy

getFormattingMap

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public Map<String,List<String>> getFormattingMap()

Get the map of logging category to formatting tokens for log entries.

Returns:

map of formatting tokens

setFormattingMap

public void setFormattingMap(@Nonnull@NonnullElements
                    Map<String,String> map)

Set the map of logging category to formatting strings for log entries.

A formatting string consists of tokens prefixed by '%' separated by any non-alphanumeric or whitespace. Tokens can contain any letter or number or a hyphen. Anything other than a token, including whitespace, is a literal.

Parameters:

map - map of categories to formatting strings

setDateTimeFormat

public void setDateTimeFormat(@Nullable@NotEmpty
                     String format)

Set the DateTime formatting string to apply when extracting DateTime-valued fields.

Parameters:

format - formatting string

setUseDefaultTimeZone

public void setUseDefaultTimeZone(boolean flag)

Convert DateTime-valued fields to default time zone.

Parameters:

flag - flag to set

doExecute

@Nonnull
protected org.springframework.webflow.execution.Event doExecute(@Nonnull
                                                            org.springframework.webflow.execution.RequestContext springRequestContext,
                                                            @Nonnull
                                                            org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

doPreExecute

protected boolean doPreExecute(@Nonnull
                   org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class org.opensaml.profile.action.AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
             org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class org.opensaml.profile.action.AbstractProfileAction

filter

protected void filter(@Nonnull
          StringBuilder entry)

Optional override to filter the outgoing log message, does nothing by default.

Parameters:

entry - log entry