Package se.curity.identityserver.sdk.attribute

Class AuthenticationAttributes

Object

se.curity.identityserver.sdk.attribute.Attributes

se.curity.identityserver.sdk.attribute.AuthenticationAttributes

All Implemented Interfaces:

Iterable<Attribute>, AttributeContainer<Attributes>, SerializableAsMap

public class AuthenticationAttributes
extends Attributes

Subtype of Attributes that contains.

1. A Subject-value
2. A set (Attributes) of Subject-related attributes
3. A set (Attributes) of Context-related attributes

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTEXT_ATTRIBUTES
static final String	SUBJECT_ATTRIBUTES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AuthenticationAttributes(SubjectAttributes subjectAttributes, ContextAttributes contextAttributes)
protected	AuthenticationAttributes(SubjectAttributes subjectAttributes, ContextAttributes contextAttributes, Attribute additionalAttribute)

Method Summary

Modifier and Type	Method	Description
static AuthenticationAttributes	fromAttributes(Attributes other)	Create a new AuthenticationAttributes instance from the provided Attributes, that actually represents an Attributes-instance with the correct structure.
long	getAuthTime()
ContextAttributes	getContextAttributes()
long	getExpiresAt()
String	getSubject()
SubjectAttributes	getSubjectAttributes()
static AuthenticationAttributes	of(String subject, ContextAttributes contextAttributes)
static AuthenticationAttributes	of(Attribute subjectAttribute, ContextAttributes contextAttributes)
static AuthenticationAttributes	of(SubjectAttributes subjectAttributes, ContextAttributes contextAttributes)
AuthenticationAttributes	withAdditionalFactor(AuthenticationAttributes secondFactor, String secondFactorAcr)	Returns a new AuthenticationAttributes with the second factor authentication attributes added.
AuthenticationAttributes	withContextAttribute(Attribute attribute)	Augments the ContextAttributes of the current AuthenticationAttributes with the given Attribute and returns the amalgamation.
AuthenticationAttributes	withContextAttribute(AuthenticationSessionAttribute authenticationSessionAttribute)	Recalculate the AuthenticationAttributes for the given ServiceProvider.
AuthenticationAttributes	withSubjectAttribute(Attribute attribute)	Augments the SubjectAttributes of the current AuthenticationAttributes with the given Attribute and returns the amalgamation.

Methods inherited from class se.curity.identityserver.sdk.attribute.Attributes

append, append, asMap, contains, empty, equals, fromMap, fromMap, get, getAll, getMandatoryAttribute, getMandatoryValue, getValuesOfType, hashCode, isEmpty, iterator, keys, of, of, of, of, of, of, of, removeAttributes, retainAttributes, size, stream, toMap, toString, with, with

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface se.curity.identityserver.sdk.attribute.AttributeContainer

contains, getOptionalValue, getOptionalValue, removeAttribute, retainAttribute

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

SUBJECT_ATTRIBUTES

public static final String SUBJECT_ATTRIBUTES

See Also:

• Constant Field Values

CONTEXT_ATTRIBUTES

public static final String CONTEXT_ATTRIBUTES

See Also:

• Constant Field Values

Constructor Details

AuthenticationAttributes

protected AuthenticationAttributes(SubjectAttributes subjectAttributes,
 ContextAttributes contextAttributes)

AuthenticationAttributes

protected AuthenticationAttributes(SubjectAttributes subjectAttributes,
 ContextAttributes contextAttributes,
 Attribute additionalAttribute)

Method Details

of

public static AuthenticationAttributes of(Attribute subjectAttribute,
 ContextAttributes contextAttributes)

of

public static AuthenticationAttributes of(String subject,
 ContextAttributes contextAttributes)

of

public static AuthenticationAttributes of(SubjectAttributes subjectAttributes,
 ContextAttributes contextAttributes)

fromAttributes

public static AuthenticationAttributes fromAttributes(Attributes other)
                                               throws AttributeValueException

Create a new AuthenticationAttributes instance from the provided Attributes, that actually represents an Attributes-instance with the correct structure.

This method should be called when an Attributes-instance is deserialized and needs to be upcast to AuthenticationAttributes.

Parameters:

other - Attributes-instance that has the correct model to be upcast as AuthenticationAttributes

Returns:

the AuthenticationAttributes instance that is represented by the provided Attributes

Throws:

AttributeValueException - when provided attributes did not contain required subject- and/or context- attributes.

withContextAttribute

public AuthenticationAttributes withContextAttribute(Attribute attribute)

Augments the ContextAttributes of the current AuthenticationAttributes with the given Attribute and returns the amalgamation.

Parameters:

attribute - the attribute to be included in the ContextAttributes set which this AuthenticationAttributes set

Returns:

this AuthenticationAttributes set together with the given Attribute in the ContextAttributes

See Also:

• withSubjectAttribute(Attribute)

withSubjectAttribute

public AuthenticationAttributes withSubjectAttribute(Attribute attribute)

Augments the SubjectAttributes of the current AuthenticationAttributes with the given Attribute and returns the amalgamation. NOTE: This method, like all with methods is pure, and has no side effects that affect the object on which this method is called. Therefore, the result should always be used in some manner.

Parameters:

attribute - the attribute to be included in the SubjectAttributes set which this AuthenticationAttributes set

Returns:

this AuthenticationAttributes set together with the given Attribute in the SubjectAttributes

Since:

5.1.0

See Also:

• withContextAttribute(Attribute)

getSubject

public String getSubject()

getAuthTime

public long getAuthTime()

getExpiresAt

public long getExpiresAt()

getSubjectAttributes

public SubjectAttributes getSubjectAttributes()

getContextAttributes

public ContextAttributes getContextAttributes()

withAdditionalFactor

public AuthenticationAttributes withAdditionalFactor(AuthenticationAttributes secondFactor,
 String secondFactorAcr)

Returns a new AuthenticationAttributes with the second factor authentication attributes added.

The resulting attributes are created using the following algorithm:

• First, each one of second factor attributes is added, using the secondFactorAcr as the authority. If the additional factor attribute already has an authority, then it is kept.
• Then, each one of the current attributes is added. This ensures that on any collision (i.e. attributes with the same name and authority), the current attributes win.

Parameters:

secondFactor - the AuthenticationAttributes produced by the second factor.

secondFactorAcr - the ACR (Authentication Class Context Reference) for the second factor authenticator.

Returns:

the AuthenticationAttributes combining this attributes and the second factor attributes.

withContextAttribute

public AuthenticationAttributes withContextAttribute(AuthenticationSessionAttribute authenticationSessionAttribute)

Recalculate the AuthenticationAttributes for the given ServiceProvider. This will update ServiceProvider specific attributes of the ContextAttributes and return a new instance. Existing ServiceProvider specific attributes, if any, will be overwritten. In case the AuthenticationAttributes were already bound to the provided ServiceProvider, no new attributes are added or created.

Parameters:

authenticationSessionAttribute - the AuthenticationSessionAttribute to add to the context

Returns:

new AuthenticationAttributes instance bound to the provided ServiceProvider

Since:

5.1.0