org.opensaml.saml.common.binding.impl

Class PopulateSignatureSigningParametersHandler

java.lang.Object

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

org.opensaml.messaging.handler.AbstractMessageHandler

org.opensaml.saml.common.binding.impl.PopulateSignatureSigningParametersHandler

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.opensaml.messaging.handler.MessageHandler

public class PopulateSignatureSigningParametersHandler
extends org.opensaml.messaging.handler.AbstractMessageHandler

Handler that resolves and populates SignatureSigningParameters on a SecurityParametersContext created/accessed via a lookup function, by default as an immediate child context of the target MessageContext.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.base.Function<org.opensaml.messaging.context.MessageContext,List<org.opensaml.xmlsec.SignatureSigningConfiguration>>	configurationLookupStrategy Strategy used to look up a per-request SignatureSigningConfiguration list.
private com.google.common.base.Function<org.opensaml.messaging.context.MessageContext,org.opensaml.xmlsec.context.SecurityParametersContext>	existingParametersContextLookupStrategy Strategy used to look up an existing SecurityParametersContext to copy.
private Logger	log Class logger.
private com.google.common.base.Function<org.opensaml.messaging.context.MessageContext,SAMLMetadataContext>	metadataContextLookupStrategy Strategy used to look up a SAML metadata context.
private boolean	noResultIsError Whether failure to resolve parameters should be raised as an error.
private org.opensaml.xmlsec.SignatureSigningParametersResolver	resolver Resolver for parameters to store into context.
private com.google.common.base.Function<org.opensaml.messaging.context.MessageContext,org.opensaml.xmlsec.context.SecurityParametersContext>	securityParametersContextLookupStrategy Strategy used to look up the SecurityParametersContext to set the parameters for.

Constructor Summary

Constructors

Constructor and Description
PopulateSignatureSigningParametersHandler() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
protected void	doInvoke(org.opensaml.messaging.context.MessageContext messageContext)
protected boolean	doPreInvoke(org.opensaml.messaging.context.MessageContext messageContext)
void	setConfigurationLookupStrategy(com.google.common.base.Function<org.opensaml.messaging.context.MessageContext,List<org.opensaml.xmlsec.SignatureSigningConfiguration>> strategy) Set the strategy used to look up a per-request SignatureSigningConfiguration list.
void	setExistingParametersContextLookupStrategy(com.google.common.base.Function<org.opensaml.messaging.context.MessageContext,org.opensaml.xmlsec.context.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<org.opensaml.messaging.context.MessageContext,SAMLMetadataContext> strategy) Set lookup strategy for SAMLMetadataContext for input to resolution.
void	setNoResultIsError(boolean flag) Set whether a failure to resolve any parameters should be raised as an exception.
void	setSecurityParametersContextLookupStrategy(com.google.common.base.Function<org.opensaml.messaging.context.MessageContext,org.opensaml.xmlsec.context.SecurityParametersContext> strategy) Set the strategy used to look up the SecurityParametersContext to set the parameters for.
void	setSignatureSigningParametersResolver(org.opensaml.xmlsec.SignatureSigningParametersResolver newResolver) Set the resolver to use for the parameters to store into the context.

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, setActivationCondition

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 Logger log

Class logger.

securityParametersContextLookupStrategy

@Nonnull
private com.google.common.base.Function<org.opensaml.messaging.context.MessageContext,org.opensaml.xmlsec.context.SecurityParametersContext> securityParametersContextLookupStrategy

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

existingParametersContextLookupStrategy

@Nullable
private com.google.common.base.Function<org.opensaml.messaging.context.MessageContext,org.opensaml.xmlsec.context.SecurityParametersContext> existingParametersContextLookupStrategy

Strategy used to look up an existing SecurityParametersContext to copy.

configurationLookupStrategy

@NonnullAfterInit
private com.google.common.base.Function<org.opensaml.messaging.context.MessageContext,List<org.opensaml.xmlsec.SignatureSigningConfiguration>> configurationLookupStrategy

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

metadataContextLookupStrategy

@Nullable
private com.google.common.base.Function<org.opensaml.messaging.context.MessageContext,SAMLMetadataContext> metadataContextLookupStrategy

Strategy used to look up a SAML metadata context.

resolver

@NonnullAfterInit
private org.opensaml.xmlsec.SignatureSigningParametersResolver resolver

Resolver for parameters to store into context.

noResultIsError

private boolean noResultIsError

Whether failure to resolve parameters should be raised as an error.

Constructor Detail

PopulateSignatureSigningParametersHandler

public PopulateSignatureSigningParametersHandler()

Constructor.

Method Detail

setSecurityParametersContextLookupStrategy

public void setSecurityParametersContextLookupStrategy(@Nonnull
                                              com.google.common.base.Function<org.opensaml.messaging.context.MessageContext,org.opensaml.xmlsec.context.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<org.opensaml.messaging.context.MessageContext,org.opensaml.xmlsec.context.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<org.opensaml.messaging.context.MessageContext,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<org.opensaml.messaging.context.MessageContext,List<org.opensaml.xmlsec.SignatureSigningConfiguration>> strategy)

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

Parameters:

strategy - lookup strategy

setSignatureSigningParametersResolver

public void setSignatureSigningParametersResolver(@Nonnull
                                         org.opensaml.xmlsec.SignatureSigningParametersResolver newResolver)

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

Parameters:

newResolver - resolver to use

setNoResultIsError

public void setNoResultIsError(boolean flag)

Set whether a failure to resolve any parameters should be raised as an exception.

Defaults to false.

Parameters:

flag - flag to set

Since:

3.4.0

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

doPreInvoke

protected boolean doPreInvoke(@Nonnull
                  org.opensaml.messaging.context.MessageContext messageContext)
                       throws org.opensaml.messaging.handler.MessageHandlerException

Overrides:

doPreInvoke in class org.opensaml.messaging.handler.AbstractMessageHandler

Throws:

org.opensaml.messaging.handler.MessageHandlerException

doInvoke

protected void doInvoke(@Nonnull
            org.opensaml.messaging.context.MessageContext messageContext)
                 throws org.opensaml.messaging.handler.MessageHandlerException

Specified by:

doInvoke in class org.opensaml.messaging.handler.AbstractMessageHandler

Throws:

org.opensaml.messaging.handler.MessageHandlerException