Package org.opensaml.profile.action.impl

Class LogEvent

java.lang.Object

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

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.impl.LogEvent

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction

public class LogEvent
extends AbstractProfileAction

A profile action that logs an event if one is found in the profile request context.

Event:

EventIds.PROCEED_EVENT_ID

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,EventContext>	eventContextLookupStrategy	Strategy function for access to EventContext to check.
private org.slf4j.Logger	log	Class logger.
private Set<String>	suppressedEvents	Set of events to ignore for logging purposes.

Constructor Summary

Constructors

Constructor	Description
LogEvent()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)	Performs this action.
void	setEventContextLookupStrategy(Function<ProfileRequestContext,EventContext> strategy)	Set lookup strategy for EventContext to check.
void	setSuppressedEvents(Collection<String> events)	Set a collection of events to ignore for logging purposes.

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

doPostExecute, doPostExecute, doPreExecute, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, setHttpServletRequest, setHttpServletRequestSupplier, setHttpServletResponse, setHttpServletResponseSupplier

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.

eventContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,EventContext> eventContextLookupStrategy

Strategy function for access to EventContext to check.

suppressedEvents

@Nonnull
@NotEmpty
private Set<String> suppressedEvents

Set of events to ignore for logging purposes.

Constructor Detail

LogEvent

public LogEvent()

Constructor.

Method Detail

setEventContextLookupStrategy

public void setEventContextLookupStrategy(@Nonnull
                                          Function<ProfileRequestContext,EventContext> strategy)

Set lookup strategy for EventContext to check.

Parameters:

strategy - lookup strategy

setSuppressedEvents

public void setSuppressedEvents(@Nullable @NotEmpty
                                Collection<String> events)

Set a collection of events to ignore for logging purposes.

Parameters:

events - events to ignore

doExecute

protected void doExecute(@Nonnull
                         ProfileRequestContext profileRequestContext)

Performs this action. Actions must override this method to perform their work.

Overrides:

doExecute in class AbstractProfileAction

Parameters:

profileRequestContext - the current IdP profile request context