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

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

java.lang.Object
org.apereo.cas.support.saml.web.idp.profile.builders.enc.encoder.BaseHttpServletAwareSamlObjectEncoder<T>
Direct Known Subclasses:
SamlResponseArtifactEncoder, SamlResponsePostEncoder, SamlResponsePostSimpleSignEncoder
public abstract class BaseHttpServletAwareSamlObjectEncoder<T extends org.opensaml.saml.common.SAMLObject> extends Object
This is BaseHttpServletAwareSamlObjectEncoder.
Since:
5.2.0

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    BaseHttpServletAwareSamlObjectEncoder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final T
    encode(org.opensaml.saml.saml2.core.RequestAbstractType request, T samlObject, String relayState, org.opensaml.messaging.context.MessageContext messageContext)
    Encode.
    protected void
    finalizeEncode(org.opensaml.saml.saml2.core.RequestAbstractType authnRequest, org.opensaml.saml.saml2.binding.encoding.impl.BaseSAML2MessageEncoder encoder, T samlResponse, String relayState, org.opensaml.messaging.context.MessageContext messageContext)
     
    protected abstract String
    getBinding()
     
    protected org.opensaml.messaging.context.MessageContext
    getEncoderMessageContext(org.opensaml.saml.saml2.core.RequestAbstractType request, T samlObject, String relayState, org.opensaml.messaging.context.MessageContext messageContext)
    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 Details

    • 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 jakarta.servlet.http.HttpServletResponse httpResponse
      The Http response.

    • httpRequest

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

  • Constructor Details

    • BaseHttpServletAwareSamlObjectEncoder

      public BaseHttpServletAwareSamlObjectEncoder()

  • Method Details

    • encode

      public final T encode(org.opensaml.saml.saml2.core.RequestAbstractType request, T samlObject, String relayState, org.opensaml.messaging.context.MessageContext messageContext) throws org.apereo.cas.support.saml.SamlException
      Encode.
      Parameters:
      request - the request
      samlObject - the saml response
      relayState - the relay state
      messageContext - the message context
      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, String relayState, org.opensaml.messaging.context.MessageContext messageContext)
      Build encoder message context.
      Parameters:
      request - the authn request
      samlObject - the saml response
      relayState - the relay state
      messageContext - the message context
      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, String relayState, org.opensaml.messaging.context.MessageContext messageContext)

    • getBinding

      protected abstract String getBinding()

    • getMessageEncoderInstance

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