Class SwedishEidAttributeStatementValidator

java.lang.Object

se.swedenconnect.opensaml.saml2.assertion.validation.AbstractAttributeStatementValidator

se.swedenconnect.opensaml.sweid.saml2.validation.SwedishEidAttributeStatementValidator

All Implemented Interfaces:

StatementValidator

public class SwedishEidAttributeStatementValidator
extends AbstractAttributeStatementValidator

Validator for AttributeStatements.

Supports the following ValidationContext static parameters:

• REQUIRED_ATTRIBUTE_SET: Optional. Holds a AttributeSet that tells which attributes we require to find in the assertion.
• REQUIRED_ATTRIBUTES: Optional. Holds a collection of strings that are the attribute names that we require to find in the assertion.
• SCOPED_ATTRIBUTES: Optional. Carries a Collection of strings holding the attribute names for attributes that are "scoped".

Note that the two above parameters may be combined. If no parameter for requested attributes is passed, no validation will be performed.

Author:

Martin Lindström (martin@idsec.se)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REQUIRED_ATTRIBUTE_SET	Key for a validation context parameter.
static final String	REQUIRED_ATTRIBUTES	Key for a validation context parameter.
static final String	SCOPED_ATTRIBUTES	Key for a validation context parameter.

Constructor Summary

Constructors

Constructor	Description
SwedishEidAttributeStatementValidator()

Method Summary

Modifier and Type	Method	Description
protected Collection<String>	getRequiredAttributes(ValidationContext context)	Returns the required attributes.
ValidationResult	validate(Statement statement, Assertion assertion, ValidationContext context)
protected ValidationResult	validateRequiredAttributes(List<Attribute> attributes, AttributeStatement statement, Assertion assertion, ValidationContext context)	Validates that the required attributes have been received by using the optional context parameter REQUIRED_ATTRIBUTE_SET that holds an AttributeSet and/or the list of attribute names from the parameter REQUIRED_ATTRIBUTES.
protected ValidationResult	validateScopedAttributes(List<Attribute> attributes, AttributeStatement statement, Assertion assertion, ValidationContext context)	Validates that the issuing IdP has been authorized to issue scoped attributes.

Methods inherited from class AbstractAttributeStatementValidator

getServicedStatement

Methods inherited from class Object

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

Field Details

REQUIRED_ATTRIBUTE_SET

@Nonnull
public static final String REQUIRED_ATTRIBUTE_SET

Key for a validation context parameter. Carries a AttributeSet holding the required attributes.

See Also:

• Constant Field Values

REQUIRED_ATTRIBUTES

@Nonnull
public static final String REQUIRED_ATTRIBUTES

Key for a validation context parameter. Carries a Collection of strings holding attribute names of required attributes.

See Also:

• Constant Field Values

SCOPED_ATTRIBUTES

@Nonnull
public static final String SCOPED_ATTRIBUTES

Key for a validation context parameter. Carries a Collection of strings holding the attribute names for attributes that are "scoped".

See Also:

• Constant Field Values

Constructor Details

SwedishEidAttributeStatementValidator

public SwedishEidAttributeStatementValidator()

Method Details

validate

@Nonnull
public ValidationResult validate(@Nonnull
 Statement statement,
 @Nonnull
 Assertion assertion,
 @Nonnull
 ValidationContext context)
                          throws AssertionValidationException

Specified by:

validate in interface StatementValidator

Overrides:

validate in class AbstractAttributeStatementValidator

Throws:

AssertionValidationException

validateRequiredAttributes

@Nonnull
protected ValidationResult validateRequiredAttributes(@Nonnull
 List<Attribute> attributes,
 @Nonnull
 AttributeStatement statement,
 @Nonnull
 Assertion assertion,
 @Nonnull
 ValidationContext context)

Validates that the required attributes have been received by using the optional context parameter REQUIRED_ATTRIBUTE_SET that holds an AttributeSet and/or the list of attribute names from the parameter REQUIRED_ATTRIBUTES.

Specified by:

validateRequiredAttributes in class AbstractAttributeStatementValidator

getRequiredAttributes

@Nonnull
protected Collection<String> getRequiredAttributes(@Nonnull
 ValidationContext context)

Returns the required attributes.

Parameters:

context - the validation context

Returns:

a collection of attribute names (never null)

validateScopedAttributes

@Nonnull
protected ValidationResult validateScopedAttributes(@Nonnull
 List<Attribute> attributes,
 @Nonnull
 AttributeStatement statement,
 @Nonnull
 Assertion assertion,
 @Nonnull
 ValidationContext context)

Validates that the issuing IdP has been authorized to issue scoped attributes.

Parameters:

attributes - a list of the attributes

statement - the statement

assertion - the assertion

context - the validation context

Returns:

a validation result