org.apereo.cas.support.saml.util

Class AbstractSaml20ObjectBuilder

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable

public abstract class AbstractSaml20ObjectBuilder
extends AbstractSamlObjectBuilder

This is AbstractSaml20ObjectBuilder. to build saml2 objects.

Since:

4.1

See Also:

Serialized Form

Field Summary

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

configBean, DEFAULT_ELEMENT_LOCAL_NAME_FIELD, DEFAULT_ELEMENT_NAME_FIELD

Constructor Summary

Constructors

Constructor and Description
AbstractSaml20ObjectBuilder(org.apereo.cas.support.saml.OpenSamlConfigBean configBean)

Method Summary

Modifier and Type	Method and Description
void	addAttributeValuesToSaml2Attribute(java.lang.String attributeName, java.lang.Object attributeValue, java.util.List<org.opensaml.core.xml.XMLObject> attributeList) Add saml2 attribute values for attribute.
java.lang.String	decodeSamlAuthnRequest(java.lang.String encodedRequestXmlString) Decode authn request xml.
java.lang.String	generateSecureRandomId() Generate a secure random id.
org.opensaml.saml.saml2.core.NameID	getNameID(java.lang.String nameIdFormat, java.lang.String nameIdValue) Gets name id.
org.opensaml.saml.saml2.core.Assertion	newAssertion(org.opensaml.saml.saml2.core.AuthnStatement authnStatement, java.lang.String issuer, java.time.ZonedDateTime issuedAt, java.lang.String id) Create a new SAML1 response object.
org.opensaml.saml.saml2.core.Assertion	newAssertion(java.util.List<org.opensaml.saml.saml2.core.Statement> authnStatement, java.lang.String issuer, java.time.ZonedDateTime issuedAt, java.lang.String id) Create a new SAML1 response object.
protected org.opensaml.saml.saml2.core.Attribute	newAttribute(boolean setFriendlyName, java.util.Map.Entry<java.lang.String,java.lang.Object> e, java.util.Map<java.lang.String,java.lang.String> configuredNameFormats, java.lang.String defaultNameFormat) New attribute.
org.opensaml.saml.saml2.core.AttributeStatement	newAttributeStatement(java.util.Map<java.lang.String,java.lang.Object> attributes, boolean setFriendlyName, java.util.Map<java.lang.String,java.lang.String> configuredNameFormats, java.lang.String defaultNameFormat) New attribute statement.
org.opensaml.saml.saml2.core.AuthnStatement	newAuthnStatement(java.lang.String contextClassRef, java.time.ZonedDateTime authnInstant, java.lang.String sessionIndex) New authn statement.
org.opensaml.saml.saml2.core.Conditions	newConditions(java.time.ZonedDateTime notBefore, java.time.ZonedDateTime notOnOrAfter, java.lang.String audienceUri) New conditions element.
org.opensaml.saml.saml2.ecp.Response	newEcpResponse(java.lang.String assertionConsumerUrl) Create a new SAML ECP response object.
org.opensaml.saml.saml2.core.Issuer	newIssuer(java.lang.String issuerValue) New issuer.
org.opensaml.saml.saml2.core.Response	newResponse(java.lang.String id, java.time.ZonedDateTime issueInstant, java.lang.String recipient, org.apereo.cas.authentication.principal.WebApplicationService service) Create a new SAML response object.
org.opensaml.saml.saml2.core.Status	newStatus(java.lang.String codeValue, java.lang.String statusMessage) Create a new SAML status object.
org.opensaml.saml.saml2.core.Subject	newSubject(org.opensaml.saml.saml2.core.NameID nameId, java.lang.String recipient, java.time.ZonedDateTime notOnOrAfter, java.lang.String inResponseTo, java.time.ZonedDateTime notBefore) New subject element.
org.opensaml.saml.saml2.core.Subject	newSubject(java.lang.String nameIdFormat, java.lang.String nameIdValue, java.lang.String recipient, java.time.ZonedDateTime notOnOrAfter, java.lang.String inResponseTo, java.time.ZonedDateTime notBefore) New subject subject.

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

addAttributeValuesToSamlAttribute, constructDocumentFromXml, getConfigBean, getSamlObjectQName, newAttributeValue, newSamlObject, newSoapObject, signSamlResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSaml20ObjectBuilder

public AbstractSaml20ObjectBuilder(org.apereo.cas.support.saml.OpenSamlConfigBean configBean)

Method Detail

getNameID

public org.opensaml.saml.saml2.core.NameID getNameID(java.lang.String nameIdFormat,
                                                     java.lang.String nameIdValue)

Gets name id.

Parameters:

nameIdFormat - the name id format

nameIdValue - the name id value

Returns:

the name iD

newEcpResponse

public org.opensaml.saml.saml2.ecp.Response newEcpResponse(java.lang.String assertionConsumerUrl)

Create a new SAML ECP response object.

Parameters:

assertionConsumerUrl - the assertion consumer url

Returns:

the response

newResponse

public org.opensaml.saml.saml2.core.Response newResponse(java.lang.String id,
                                                         java.time.ZonedDateTime issueInstant,
                                                         java.lang.String recipient,
                                                         org.apereo.cas.authentication.principal.WebApplicationService service)

Create a new SAML response object.

Parameters:

id - the id

issueInstant - the issue instant

recipient - the recipient

service - the service

Returns:

the response

newStatus

public org.opensaml.saml.saml2.core.Status newStatus(java.lang.String codeValue,
                                                     java.lang.String statusMessage)

Create a new SAML status object.

Parameters:

codeValue - the code value

statusMessage - the status message

Returns:

the status

newAssertion

public org.opensaml.saml.saml2.core.Assertion newAssertion(org.opensaml.saml.saml2.core.AuthnStatement authnStatement,
                                                           java.lang.String issuer,
                                                           java.time.ZonedDateTime issuedAt,
                                                           java.lang.String id)

Create a new SAML1 response object.

Parameters:

authnStatement - the authn statement

issuer - the issuer

issuedAt - the issued at

id - the id

Returns:

the assertion

newAssertion

public org.opensaml.saml.saml2.core.Assertion newAssertion(java.util.List<org.opensaml.saml.saml2.core.Statement> authnStatement,
                                                           java.lang.String issuer,
                                                           java.time.ZonedDateTime issuedAt,
                                                           java.lang.String id)

Create a new SAML1 response object.

Parameters:

authnStatement - the authn statement

issuer - the issuer

issuedAt - the issued at

id - the id

Returns:

the assertion

newIssuer

public org.opensaml.saml.saml2.core.Issuer newIssuer(java.lang.String issuerValue)

New issuer.

Parameters:

issuerValue - the issuer

Returns:

the issuer

newAttributeStatement

public org.opensaml.saml.saml2.core.AttributeStatement newAttributeStatement(java.util.Map<java.lang.String,java.lang.Object> attributes,
                                                                             boolean setFriendlyName,
                                                                             java.util.Map<java.lang.String,java.lang.String> configuredNameFormats,
                                                                             java.lang.String defaultNameFormat)

New attribute statement.

Parameters:

attributes - the attributes

setFriendlyName - the set friendly name

configuredNameFormats - the configured name formats

defaultNameFormat - the default name format

Returns:

the attribute statement

addAttributeValuesToSaml2Attribute

public void addAttributeValuesToSaml2Attribute(java.lang.String attributeName,
                                               java.lang.Object attributeValue,
                                               java.util.List<org.opensaml.core.xml.XMLObject> attributeList)

Add saml2 attribute values for attribute.

Parameters:

attributeName - the attribute name

attributeValue - the attribute value

attributeList - the attribute list

newAttribute

protected org.opensaml.saml.saml2.core.Attribute newAttribute(boolean setFriendlyName,
                                                              java.util.Map.Entry<java.lang.String,java.lang.Object> e,
                                                              java.util.Map<java.lang.String,java.lang.String> configuredNameFormats,
                                                              java.lang.String defaultNameFormat)

New attribute.

Parameters:

setFriendlyName - the set friendly name

e - the entry to process and turn into a saml attribute

configuredNameFormats - the configured name formats. If an attribute is found in this collection, the linked name format will be used.

defaultNameFormat - the default name format

Returns:

the attribute

newAuthnStatement

public org.opensaml.saml.saml2.core.AuthnStatement newAuthnStatement(java.lang.String contextClassRef,
                                                                     java.time.ZonedDateTime authnInstant,
                                                                     java.lang.String sessionIndex)

New authn statement.

Parameters:

contextClassRef - the context class ref such as AuthnContext.PASSWORD_AUTHN_CTX

authnInstant - the authn instant

sessionIndex - the session index

Returns:

the authn statement

newConditions

public org.opensaml.saml.saml2.core.Conditions newConditions(java.time.ZonedDateTime notBefore,
                                                             java.time.ZonedDateTime notOnOrAfter,
                                                             java.lang.String audienceUri)

New conditions element.

Parameters:

notBefore - the not before

notOnOrAfter - the not on or after

audienceUri - the service id

Returns:

the conditions

newSubject

public org.opensaml.saml.saml2.core.Subject newSubject(java.lang.String nameIdFormat,
                                                       java.lang.String nameIdValue,
                                                       java.lang.String recipient,
                                                       java.time.ZonedDateTime notOnOrAfter,
                                                       java.lang.String inResponseTo,
                                                       java.time.ZonedDateTime notBefore)

New subject subject.

Parameters:

nameIdFormat - the name id format

nameIdValue - the name id value

recipient - the recipient

notOnOrAfter - the not on or after

inResponseTo - the in response to

notBefore - the not before

Returns:

the subject

newSubject

public org.opensaml.saml.saml2.core.Subject newSubject(org.opensaml.saml.saml2.core.NameID nameId,
                                                       java.lang.String recipient,
                                                       java.time.ZonedDateTime notOnOrAfter,
                                                       java.lang.String inResponseTo,
                                                       java.time.ZonedDateTime notBefore)

New subject element.

Parameters:

nameId - the nameId

recipient - the recipient

notOnOrAfter - the not on or after

inResponseTo - the in response to

notBefore - the not before

Returns:

the subject

generateSecureRandomId

public java.lang.String generateSecureRandomId()

Description copied from class: AbstractSamlObjectBuilder

Generate a secure random id.

Overrides:

generateSecureRandomId in class AbstractSamlObjectBuilder

Returns:

the secure id string

decodeSamlAuthnRequest

public java.lang.String decodeSamlAuthnRequest(java.lang.String encodedRequestXmlString)

Decode authn request xml.

Parameters:

encodedRequestXmlString - the encoded request xml string

Returns:

the request