Package org.opensaml.saml.saml1.binding.decoding.impl

Class HTTPArtifactDecoder

  • 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.messaging.decoder.servlet.HttpServletRequestMessageDecoder, org.opensaml.saml.common.binding.decoding.SAMLMessageDecoder
    public class HTTPArtifactDecoder
extends org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder
implements org.opensaml.saml.common.binding.decoding.SAMLMessageDecoder
    SAML 1.X HTTP Artifact message decoder. NOTE: This decoder is not yet implemented.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.opensaml.saml.common.binding.BindingDescriptor bindingDescriptor
      Optional BindingDescriptor to inject into SAMLBindingContext created.
      private org.slf4j.Logger log
      Class logger.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void decodeTarget​(org.opensaml.messaging.context.MessageContext messageContext, javax.servlet.http.HttpServletRequest request)
      Decodes the TARGET parameter and adds it to the message context.
      protected void doDecode()
      org.opensaml.saml.common.binding.BindingDescriptor getBindingDescriptor()
      Get an optional BindingDescriptor to inject into SAMLBindingContext created.
      String getBindingURI()
      protected void populateBindingContext​(org.opensaml.messaging.context.MessageContext messageContext)
      Populate the context which carries information specific to this binding.
      protected void processArtifacts​(org.opensaml.messaging.context.MessageContext messageContext, javax.servlet.http.HttpServletRequest request)
      Process the incoming artifacts by decoding the artifacts, dereferencing them from the artifact source and storing the resulting response (with assertions) in the message context.
      void setBindingDescriptor​(org.opensaml.saml.common.binding.BindingDescriptor descriptor)
      Set an optional BindingDescriptor to inject into SAMLBindingContext created.

      • Methods inherited from class org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder

        decode, doDestroy, doInitialize, getMessageToLog, getParserPool, logDecodedMessage, setParserPool, unmarshallMessage, validateHttpRequest

      • Methods inherited from class org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder

        getHttpServletRequest, setHttpServletRequest

      • 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

        decode, getMessageContext

    • Field Detail

      • log

        @Nonnull
private final org.slf4j.Logger log
        Class logger.

      • bindingDescriptor

        @Nullable
private org.opensaml.saml.common.binding.BindingDescriptor bindingDescriptor
        Optional BindingDescriptor to inject into SAMLBindingContext created.

    • Constructor Detail

      • HTTPArtifactDecoder

        public HTTPArtifactDecoder()

    • Method Detail

      • 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
        Throws:
        org.opensaml.messaging.decoder.MessageDecodingException

      • decodeTarget

        protected void decodeTarget​(org.opensaml.messaging.context.MessageContext messageContext,
                            javax.servlet.http.HttpServletRequest request)
                     throws org.opensaml.messaging.decoder.MessageDecodingException
        Decodes the TARGET parameter and adds it to the message context.
        Parameters:
        messageContext - current message context
        request - current servlet request
        Throws:
        org.opensaml.messaging.decoder.MessageDecodingException - thrown if there is a problem decoding the TARGET parameter.

      • processArtifacts

        protected void processArtifacts​(org.opensaml.messaging.context.MessageContext messageContext,
                                javax.servlet.http.HttpServletRequest request)
                         throws org.opensaml.messaging.decoder.MessageDecodingException
        Process the incoming artifacts by decoding the artifacts, dereferencing them from the artifact source and storing the resulting response (with assertions) in the message context.
        Parameters:
        messageContext - current message context
        request - current servlet request
        Throws:
        org.opensaml.messaging.decoder.MessageDecodingException - thrown if there is a problem decoding or dereferencing the artifacts

      • populateBindingContext

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