org.opensaml.profile.action

Class AbstractConditionalProfileAction<InboundMessageType,OutboundMessageType>

java.lang.Object

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

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

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

Type Parameters:

InboundMessageType - type of in-bound message

OutboundMessageType - type of out-bound message

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, ProfileAction<InboundMessageType,OutboundMessageType>

Direct Known Subclasses:

AbstractEncryptAction, AddAudienceRestrictionToAssertions, AddChannelBindingsToAssertions, AddDoNotCacheConditionToAssertions, AddGeneratedKeyToAssertions, AddInResponseToToResponse, AddNotBeforeConditionToAssertions, AddNotOnOrAfterConditionToAssertions, AddOneTimeUseConditionToAssertions, AddProxyRestrictionToAssertions, PopulateDecryptionParameters, PopulateECPContext, PopulateSignatureSigningParameters

public abstract class AbstractConditionalProfileAction<InboundMessageType,OutboundMessageType>
extends AbstractProfileAction<InboundMessageType,OutboundMessageType>

Base class for conditional profile actions.

A condition does not represent a situation in which an error should be raised, but that normal processing should continue and the action simply doesn't apply, so a false condition does not raise a non-proceed event.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.base.Predicate<ProfileRequestContext>	activationCondition Condition dictating whether to run or not.

Constructor Summary

Constructors

Constructor and Description
AbstractConditionalProfileAction() Constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	doPreExecute(ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext) Called prior to execution, actions may override this method to perform pre-processing for a request.
com.google.common.base.Predicate<ProfileRequestContext>	getActivationCondition() Get activation condition indicating whether action should execute.
void	setActivationCondition(com.google.common.base.Predicate<ProfileRequestContext> condition) Set activation condition indicating whether action should execute.

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

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

activationCondition

@Nonnull
private com.google.common.base.Predicate<ProfileRequestContext> activationCondition

Condition dictating whether to run or not.

Constructor Detail

AbstractConditionalProfileAction

public AbstractConditionalProfileAction()

Constructor.

Method Detail

getActivationCondition

@Nonnull
public com.google.common.base.Predicate<ProfileRequestContext> getActivationCondition()

Get activation condition indicating whether action should execute.

Returns:

activation condition

setActivationCondition

public void setActivationCondition(@Nonnull
                                   com.google.common.base.Predicate<ProfileRequestContext> condition)

Set activation condition indicating whether action should execute.

Parameters:

condition - predicate to apply

doPreExecute

protected boolean doPreExecute(@Nonnull
                               ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)

Called prior to execution, actions may override this method to perform pre-processing for a request.

If false is returned, execution will not proceed, and the action should attach an EventContext to the context tree to signal how to continue with overall workflow processing.

If returning successfully, the last step should be to return the result of the superclass version of this method.

Overrides:

doPreExecute in class AbstractProfileAction<InboundMessageType,OutboundMessageType>

Parameters:

profileRequestContext - the current IdP profile request context

Returns:

true iff execution should proceed