Package net.shibboleth.sp.profile.impl

Class WriteAuditLog

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

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

net.shibboleth.sp.profile.impl.WriteAuditLog

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class WriteAuditLog
extends WriteAuditLog

Subclass of IdP auditing action that overrides the HttpServletRequest accessor to bypass the "non-null" assumptions built into our profile action classes. This is an "alternative" means of getting the remoted request into the execution code and is necessary when the object may be absent.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,EventContext>	eventContextLookupStrategy	Strategy function for access to EventContext to check.

Constructor Summary

Constructors

Constructor	Description
WriteAuditLog()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected String	getEvent(ProfileRequestContext profileRequestContext)	This is a "new" method intended to override something that the base class in 5.2 doesn't call but the base class in 5.3 will.
HttpServletRequest	getHttpServletRequest()
void	setEventContextLookupStrategy(Function<ProfileRequestContext,EventContext> strategy)	Set lookup strategy for EventContext to check.

Methods inherited from class net.shibboleth.idp.profile.audit.impl.WriteAuditLog

doExecute, doExecute, doInitialize, doPreExecute, filter, getFormattingMap, setAuditContextLookupStrategy, setCategoriesToLog, setDateTimeFormat, setFormattingMap, setIncludeProfileLoggingId, setUseDefaultTimeZone

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

execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, 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, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, 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.shared.component.InitializableComponent

initialize, isInitialized

Field Details

eventContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,EventContext> eventContextLookupStrategy

Strategy function for access to EventContext to check.

Constructor Details

WriteAuditLog

public WriteAuditLog()

Constructor.

Method Details

setEventContextLookupStrategy

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

Set lookup strategy for EventContext to check.

Parameters:

strategy - lookup strategy

getHttpServletRequest

@Nullable
public HttpServletRequest getHttpServletRequest()

Overrides:

getHttpServletRequest in class AbstractProfileAction

getEvent

@Nullable
protected String getEvent(@Nonnull
 ProfileRequestContext profileRequestContext)

This is a "new" method intended to override something that the base class in 5.2 doesn't call but the base class in 5.3 will.

Parameters:

profileRequestContext - profile request context

Returns:

event to log