Package org.apereo.cas.support.saml.web.idp.profile.builders.response

Class BaseSamlProfileSamlResponseBuilder<T extends org.opensaml.core.xml.XMLObject>

java.lang.Object

org.apereo.cas.support.saml.util.AbstractSamlObjectBuilder

org.apereo.cas.support.saml.util.AbstractSaml20ObjectBuilder

org.apereo.cas.support.saml.web.idp.profile.builders.response.BaseSamlProfileSamlResponseBuilder<T>

All Implemented Interfaces:

Serializable, org.apereo.cas.support.saml.util.Saml20ObjectBuilder, SamlProfileObjectBuilder<T>

Direct Known Subclasses:

SamlProfileSaml2ResponseBuilder, SamlProfileSamlSoap11ResponseBuilder

public abstract class BaseSamlProfileSamlResponseBuilder<T extends org.opensaml.core.xml.XMLObject>
extends org.apereo.cas.support.saml.util.AbstractSaml20ObjectBuilder
implements SamlProfileObjectBuilder<T>

The BaseSamlProfileSamlResponseBuilder is responsible for building the final SAML assertion for the relying party.

Since:

4.2

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final SamlProfileSamlResponseBuilderConfigurationContext	configurationContext

Fields inherited from class org.apereo.cas.support.saml.util.AbstractSamlObjectBuilder

DEFAULT_ELEMENT_LOCAL_NAME_FIELD, openSamlConfigBean

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseSamlProfileSamlResponseBuilder(SamlProfileSamlResponseBuilderConfigurationContext ctx)

Method Summary

Modifier and Type	Method	Description
T	build(SamlProfileBuilderContext context)	Build.
protected abstract T	buildResponse(Optional<org.opensaml.saml.saml2.core.Assertion> assertion, SamlProfileBuilderContext context)
protected org.opensaml.saml.saml2.core.Assertion	buildSamlAssertion(SamlProfileBuilderContext context)
protected org.opensaml.saml.saml2.core.Issuer	buildSamlResponseIssuer(String entityId)
protected abstract T	encode(SamlProfileBuilderContext context, T samlResponse, String relayState)
protected T	encodeFinalResponse(SamlProfileBuilderContext context, T finalResponse)
protected Optional<org.opensaml.saml.common.SAMLObject>	encryptAssertion(Optional<org.opensaml.saml.saml2.core.Assertion> assertion, SamlProfileBuilderContext context)
protected boolean	encryptAssertionFor(SamlProfileBuilderContext context)

Methods inherited from class org.apereo.cas.support.saml.util.AbstractSaml20ObjectBuilder

addAttributeValuesToSaml2Attribute, decodeSamlAuthnRequest, generateSecureRandomId, getNameID, inflateAuthnRequest, newAssertion, newAssertion, newAttribute, newAuthnStatement, newAuthnStatement, newConditions, newEcpResponse, newIssuer, newLogoutRequest, newLogoutResponse, newResponse, newSamlObject, newStatus, newSubject, newSubject

Methods inherited from class org.apereo.cas.support.saml.util.AbstractSamlObjectBuilder

addAttributeValuesToSamlAttribute, constructDocumentFromXml, getOpenSamlConfigBean, newAttributeValue, signSamlResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apereo.cas.support.saml.util.Saml20ObjectBuilder

getSamlObjectQName, newSamlObject

Field Details

configurationContext

protected final SamlProfileSamlResponseBuilderConfigurationContext configurationContext

Constructor Details

BaseSamlProfileSamlResponseBuilder

protected BaseSamlProfileSamlResponseBuilder(SamlProfileSamlResponseBuilderConfigurationContext ctx)

Method Details

build

public T build(SamlProfileBuilderContext context)
        throws Exception

Description copied from interface: SamlProfileObjectBuilder

Build.

Specified by:

build in interface SamlProfileObjectBuilder<T extends org.opensaml.core.xml.XMLObject>

Parameters:

context - the context

Returns:

the response

Throws:

Exception - the exception

encodeFinalResponse

protected T encodeFinalResponse(SamlProfileBuilderContext context,
 T finalResponse)
                         throws Exception

Throws:

Exception

buildSamlAssertion

protected org.opensaml.saml.saml2.core.Assertion buildSamlAssertion(SamlProfileBuilderContext context)
                                                             throws Exception

Throws:

Exception

buildResponse

protected abstract T buildResponse(Optional<org.opensaml.saml.saml2.core.Assertion> assertion,
 SamlProfileBuilderContext context)
                            throws Exception

Throws:

Exception

buildSamlResponseIssuer

protected org.opensaml.saml.saml2.core.Issuer buildSamlResponseIssuer(String entityId)

encode

protected abstract T encode(SamlProfileBuilderContext context,
 T samlResponse,
 String relayState)
                     throws Exception

Throws:

Exception

encryptAssertion

protected Optional<org.opensaml.saml.common.SAMLObject> encryptAssertion(Optional<org.opensaml.saml.saml2.core.Assertion> assertion,
 SamlProfileBuilderContext context)

encryptAssertionFor

protected boolean encryptAssertionFor(SamlProfileBuilderContext context)