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

Class SamlResponseArtifactEncoder

java.lang.Object

org.apereo.cas.support.saml.web.idp.profile.builders.enc.encoder.BaseHttpServletAwareSamlObjectEncoder<org.opensaml.saml.saml2.core.Response>

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

public class SamlResponseArtifactEncoder
extends BaseHttpServletAwareSamlObjectEncoder<org.opensaml.saml.saml2.core.Response>

This is SamlResponseArtifactEncoder.

Since:

5.2.0

Field Summary

Fields inherited from class org.apereo.cas.support.saml.web.idp.profile.builders.enc.encoder.BaseHttpServletAwareSamlObjectEncoder

adaptor, httpRequest, httpResponse, velocityEngineFactory

Constructor Summary

Constructors

Constructor

Description

SamlResponseArtifactEncoder(org.apache.velocity.app.VelocityEngine velocityEngineFactory, org.apereo.cas.support.saml.services.idp.metadata.SamlRegisteredServiceServiceProviderMetadataFacade adaptor, javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, org.opensaml.saml.saml2.core.RequestAbstractType authnRequest, org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry, org.apereo.cas.ticket.artifact.SamlArtifactTicketFactory samlArtifactTicketFactory, org.apereo.cas.web.cookie.CasCookieBuilder ticketGrantingTicketCookieGenerator, org.opensaml.saml.common.binding.artifact.SAMLArtifactMap samlArtifactMap)

Method Summary

Modifier and Type	Method	Description
protected void	finalizeEncode(org.opensaml.saml.saml2.core.RequestAbstractType authnRequest, org.opensaml.saml.saml2.binding.encoding.impl.BaseSAML2MessageEncoder e, org.opensaml.saml.saml2.core.Response samlResponse, java.lang.String relayState)	Finalize encode response.
protected java.lang.String	getBinding()	Gets binding.
protected org.opensaml.saml.saml2.binding.encoding.impl.BaseSAML2MessageEncoder	getMessageEncoderInstance()	Gets message encoder instance.

Methods inherited from class org.apereo.cas.support.saml.web.idp.profile.builders.enc.encoder.BaseHttpServletAwareSamlObjectEncoder

encode, getEncoderMessageContext

Methods inherited from class java.lang.Object

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

Constructor Detail

SamlResponseArtifactEncoder

public SamlResponseArtifactEncoder(org.apache.velocity.app.VelocityEngine velocityEngineFactory,
                                   org.apereo.cas.support.saml.services.idp.metadata.SamlRegisteredServiceServiceProviderMetadataFacade adaptor,
                                   javax.servlet.http.HttpServletRequest httpRequest,
                                   javax.servlet.http.HttpServletResponse httpResponse,
                                   org.opensaml.saml.saml2.core.RequestAbstractType authnRequest,
                                   org.apereo.cas.ticket.registry.TicketRegistry ticketRegistry,
                                   org.apereo.cas.ticket.artifact.SamlArtifactTicketFactory samlArtifactTicketFactory,
                                   org.apereo.cas.web.cookie.CasCookieBuilder ticketGrantingTicketCookieGenerator,
                                   org.opensaml.saml.common.binding.artifact.SAMLArtifactMap samlArtifactMap)

Method Detail

getBinding

protected java.lang.String getBinding()

Description copied from class: BaseHttpServletAwareSamlObjectEncoder

Gets binding.

Specified by:

getBinding in class BaseHttpServletAwareSamlObjectEncoder<org.opensaml.saml.saml2.core.Response>

Returns:

the binding

getMessageEncoderInstance

protected org.opensaml.saml.saml2.binding.encoding.impl.BaseSAML2MessageEncoder getMessageEncoderInstance()

Description copied from class: BaseHttpServletAwareSamlObjectEncoder

Gets message encoder instance.

Specified by:

getMessageEncoderInstance in class BaseHttpServletAwareSamlObjectEncoder<org.opensaml.saml.saml2.core.Response>

Returns:

the message encoder instance

finalizeEncode

protected void finalizeEncode(org.opensaml.saml.saml2.core.RequestAbstractType authnRequest,
                              org.opensaml.saml.saml2.binding.encoding.impl.BaseSAML2MessageEncoder e,
                              org.opensaml.saml.saml2.core.Response samlResponse,
                              java.lang.String relayState)
                       throws java.lang.Exception

Description copied from class: BaseHttpServletAwareSamlObjectEncoder

Finalize encode response.

Overrides:

finalizeEncode in class BaseHttpServletAwareSamlObjectEncoder<org.opensaml.saml.saml2.core.Response>

Parameters:

authnRequest - the authn request

e - the encoder

samlResponse - the saml response

relayState - the relay stateSurrogateAuthenticationPostProcessor.java

Throws:

java.lang.Exception - the saml exception