net.shibboleth.idp.profile.audit.impl

Class PopulateAuditContext

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.PopulateAuditContext

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 PopulateAuditContext
extends AbstractProfileAction

Action that populates fields in an AuditContext using injected functions.

Each function is registered against a field specifier, and the result of the function is added to that field in the context's map. This reduces the code footprint required to implement, and extend, the fields logged, instead of requiring a dedicated action for a particular field or set of fields.

The eventual map of formatting strings is also provided in order to recognize which extractors actually need to be run.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX

Field Summary

Fields

Modifier and Type	Field and Description
private Function<org.opensaml.profile.context.ProfileRequestContext,AuditContext>	auditContextCreationStrategy Strategy used to locate or create the AuditContext to populate.
private AuditContext	auditCtx AuditContext to populate.
private String	dateTimeFormat Formatting string for DateTime fields.
private Map<String,Function<org.opensaml.profile.context.ProfileRequestContext,Object>>	fieldExtractors Map of fields to extract and the corresponding extraction functions.
private Map<String,String>	fieldReplacements Map allowing substitutions of values during field extraction.
private Set<String>	fieldsToExtract Fields being audited, to optimize extraction..
private org.slf4j.Logger	log Class logger.
private boolean	useDefaultTimeZone Convert DateTime fields to default time zone.

Constructor Summary

Constructors

Constructor and Description
PopulateAuditContext() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private void	addField(String key, Object value) Add a non-null field to the audit record.
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
void	setAuditContextCreationStrategy(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	setFieldExtractors(Map<String,Function<org.opensaml.profile.context.ProfileRequestContext,Object>> map) Set the map of fields and extraction functions to run.
void	setFieldReplacements(Map<String,String> map) Set the map of field values to replace, and the replacement values.
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

doExecute, 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

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

auditContextCreationStrategy

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

Strategy used to locate or create the AuditContext to populate.

fieldExtractors

@Nonnull
@NonnullElements
private Map<String,Function<org.opensaml.profile.context.ProfileRequestContext,Object>> fieldExtractors

Map of fields to extract and the corresponding extraction functions.

fieldsToExtract

@Nonnull
@NonnullElements
private Set<String> fieldsToExtract

Fields being audited, to optimize extraction..

fieldReplacements

@Nonnull
private Map<String,String> fieldReplacements

Map allowing substitutions of values during field extraction.

dateTimeFormat

@Nullable
private String dateTimeFormat

Formatting string for DateTime fields.

useDefaultTimeZone

private boolean useDefaultTimeZone

Convert DateTime fields to default time zone.

auditCtx

@Nullable
private AuditContext auditCtx

AuditContext to populate.

Constructor Detail

PopulateAuditContext

public PopulateAuditContext()

Constructor.

Method Detail

setAuditContextCreationStrategy

public void setAuditContextCreationStrategy(@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

setFieldExtractors

public void setFieldExtractors(@Nonnull@NonnullElements
                      Map<String,Function<org.opensaml.profile.context.ProfileRequestContext,Object>> map)

Set the map of fields and extraction functions to run.

Parameters:

map - map from field name to extraction function

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

setFieldReplacements

public void setFieldReplacements(@Nullable
                        Map<String,String> map)

Set the map of field values to replace, and the replacement values.

Parameters:

map - map of replacements

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

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

addField

private void addField(@Nonnull@NotEmpty
            String key,
            @Nullable
            Object value)

Add a non-null field to the audit record.

Parameters:

key - field label

value - value to add