Package org.pac4j.saml.sso.artifact

Class DefaultSOAPPipelineFactory

java.lang.Object

org.pac4j.saml.sso.artifact.DefaultSOAPPipelineFactory

All Implemented Interfaces:

org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipelineFactory

public class DefaultSOAPPipelineFactory
extends Object
implements org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipelineFactory

A default implementation of the pipeline factory, which enforces the rules set by the web SSO profile. To add additional handlers, you can override getInboundHandlers(), getOutboundPayloadHandlers() and/or getOutboundTransportHandlers(). To modify the configuration of a specific handler, override the build method for that handler.

Since:

3.8.0

Author:

bidou

Field Summary

Fields

Modifier and Type	Field	Description
protected final SAML2Configuration	configuration
protected final SAML2MetadataResolver	idpMetadataResolver
protected final ReplayCacheProvider	replayCache
protected final SAML2SignatureTrustEngineProvider	signatureTrustEngineProvider
protected final SignatureSigningParametersProvider	signingParametersProvider
protected final SAML2MetadataResolver	spMetadataResolver

Constructor Summary

Constructors

Constructor	Description
DefaultSOAPPipelineFactory(SAML2Configuration configuration, SAML2MetadataResolver idpMetadataResolver, SAML2MetadataResolver spMetadataResolver, SignatureSigningParametersProvider signingParametersProvider, SAML2SignatureTrustEngineProvider signatureTrustEngineProvider, ReplayCacheProvider replayCache)	Constructor for DefaultSOAPPipelineFactory.

Method Summary

Modifier and Type	Method	Description
protected org.opensaml.messaging.handler.MessageHandler	buildCheckAndRecordServerTLSEntityAuthenticationtHandler()	buildCheckAndRecordServerTLSEntityAuthenticationtHandler.
protected org.opensaml.messaging.handler.MessageHandler	buildCheckExpectedIssuer()	buildCheckExpectedIssuer.
protected org.opensaml.messaging.handler.MessageHandler	buildCheckMandatoryAuthentication()	buildCheckMandatoryAuthentication.
protected org.opensaml.messaging.handler.MessageHandler	buildCheckMandatoryIssuer()	buildCheckMandatoryIssuer.
protected org.opensaml.messaging.handler.MessageHandler	buildCheckMessageVersionHandler()	buildCheckMessageVersionHandler.
protected org.opensaml.messaging.handler.MessageHandler	buildInResponseToSecurityHandler()	buildInResponseToSecurityHandler.
protected org.opensaml.messaging.handler.MessageHandler	buildMessageLifetimeSecurityHandler()	buildMessageLifetimeSecurityHandler.
protected org.opensaml.messaging.handler.MessageHandler	buildMessageReplaySecurityHandler()	buildMessageReplaySecurityHandler.
protected org.opensaml.messaging.handler.MessageHandler	buildPopulateSignatureSigningParametersHandler()	buildPopulateSignatureSigningParametersHandler.
protected org.opensaml.messaging.handler.MessageHandler	buildPopulateSignatureValidationParametersHandler()	buildPopulateSignatureValidationParametersHandler.
protected org.opensaml.messaging.handler.MessageHandler	buildSAMLMetadataLookupHandler(SAML2MetadataResolver metadataResolver)	buildSAMLMetadataLookupHandler.
protected org.opensaml.messaging.handler.MessageHandler	buildSAMLOutboundProtocolMessageSigningHandler()	buildSAMLOutboundProtocolMessageSigningHandler.
protected org.opensaml.messaging.handler.MessageHandler	buildSAMLProtocolAndRoleHandler(QName roleName)	buildSAMLProtocolAndRoleHandler.
protected org.opensaml.messaging.handler.MessageHandler	buildSAMLProtocolMessageXMLSignatureSecurityHandler()	buildSAMLProtocolMessageXMLSignatureSecurityHandler.
protected org.opensaml.messaging.handler.MessageHandler	buildSAMLSOAPDecoderBodyHandler()	buildSAMLSOAPDecoderBodyHandler.
protected org.opensaml.messaging.handler.MessageHandler	buildSchemaValidateXMLMessage()	buildSchemaValidateXMLMessage.
protected List<org.opensaml.messaging.handler.MessageHandler>	getInboundHandlers()	getInboundHandlers.
protected List<org.opensaml.messaging.handler.MessageHandler>	getOutboundPayloadHandlers()	getOutboundPayloadHandlers.
protected List<org.opensaml.messaging.handler.MessageHandler>	getOutboundTransportHandlers()	getOutboundTransportHandlers.
org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipeline	newInstance()
org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipeline	newInstance(String pipelineName)
protected org.opensaml.messaging.handler.impl.BasicMessageHandlerChain	toHandlerChain(List<org.opensaml.messaging.handler.MessageHandler> handlers)	toHandlerChain.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

configuration

protected final SAML2Configuration configuration

idpMetadataResolver

protected final SAML2MetadataResolver idpMetadataResolver

spMetadataResolver

protected final SAML2MetadataResolver spMetadataResolver

signingParametersProvider

protected final SignatureSigningParametersProvider signingParametersProvider

signatureTrustEngineProvider

protected final SAML2SignatureTrustEngineProvider signatureTrustEngineProvider

replayCache

protected final ReplayCacheProvider replayCache

Constructor Details

DefaultSOAPPipelineFactory

public DefaultSOAPPipelineFactory(SAML2Configuration configuration,
 SAML2MetadataResolver idpMetadataResolver,
 SAML2MetadataResolver spMetadataResolver,
 SignatureSigningParametersProvider signingParametersProvider,
 SAML2SignatureTrustEngineProvider signatureTrustEngineProvider,
 ReplayCacheProvider replayCache)

Constructor for DefaultSOAPPipelineFactory.

Parameters:

configuration - a SAML2Configuration object

idpMetadataResolver - a SAML2MetadataResolver object

spMetadataResolver - a SAML2MetadataResolver object

signingParametersProvider - a SignatureSigningParametersProvider object

signatureTrustEngineProvider - a SAML2SignatureTrustEngineProvider object

replayCache - a ReplayCacheProvider object

Method Details

getInboundHandlers

protected List<org.opensaml.messaging.handler.MessageHandler> getInboundHandlers()
                                                                          throws net.shibboleth.shared.component.ComponentInitializationException

getInboundHandlers.

Returns:

a List object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

getOutboundPayloadHandlers

protected List<org.opensaml.messaging.handler.MessageHandler> getOutboundPayloadHandlers()
                                                                                  throws net.shibboleth.shared.component.ComponentInitializationException

getOutboundPayloadHandlers.

Returns:

a List object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

getOutboundTransportHandlers

protected List<org.opensaml.messaging.handler.MessageHandler> getOutboundTransportHandlers()
                                                                                    throws net.shibboleth.shared.component.ComponentInitializationException

getOutboundTransportHandlers.

Returns:

a List object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildSAMLProtocolAndRoleHandler

protected org.opensaml.messaging.handler.MessageHandler buildSAMLProtocolAndRoleHandler(QName roleName)
                                                                                 throws net.shibboleth.shared.component.ComponentInitializationException

buildSAMLProtocolAndRoleHandler.

Parameters:

roleName - a QName object

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildSAMLMetadataLookupHandler

protected org.opensaml.messaging.handler.MessageHandler buildSAMLMetadataLookupHandler(SAML2MetadataResolver metadataResolver)
                                                                                throws net.shibboleth.shared.component.ComponentInitializationException

buildSAMLMetadataLookupHandler.

Parameters:

metadataResolver - a SAML2MetadataResolver object

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildSchemaValidateXMLMessage

protected org.opensaml.messaging.handler.MessageHandler buildSchemaValidateXMLMessage()
                                                                               throws net.shibboleth.shared.component.ComponentInitializationException

buildSchemaValidateXMLMessage.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildCheckMessageVersionHandler

protected org.opensaml.messaging.handler.MessageHandler buildCheckMessageVersionHandler()
                                                                                 throws net.shibboleth.shared.component.ComponentInitializationException

buildCheckMessageVersionHandler.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildMessageLifetimeSecurityHandler

protected org.opensaml.messaging.handler.MessageHandler buildMessageLifetimeSecurityHandler()
                                                                                     throws net.shibboleth.shared.component.ComponentInitializationException

buildMessageLifetimeSecurityHandler.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildInResponseToSecurityHandler

protected org.opensaml.messaging.handler.MessageHandler buildInResponseToSecurityHandler()
                                                                                  throws net.shibboleth.shared.component.ComponentInitializationException

buildInResponseToSecurityHandler.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildMessageReplaySecurityHandler

protected org.opensaml.messaging.handler.MessageHandler buildMessageReplaySecurityHandler()
                                                                                   throws net.shibboleth.shared.component.ComponentInitializationException

buildMessageReplaySecurityHandler.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildCheckMandatoryIssuer

protected org.opensaml.messaging.handler.MessageHandler buildCheckMandatoryIssuer()
                                                                           throws net.shibboleth.shared.component.ComponentInitializationException

buildCheckMandatoryIssuer.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildCheckExpectedIssuer

protected org.opensaml.messaging.handler.MessageHandler buildCheckExpectedIssuer()
                                                                          throws net.shibboleth.shared.component.ComponentInitializationException

buildCheckExpectedIssuer.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildPopulateSignatureSigningParametersHandler

protected org.opensaml.messaging.handler.MessageHandler buildPopulateSignatureSigningParametersHandler()
                                                                                                throws net.shibboleth.shared.component.ComponentInitializationException

buildPopulateSignatureSigningParametersHandler.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildPopulateSignatureValidationParametersHandler

protected org.opensaml.messaging.handler.MessageHandler buildPopulateSignatureValidationParametersHandler()
                                                                                                   throws net.shibboleth.shared.component.ComponentInitializationException

buildPopulateSignatureValidationParametersHandler.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildSAMLProtocolMessageXMLSignatureSecurityHandler

protected org.opensaml.messaging.handler.MessageHandler buildSAMLProtocolMessageXMLSignatureSecurityHandler()
                                                                                                     throws net.shibboleth.shared.component.ComponentInitializationException

buildSAMLProtocolMessageXMLSignatureSecurityHandler.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildCheckAndRecordServerTLSEntityAuthenticationtHandler

protected org.opensaml.messaging.handler.MessageHandler buildCheckAndRecordServerTLSEntityAuthenticationtHandler()
                                                                                                          throws net.shibboleth.shared.component.ComponentInitializationException

buildCheckAndRecordServerTLSEntityAuthenticationtHandler.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildCheckMandatoryAuthentication

protected org.opensaml.messaging.handler.MessageHandler buildCheckMandatoryAuthentication()

buildCheckMandatoryAuthentication.

Returns:

a MessageHandler object

buildSAMLSOAPDecoderBodyHandler

protected org.opensaml.messaging.handler.MessageHandler buildSAMLSOAPDecoderBodyHandler()
                                                                                 throws net.shibboleth.shared.component.ComponentInitializationException

buildSAMLSOAPDecoderBodyHandler.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

buildSAMLOutboundProtocolMessageSigningHandler

protected org.opensaml.messaging.handler.MessageHandler buildSAMLOutboundProtocolMessageSigningHandler()
                                                                                                throws net.shibboleth.shared.component.ComponentInitializationException

buildSAMLOutboundProtocolMessageSigningHandler.

Returns:

a MessageHandler object

Throws:

net.shibboleth.shared.component.ComponentInitializationException - if any.

toHandlerChain

protected org.opensaml.messaging.handler.impl.BasicMessageHandlerChain toHandlerChain(List<org.opensaml.messaging.handler.MessageHandler> handlers)

toHandlerChain.

Parameters:

handlers - a List object

Returns:

a BasicMessageHandlerChain object

newInstance

public org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipeline newInstance()

Specified by:

newInstance in interface org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipelineFactory

newInstance

public org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipeline newInstance(String pipelineName)

Specified by:

newInstance in interface org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipelineFactory