Package se.litsec.swedisheid.opensaml.saml2.attribute

Interface AttributeSet

All Known Implementing Classes:

AttributeSetImpl

public interface AttributeSet

The specification "Attribute Specification for the Swedish eID Framework" of the Swedish eID Framework defines a number of "Attribute Sets". This interface represents such an attribute set.

Author:

Martin Lindström (martin.lindstrom@litsec.se)

See Also:

AttributeSetConstants

Method Summary

Modifier and Type	Method	Description
String	getFriendlyName()	Returns the friendly name for this attribute set.
String	getIdentifier()	Each attribute set within the Swedish eID Framework is assigned an unique profile identifier.
AttributeTemplate[]	getRecommendedAttributes()	Returns the recommended attributes for this attribute set
AttributeTemplate[]	getRequiredAttributes()	Returns the required attributes for this attribute set
String	getUri()	Each attribute set within the Swedish eID Framework is assigned an unique URI.
void	validateAttributes(Assertion assertion, List<RequestedAttribute> explicitlyRequestedAttributes)	Validates the attributes received in the assertion against the attribute set.

Method Detail

getIdentifier

String getIdentifier()

Each attribute set within the Swedish eID Framework is assigned an unique profile identifier. This method returns this unique value.

Returns:

the attribute set identifier

See Also:

getUri()

getUri

String getUri()

Each attribute set within the Swedish eID Framework is assigned an unique URI. This method returns this value.

Returns:

the attribute set URI

See Also:

getIdentifier()

getFriendlyName

String getFriendlyName()

Returns the friendly name for this attribute set.

Returns:

the attribute set friendly name

getRequiredAttributes

AttributeTemplate[] getRequiredAttributes()

Returns the required attributes for this attribute set

Returns:

an array of required attributes for this set

getRecommendedAttributes

AttributeTemplate[] getRecommendedAttributes()

Returns the recommended attributes for this attribute set

Returns:

an array of recommended attributes for this set

validateAttributes

void validateAttributes(Assertion assertion,
                        List<RequestedAttribute> explicitlyRequestedAttributes)
                 throws AttributesValidationException

Validates the attributes received in the assertion against the attribute set. The validation logic is as follows:

• Make sure that all the attributes that the set states as "required" are included in the assertion.
• Make sure that all explicitly requested attributes, that has the attribute isRequired set, are included in the assertion. These requested attributes are listed in the SP metadata record as <md:RequestedAttribute> elements.

Parameters:

assertion - the assertion containing the attributes to validate

explicitlyRequestedAttributes - a list of explicitly requested attributes that the Service Provider has specified in its metadata record (using <md:RequestedAttribute> elements). This parameter may be null if no explicitly requested attributes exist

Throws:

AttributesValidationException - for violations of the attribute set