Package org.pac4j.saml.transport

Class Pac4jHTTPArtifactDecoder

  • All Implemented Interfaces:
    net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.component.UnmodifiableComponent, org.opensaml.messaging.decoder.MessageDecoder<org.opensaml.saml.common.SAMLObject>, org.opensaml.saml.common.binding.decoding.SAMLMessageDecoder
    public class Pac4jHTTPArtifactDecoder
extends org.opensaml.messaging.decoder.AbstractMessageDecoder<org.opensaml.saml.common.SAMLObject>
implements org.opensaml.saml.common.binding.decoding.SAMLMessageDecoder
    Decoder for the artifact binding: it's like the original HTTPArtifactDecoder but using a web context instead of the JEE HTTP servlet request.
    Since:
    3.8.0
    Author:
    Jerome LELEU

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void decode()
      protected void doDecode()
      protected void doDestroy()
      protected void doInitialize()
      org.opensaml.saml.saml2.binding.artifact.SAML2ArtifactBuilderFactory getArtifactBuilderFactory()
      Get the SAML 2 artifact builder factory.
      org.opensaml.saml.common.binding.EndpointResolver<org.opensaml.saml.saml2.metadata.ArtifactResolutionService> getArtifactEndpointResolver()
      Get the artifact endpoint resolver.
      org.opensaml.saml.common.binding.BindingDescriptor getBindingDescriptor()
      Get an optional BindingDescriptor to inject into SAMLBindingContext created.
      String getBindingURI()
      net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy getIdentifierGenerationStrategy()
      Get the identifier generation strategy.
      protected org.opensaml.core.xml.XMLObject getMessageToLog()
      Get the XMLObject which will be logged as the protocol message.
      net.shibboleth.utilities.java.support.xml.ParserPool getParserPool()
      Gets the parser pool used to deserialize incoming messages.
      QName getPeerEntityRole()
      Get the peer entity role QName.
      org.opensaml.saml.metadata.resolver.RoleDescriptorResolver getRoleDescriptorResolver()
      Get the role descriptor resolver.
      net.shibboleth.utilities.java.support.resolver.Resolver<String,​net.shibboleth.utilities.java.support.resolver.CriteriaSet> getSelfEntityIDResolver()
      Get the resolver for the self entityID.
      org.opensaml.soap.client.SOAPClient getSOAPClient()
      Get the SOAP client instance.
      String getSOAPClientSecurityConfigurationProfileId()
      Get the SOAP client security configuration profile ID to use.
      String getSOAPPipelineName()
      Get the name of the specific SOAP client message pipeline to use, for example with PipelineFactoryHttpSOAPClient.
      protected void logDecodedMessage()
      Log the decoded message to the protocol message logger.
      protected void populateBindingContext​(org.opensaml.messaging.context.MessageContext<org.opensaml.saml.common.SAMLObject> messageContext)
      Populate the context which carries information specific to this binding.
      void setArtifactBuilderFactory​(org.opensaml.saml.saml2.binding.artifact.SAML2ArtifactBuilderFactory factory)
      Set the SAML 2 artifact builder factory.
      void setArtifactEndpointResolver​(org.opensaml.saml.common.binding.EndpointResolver<org.opensaml.saml.saml2.metadata.ArtifactResolutionService> resolver)
      Set the artifact endpoint resolver.
      void setBindingDescriptor​(org.opensaml.saml.common.binding.BindingDescriptor descriptor)
      Set an optional BindingDescriptor to inject into SAMLBindingContext created.
      void setIdentifierGenerationStrategy​(net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy strategy)
      Set the identifier generation strategy.
      void setParserPool​(net.shibboleth.utilities.java.support.xml.ParserPool pool)
      Sets the parser pool used to deserialize incoming messages.
      void setPeerEntityRole​(QName role)
      Set the peer entity role QName.
      void setRoleDescriptorResolver​(org.opensaml.saml.metadata.resolver.RoleDescriptorResolver resolver)
      Set the role descriptor resolver.
      void setSelfEntityIDResolver​(net.shibboleth.utilities.java.support.resolver.Resolver<String,​net.shibboleth.utilities.java.support.resolver.CriteriaSet> resolver)
      Set the resolver for the self entityID.
      void setSOAPClient​(org.opensaml.soap.client.SOAPClient client)
      Set the SOAP client instance.
      void setSOAPClientSecurityConfigurationProfileId​(String profileId)
      Set the SOAP client security configuration profile ID to use.
      void setSOAPPipelineName​(String name)
      Set the name of the specific SOAP client message pipeline to use, for example with PipelineFactoryHttpSOAPClient.
      void setWebContext​(WebContext webContext)  

      • Methods inherited from class org.opensaml.messaging.decoder.AbstractMessageDecoder

        getMessageContext, setMessageContext

      • Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

        destroy, initialize, isDestroyed, isInitialized

      • Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

        destroy, isDestroyed

      • Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

        initialize, isInitialized

      • Methods inherited from interface org.opensaml.messaging.decoder.MessageDecoder

        getMessageContext

    • Constructor Detail

      • Pac4jHTTPArtifactDecoder

        public Pac4jHTTPArtifactDecoder()
        Constructor.

    • Method Detail

      • decode

        public void decode()
            throws org.opensaml.messaging.decoder.MessageDecodingException
        Specified by:
        decode in interface org.opensaml.messaging.decoder.MessageDecoder<org.opensaml.saml.common.SAMLObject>
        Overrides:
        decode in class org.opensaml.messaging.decoder.AbstractMessageDecoder<org.opensaml.saml.common.SAMLObject>
        Throws:
        org.opensaml.messaging.decoder.MessageDecodingException

      • getParserPool

        @Nonnull
public net.shibboleth.utilities.java.support.xml.ParserPool getParserPool()
        Gets the parser pool used to deserialize incoming messages.
        Returns:
        parser pool used to deserialize incoming messages

      • setParserPool

        public void setParserPool​(@Nonnull
                          net.shibboleth.utilities.java.support.xml.ParserPool pool)
        Sets the parser pool used to deserialize incoming messages.
        Parameters:
        pool - parser pool used to deserialize incoming messages

      • doDestroy

        protected void doDestroy()
        Overrides:
        doDestroy in class org.opensaml.messaging.decoder.AbstractMessageDecoder<org.opensaml.saml.common.SAMLObject>

      • 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

      • getIdentifierGenerationStrategy

        @NonnullAfterInit
public net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy getIdentifierGenerationStrategy()
        Get the identifier generation strategy.
        Returns:
        Returns the identifier generation strategy

      • setIdentifierGenerationStrategy

        public void setIdentifierGenerationStrategy​(@Nullable
                                            net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy strategy)
        Set the identifier generation strategy.
        Parameters:
        strategy - the identifier generation strategy

      • getSelfEntityIDResolver

        @NonnullAfterInit
public net.shibboleth.utilities.java.support.resolver.Resolver<String,​net.shibboleth.utilities.java.support.resolver.CriteriaSet> getSelfEntityIDResolver()
        Get the resolver for the self entityID.
        Returns:
        the resolver

      • setSelfEntityIDResolver

        public void setSelfEntityIDResolver​(@Nonnull
                                    net.shibboleth.utilities.java.support.resolver.Resolver<String,​net.shibboleth.utilities.java.support.resolver.CriteriaSet> resolver)
        Set the resolver for the self entityID.
        Parameters:
        resolver - the resolver instance

      • getPeerEntityRole

        @NonnullAfterInit
public QName getPeerEntityRole()
        Get the peer entity role QName.
        Returns:
        the peer entity role

      • setPeerEntityRole

        public void setPeerEntityRole​(@Nonnull
                              QName role)
        Set the peer entity role QName.
        Parameters:
        role - the peer entity role

      • getArtifactEndpointResolver

        @NonnullAfterInit
public org.opensaml.saml.common.binding.EndpointResolver<org.opensaml.saml.saml2.metadata.ArtifactResolutionService> getArtifactEndpointResolver()
        Get the artifact endpoint resolver.
        Returns:
        the endpoint resolver

      • setArtifactEndpointResolver

        public void setArtifactEndpointResolver​(@Nullable
                                        org.opensaml.saml.common.binding.EndpointResolver<org.opensaml.saml.saml2.metadata.ArtifactResolutionService> resolver)
        Set the artifact endpoint resolver.
        Parameters:
        resolver - the new resolver

      • getRoleDescriptorResolver

        @NonnullAfterInit
public org.opensaml.saml.metadata.resolver.RoleDescriptorResolver getRoleDescriptorResolver()
        Get the role descriptor resolver.

        Must be capable of resolving descriptors based on ArtifactCriterion.

        Returns:
        the role descriptor resolver

      • setRoleDescriptorResolver

        public void setRoleDescriptorResolver​(@Nullable
                                      org.opensaml.saml.metadata.resolver.RoleDescriptorResolver resolver)
        Set the role descriptor resolver.

        Must be capable of resolving descriptors based on ArtifactCriterion.

        Parameters:
        resolver - the role descriptor resolver

      • getArtifactBuilderFactory

        @NonnullAfterInit
public org.opensaml.saml.saml2.binding.artifact.SAML2ArtifactBuilderFactory getArtifactBuilderFactory()
        Get the SAML 2 artifact builder factory.
        Returns:
        the artifact builder factory in use

      • setArtifactBuilderFactory

        public void setArtifactBuilderFactory​(@Nullable
                                      org.opensaml.saml.saml2.binding.artifact.SAML2ArtifactBuilderFactory factory)
        Set the SAML 2 artifact builder factory.
        Parameters:
        factory - the artifact builder factory

      • getSOAPClient

        @NonnullAfterInit
public org.opensaml.soap.client.SOAPClient getSOAPClient()
        Get the SOAP client instance.
        Returns:
        the SOAP client

      • setSOAPClient

        public void setSOAPClient​(@Nonnull
                          org.opensaml.soap.client.SOAPClient client)
        Set the SOAP client instance.
        Parameters:
        client - the SOAP client

      • getSOAPPipelineName

        @Nullable
public String getSOAPPipelineName()
        Get the name of the specific SOAP client message pipeline to use, for example with PipelineFactoryHttpSOAPClient.
        Returns:
        the pipeline name, or null

      • setSOAPPipelineName

        public void setSOAPPipelineName​(@Nullable
                                String name)
        Set the name of the specific SOAP client message pipeline to use, for example with PipelineFactoryHttpSOAPClient.
        Parameters:
        name - the pipeline name, or null

      • getSOAPClientSecurityConfigurationProfileId

        @Nullable
public String getSOAPClientSecurityConfigurationProfileId()
        Get the SOAP client security configuration profile ID to use.
        Returns:
        the client security configuration profile ID, or null

      • setSOAPClientSecurityConfigurationProfileId

        @Nonnull
public void setSOAPClientSecurityConfigurationProfileId​(@Nullable
                                                        String profileId)
        Set the SOAP client security configuration profile ID to use.
        Parameters:
        profileId - the profile ID, or null

      • getBindingURI

        @Nonnull
@NotEmpty
public String getBindingURI()
        Specified by:
        getBindingURI in interface org.opensaml.saml.common.binding.decoding.SAMLMessageDecoder

      • getBindingDescriptor

        @Nullable
public org.opensaml.saml.common.binding.BindingDescriptor getBindingDescriptor()
        Get an optional BindingDescriptor to inject into SAMLBindingContext created.
        Returns:
        binding descriptor

      • setBindingDescriptor

        public void setBindingDescriptor​(@Nullable
                                 org.opensaml.saml.common.binding.BindingDescriptor descriptor)
        Set an optional BindingDescriptor to inject into SAMLBindingContext created.
        Parameters:
        descriptor - a binding descriptor

      • doDecode

        protected void doDecode()
                 throws org.opensaml.messaging.decoder.MessageDecodingException
        Specified by:
        doDecode in class org.opensaml.messaging.decoder.AbstractMessageDecoder<org.opensaml.saml.common.SAMLObject>
        Throws:
        org.opensaml.messaging.decoder.MessageDecodingException

      • populateBindingContext

        protected void populateBindingContext​(org.opensaml.messaging.context.MessageContext<org.opensaml.saml.common.SAMLObject> messageContext)
        Populate the context which carries information specific to this binding.
        Parameters:
        messageContext - the current message context

      • logDecodedMessage

        protected void logDecodedMessage()
        Log the decoded message to the protocol message logger.

      • getMessageToLog

        protected org.opensaml.core.xml.XMLObject getMessageToLog()
        Get the XMLObject which will be logged as the protocol message.
        Returns:
        the XMLObject message considered to be the protocol message for logging purposes