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<org.opensaml.saml.common.SAMLObject,org.opensaml.saml.common.SAMLObject>

public class DefaultSOAPPipelineFactory
extends Object
implements org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipelineFactory<org.opensaml.saml.common.SAMLObject,org.opensaml.saml.common.SAMLObject>

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

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 Detail

DefaultSOAPPipelineFactory

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

Method Detail

getInboundHandlers

protected List<org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject>> getInboundHandlers()
                                                                                                               throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

getOutboundPayloadHandlers

protected List<org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject>> getOutboundPayloadHandlers()
                                                                                                                       throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

getOutboundTransportHandlers

protected List<org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject>> getOutboundTransportHandlers()
                                                                                                                         throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildSAMLProtocolAndRoleHandler

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildSAMLProtocolAndRoleHandler(QName roleName)
                                                                                                                      throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildSAMLMetadataLookupHandler

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildSAMLMetadataLookupHandler(SAML2MetadataResolver metadataResolver)
                                                                                                                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildSchemaValidateXMLMessage

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildSchemaValidateXMLMessage()
                                                                                                                    throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildCheckMessageVersionHandler

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildCheckMessageVersionHandler()
                                                                                                                      throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildMessageLifetimeSecurityHandler

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildMessageLifetimeSecurityHandler()
                                                                                                                          throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildInResponseToSecurityHandler

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildInResponseToSecurityHandler()
                                                                                                                       throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildMessageReplaySecurityHandler

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildMessageReplaySecurityHandler()
                                                                                                                        throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildCheckMandatoryIssuer

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildCheckMandatoryIssuer()
                                                                                                                throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildCheckExpectedIssuer

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildCheckExpectedIssuer()
                                                                                                               throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildPopulateSignatureSigningParametersHandler

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildPopulateSignatureSigningParametersHandler()
                                                                                                                                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildPopulateSignatureValidationParametersHandler

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildPopulateSignatureValidationParametersHandler()
                                                                                                                                        throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildSAMLProtocolMessageXMLSignatureSecurityHandler

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildSAMLProtocolMessageXMLSignatureSecurityHandler()
                                                                                                                                          throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildCheckAndRecordServerTLSEntityAuthenticationtHandler

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildCheckAndRecordServerTLSEntityAuthenticationtHandler()
                                                                                                                                               throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildCheckMandatoryAuthentication

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildCheckMandatoryAuthentication()

buildSAMLSOAPDecoderBodyHandler

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildSAMLSOAPDecoderBodyHandler()
                                                                                                                      throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

buildSAMLOutboundProtocolMessageSigningHandler

protected org.opensaml.messaging.handler.MessageHandler<org.opensaml.saml.common.SAMLObject> buildSAMLOutboundProtocolMessageSigningHandler()
                                                                                                                                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Throws:

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

toHandlerChain

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

newInstance

@Nonnull
public org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipeline<org.opensaml.saml.common.SAMLObject,org.opensaml.saml.common.SAMLObject> newInstance()

Specified by:

newInstance in interface org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipelineFactory<org.opensaml.saml.common.SAMLObject,org.opensaml.saml.common.SAMLObject>

newInstance

@Nonnull
public org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipeline<org.opensaml.saml.common.SAMLObject,org.opensaml.saml.common.SAMLObject> newInstance(@Nullable
                                                                                                                                                                       String pipelineName)

Specified by:

newInstance in interface org.opensaml.messaging.pipeline.httpclient.HttpClientMessagePipelineFactory<org.opensaml.saml.common.SAMLObject,org.opensaml.saml.common.SAMLObject>