Package net.shibboleth.idp.plugin.authn.oidc.rp.audit.impl

Class TransitionActionWriteAuditLog

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.plugin.authn.oidc.rp.audit.impl.TransitionActionWriteAuditLog

All Implemented Interfaces:

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

public class TransitionActionWriteAuditLog
extends AbstractProfileAction

An action that decorates the WriteAuditLog action to produce a "success" event such that it can be run inside a transition and the transition can proceed.

In Spring WebFlow, actions that are executed inside a transition must return an event ID based on one of the trueEventIds described by the ActionTransitionCriteria criteria. These are "success", "yes", or "true". Any other event ID will prevent the transition from executing, returning you to the previous state.

Field Summary

Fields

Modifier and Type	Field	Description
private RequestContext	requestContext	The Spring RequestContext to operate on.
private WriteAuditLog	writeAuditLogAction	Optional audit output action.

Constructor Summary

Constructors

Constructor	Description
TransitionActionWriteAuditLog()

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected Event	doExecute(RequestContext springRequestContext, ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setWriteAuditLogAction(WriteAuditLog action)	Sets an audit output action to run.

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

writeAuditLogAction

@NonnullAfterInit
private WriteAuditLog writeAuditLogAction

Optional audit output action.

requestContext

@Nullable
private RequestContext requestContext

The Spring RequestContext to operate on.

Constructor Details

TransitionActionWriteAuditLog

public TransitionActionWriteAuditLog()

Method Details

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

setWriteAuditLogAction

public void setWriteAuditLogAction(@Nonnull
 WriteAuditLog action)

Sets an audit output action to run.

Parameters:

action - action to use to write to audit log

doExecute

protected Event doExecute(@Nonnull
 RequestContext springRequestContext,
 @Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction