Package org.apereo.cas.configuration.model.support.saml.idp

Class SamlIdPResponseProperties

java.lang.Object

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPResponseProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-support-saml-idp")
public class SamlIdPResponseProperties
extends Object
implements Serializable

This is SamlIdPResponseProperties.

Since:

5.3.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SamlIdPResponseProperties.SignatureCredentialTypes	Indicate the type of encoding used when rendering the saml response and its signature blog.

Constructor Summary

Constructors

Constructor	Description
SamlIdPResponseProperties()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	configureAttributeNameFormats()	Configure attribute name formats and build a map.
List<String>	getAttributeNameFormats()	Each individual attribute can be mapped to a particular name-format.
SamlIdPResponseProperties.SignatureCredentialTypes	getCredentialType()	Indicate the encoding type of the credential used when rendering the saml response.
String	getDefaultAttributeNameFormat()	Indicates the default name-format for all attributes in case the individual attribute is not individually mapped.
String	getSkewAllowance()	Time unit in seconds used to skew authentication dates such as valid-from and valid-until elements.
boolean	isSignError()	Whether error responses should be signed.
SamlIdPResponseProperties	setAttributeNameFormats(List<String> attributeNameFormats)	Each individual attribute can be mapped to a particular name-format.
SamlIdPResponseProperties	setCredentialType(SamlIdPResponseProperties.SignatureCredentialTypes credentialType)	Indicate the encoding type of the credential used when rendering the saml response.
SamlIdPResponseProperties	setDefaultAttributeNameFormat(String defaultAttributeNameFormat)	Indicates the default name-format for all attributes in case the individual attribute is not individually mapped.
SamlIdPResponseProperties	setSignError(boolean signError)	Whether error responses should be signed.
SamlIdPResponseProperties	setSkewAllowance(String skewAllowance)	Time unit in seconds used to skew authentication dates such as valid-from and valid-until elements.

Methods inherited from class java.lang.Object

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

Constructor Details

SamlIdPResponseProperties

public SamlIdPResponseProperties()

Method Details

configureAttributeNameFormats

public Map<String,String> configureAttributeNameFormats()

Configure attribute name formats and build a map.

Returns:

the map

getCredentialType

public SamlIdPResponseProperties.SignatureCredentialTypes getCredentialType()

Indicate the encoding type of the credential used when rendering the saml response.

getSkewAllowance

public String getSkewAllowance()

Time unit in seconds used to skew authentication dates such as valid-from and valid-until elements.

isSignError

public boolean isSignError()

Whether error responses should be signed.

getDefaultAttributeNameFormat

public String getDefaultAttributeNameFormat()

Indicates the default name-format for all attributes in case the individual attribute is not individually mapped.

getAttributeNameFormats

public List<String> getAttributeNameFormats()

Each individual attribute can be mapped to a particular name-format. Example: attributeName->basic|uri|unspecified|custom-format-etc,....

setCredentialType

public SamlIdPResponseProperties setCredentialType(SamlIdPResponseProperties.SignatureCredentialTypes credentialType)

Indicate the encoding type of the credential used when rendering the saml response.

Returns:

this.

setSkewAllowance

public SamlIdPResponseProperties setSkewAllowance(String skewAllowance)

Time unit in seconds used to skew authentication dates such as valid-from and valid-until elements.

Returns:

this.

setSignError

public SamlIdPResponseProperties setSignError(boolean signError)

Whether error responses should be signed.

Returns:

this.

setDefaultAttributeNameFormat

public SamlIdPResponseProperties setDefaultAttributeNameFormat(String defaultAttributeNameFormat)

Indicates the default name-format for all attributes in case the individual attribute is not individually mapped.

Returns:

this.

setAttributeNameFormats

public SamlIdPResponseProperties setAttributeNameFormats(List<String> attributeNameFormats)

Each individual attribute can be mapped to a particular name-format. Example: attributeName->basic|uri|unspecified|custom-format-etc,....

Returns:

this.