Package org.apereo.cas.support.saml.web.idp.profile.builders.enc.encoder

Class BaseHttpServletAwareSamlObjectEncoder<T extends org.opensaml.saml.common.SAMLObject>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.apereo.cas.support.saml.services.idp.metadata.SamlRegisteredServiceServiceProviderMetadataFacade adaptor
      The Adaptor.
      protected javax.servlet.http.HttpServletRequest httpRequest
      The Http request.
      protected javax.servlet.http.HttpServletResponse httpResponse
      The Http response.
      protected org.apache.velocity.app.VelocityEngine velocityEngineFactory
      The Velocity engine factory.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      T encode​(org.opensaml.saml.saml2.core.RequestAbstractType request, T samlObject, java.lang.String relayState)
      Encode.
      protected void finalizeEncode​(org.opensaml.saml.saml2.core.RequestAbstractType authnRequest, org.opensaml.saml.saml2.binding.encoding.impl.BaseSAML2MessageEncoder encoder, T samlResponse, java.lang.String relayState)
      Finalize encode response.
      protected abstract java.lang.String getBinding()
      Gets binding.
      protected org.opensaml.messaging.context.MessageContext getEncoderMessageContext​(org.opensaml.saml.saml2.core.RequestAbstractType request, T samlObject, java.lang.String relayState)
      Build encoder message context.
      protected abstract org.opensaml.saml.saml2.binding.encoding.impl.BaseSAML2MessageEncoder getMessageEncoderInstance()
      Gets message encoder instance.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • velocityEngineFactory

        protected final org.apache.velocity.app.VelocityEngine velocityEngineFactory
        The Velocity engine factory.

      • adaptor

        protected final org.apereo.cas.support.saml.services.idp.metadata.SamlRegisteredServiceServiceProviderMetadataFacade adaptor
        The Adaptor.

      • httpResponse

        protected final javax.servlet.http.HttpServletResponse httpResponse
        The Http response.

      • httpRequest

        protected final javax.servlet.http.HttpServletRequest httpRequest
        The Http request.

    • Constructor Detail

      • BaseHttpServletAwareSamlObjectEncoder

        public BaseHttpServletAwareSamlObjectEncoder()

    • Method Detail

      • encode

        public final T encode​(org.opensaml.saml.saml2.core.RequestAbstractType request,
                      T samlObject,
                      java.lang.String relayState)
               throws org.apereo.cas.support.saml.SamlException
        Encode.
        Parameters:
        request - the request
        samlObject - the saml response
        relayState - the relay state
        Returns:
        the response
        Throws:
        org.apereo.cas.support.saml.SamlException - the saml exception

      • getEncoderMessageContext

        protected org.opensaml.messaging.context.MessageContext getEncoderMessageContext​(org.opensaml.saml.saml2.core.RequestAbstractType request,
                                                                                 T samlObject,
                                                                                 java.lang.String relayState)
        Build encoder message context.
        Parameters:
        request - the authn request
        samlObject - the saml response
        relayState - the relay state
        Returns:
        the message context

      • finalizeEncode

        protected void finalizeEncode​(org.opensaml.saml.saml2.core.RequestAbstractType authnRequest,
                              org.opensaml.saml.saml2.binding.encoding.impl.BaseSAML2MessageEncoder encoder,
                              T samlResponse,
                              java.lang.String relayState)
                       throws java.lang.Exception
        Finalize encode response.
        Parameters:
        authnRequest - the authn request
        encoder - the encoder
        samlResponse - the saml response
        relayState - the relay stateSurrogateAuthenticationPostProcessor.java
        Throws:
        java.lang.Exception - the saml exception

      • getBinding

        protected abstract java.lang.String getBinding()
        Gets binding.
        Returns:
        the binding

      • getMessageEncoderInstance

        protected abstract org.opensaml.saml.saml2.binding.encoding.impl.BaseSAML2MessageEncoder getMessageEncoderInstance()
        Gets message encoder instance.
        Returns:
        the message encoder instance