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

Class BaseSamlResponseEncoder

java.lang.Object

org.apereo.cas.support.saml.web.idp.profile.builders.enc.BaseSamlResponseEncoder

Direct Known Subclasses:

SamlResponseArtifactEncoder, SamlResponsePostEncoder, SamlResponsePostSimpleSignEncoder

public abstract class BaseSamlResponseEncoder
extends java.lang.Object

This is BaseSamlResponseEncoder.

Since:

5.2.0

Field Summary

Fields

Modifier and Type	Field and 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.

Constructor Summary

Constructors

Constructor and Description
BaseSamlResponseEncoder()

Method Summary

Modifier and Type	Method and Description
org.opensaml.saml.saml2.core.Response	encode(org.opensaml.saml.saml2.core.RequestAbstractType authnRequest, org.opensaml.saml.saml2.core.Response samlResponse, java.lang.String relayState) Encode.
protected void	finalizeEncode(org.opensaml.saml.saml2.core.RequestAbstractType authnRequest, org.opensaml.saml.saml2.binding.encoding.impl.BaseSAML2MessageEncoder encoder, org.opensaml.saml.saml2.core.Response 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 authnRequest, org.opensaml.saml.saml2.core.Response samlResponse, 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

BaseSamlResponseEncoder

public BaseSamlResponseEncoder()

Method Detail

encode

public final org.opensaml.saml.saml2.core.Response encode(org.opensaml.saml.saml2.core.RequestAbstractType authnRequest,
                                                          org.opensaml.saml.saml2.core.Response samlResponse,
                                                          java.lang.String relayState)
                                                   throws org.apereo.cas.support.saml.SamlException

Encode.

Parameters:

authnRequest - the authn request

samlResponse - 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 authnRequest,
                                                                                 org.opensaml.saml.saml2.core.Response samlResponse,
                                                                                 java.lang.String relayState)

Build encoder message context.

Parameters:

authnRequest - the authn request

samlResponse - 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,
                              org.opensaml.saml.saml2.core.Response 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 state

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