org.opensaml.saml.common.profile.impl

Class PopulateSignatureSigningParameters

java.lang.Object

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

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

org.opensaml.profile.action.AbstractConditionalProfileAction

org.opensaml.saml.common.profile.impl.PopulateSignatureSigningParameters

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

public class PopulateSignatureSigningParameters
extends AbstractConditionalProfileAction

Action that resolves and populates SignatureSigningParameters on a SecurityParametersContext created/accessed via a lookup function, by default on the outbound message context.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.base.Function<ProfileRequestContext,java.util.List<SignatureSigningConfiguration>>	configurationLookupStrategy Strategy used to look up a per-request SignatureSigningConfiguration list.
private com.google.common.base.Function<ProfileRequestContext,SecurityParametersContext>	existingParametersContextLookupStrategy Strategy used to look up an existing SecurityParametersContext to copy.
private org.slf4j.Logger	log Class logger.
private com.google.common.base.Function<ProfileRequestContext,SAMLMetadataContext>	metadataContextLookupStrategy Strategy used to look up a SAML metadata context.
private SignatureSigningParametersResolver	resolver Resolver for parameters to store into context.
private com.google.common.base.Function<ProfileRequestContext,SecurityParametersContext>	securityParametersContextLookupStrategy Strategy used to look up the SecurityParametersContext to set the parameters for.

Constructor Summary

Constructors

Constructor and Description
PopulateSignatureSigningParameters() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doExecute(ProfileRequestContext profileRequestContext) Performs this action.
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext) Called prior to execution, actions may override this method to perform pre-processing for a request.
void	setConfigurationLookupStrategy(com.google.common.base.Function<ProfileRequestContext,java.util.List<SignatureSigningConfiguration>> strategy) Set the strategy used to look up a per-request SignatureSigningConfiguration list.
void	setExistingParametersContextLookupStrategy(com.google.common.base.Function<ProfileRequestContext,SecurityParametersContext> strategy) Set the strategy used to look up an existing SecurityParametersContext to copy instead of actually resolving the parameters to set.
void	setMetadataContextLookupStrategy(com.google.common.base.Function<ProfileRequestContext,SAMLMetadataContext> strategy) Set lookup strategy for SAMLMetadataContext for input to resolution.
void	setSecurityParametersContextLookupStrategy(com.google.common.base.Function<ProfileRequestContext,SecurityParametersContext> strategy) Set the strategy used to look up the SecurityParametersContext to set the parameters for.
void	setSignatureSigningParametersResolver(SignatureSigningParametersResolver newResolver) Set the resolver to use for the parameters to store into the context.

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

securityParametersContextLookupStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,SecurityParametersContext> securityParametersContextLookupStrategy

Strategy used to look up the SecurityParametersContext to set the parameters for.

existingParametersContextLookupStrategy

@Nullable
private com.google.common.base.Function<ProfileRequestContext,SecurityParametersContext> existingParametersContextLookupStrategy

Strategy used to look up an existing SecurityParametersContext to copy.

configurationLookupStrategy

@NonnullAfterInit
private com.google.common.base.Function<ProfileRequestContext,java.util.List<SignatureSigningConfiguration>> configurationLookupStrategy

Strategy used to look up a per-request SignatureSigningConfiguration list.

metadataContextLookupStrategy

@Nullable
private com.google.common.base.Function<ProfileRequestContext,SAMLMetadataContext> metadataContextLookupStrategy

Strategy used to look up a SAML metadata context.

resolver

@NonnullAfterInit
private SignatureSigningParametersResolver resolver

Resolver for parameters to store into context.

Constructor Detail

PopulateSignatureSigningParameters

public PopulateSignatureSigningParameters()

Constructor.

Method Detail

setSecurityParametersContextLookupStrategy

public void setSecurityParametersContextLookupStrategy(@Nonnull
                                                       com.google.common.base.Function<ProfileRequestContext,SecurityParametersContext> strategy)

Set the strategy used to look up the SecurityParametersContext to set the parameters for.

Parameters:

strategy - lookup strategy

setExistingParametersContextLookupStrategy

public void setExistingParametersContextLookupStrategy(@Nullable
                                                       com.google.common.base.Function<ProfileRequestContext,SecurityParametersContext> strategy)

Set the strategy used to look up an existing SecurityParametersContext to copy instead of actually resolving the parameters to set.

Parameters:

strategy - lookup strategy

setMetadataContextLookupStrategy

public void setMetadataContextLookupStrategy(@Nullable
                                             com.google.common.base.Function<ProfileRequestContext,SAMLMetadataContext> strategy)

Set lookup strategy for SAMLMetadataContext for input to resolution.

Parameters:

strategy - lookup strategy

setConfigurationLookupStrategy

public void setConfigurationLookupStrategy(@Nonnull
                                           com.google.common.base.Function<ProfileRequestContext,java.util.List<SignatureSigningConfiguration>> strategy)

Set the strategy used to look up a per-request SignatureSigningConfiguration list.

Parameters:

strategy - lookup strategy

setSignatureSigningParametersResolver

public void setSignatureSigningParametersResolver(@Nonnull
                                                  SignatureSigningParametersResolver newResolver)

Set the resolver to use for the parameters to store into the context.

Parameters:

newResolver - resolver to use

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
                               ProfileRequestContext 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 AbstractConditionalProfileAction

Parameters:

profileRequestContext - the current IdP profile request context

Returns:

true iff execution should proceed

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