org.picketlink.idm.credential

Class AbstractTokenConsumer<T extends Token>

java.lang.Object

org.picketlink.idm.credential.AbstractTokenConsumer<T>

All Implemented Interfaces:

Token.Consumer<T>

public abstract class AbstractTokenConsumer<T extends Token>
extends Object
implements Token.Consumer<T>

Provides built-in support to extract information for a particular IdentityType from a Token.

The default implementation is based on the identity stereotypes defined by the IdentityStereotype.Stereotype.

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor and Description
AbstractTokenConsumer()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Set<String>	extractGroups(T token) Subclasses must override this method to extract groups from the token.
<I extends IdentityType> I	extractIdentity(T token, Class<I> identityType, StereotypeProperty.Property stereotypeProperty, Object identifier) Extracts a certain IdentityType considering the information from the given Token.
protected abstract Set<String>	extractRoles(T token) Subclasses must override this method to extract roles from the token.
protected abstract String	extractSubject(T token) Subclasses must override this method to extract the subject's identifier from the token.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.picketlink.idm.credential.Token.Consumer

getTokenType, validate

Constructor Detail

AbstractTokenConsumer

public AbstractTokenConsumer()

Method Detail

extractIdentity

public <I extends IdentityType> I extractIdentity(T token,
                                         Class<I> identityType,
                                         StereotypeProperty.Property stereotypeProperty,
                                         Object identifier)

Description copied from interface: Token.Consumer

Extracts a certain IdentityType considering the information from the given Token.

Usually, a token contains a set of claims which can be mapped to the identity types supported by PicketLink IdentityStereotype.Stereotype. Each stereotype has a set of common properties that can be used to identify them. In this case, the StereotypeProperty.Property should be used to tell which property of the given identity type should be populated with the identifier value if there is any claim in the token representing it.

Specified by:

extractIdentity in interface Token.Consumer<T extends Token>

Parameters:

token - The token.

identityType - The type of the identity type that should be created based on the claims of a token.

stereotypeProperty - The stereotype property used to identify and populate the identity type instance from the token claims.

identifier - The value of the identifier used to match the existence of a identity type based on the token claims set.

Returns:

An identity type instance of there is any claim from the token referencing it. Otherwise this method returns null.

extractSubject

protected abstract String extractSubject(T token)

Subclasses must override this method to extract the subject's identifier from the token.

Parameters:

token -

Returns:

extractRoles

protected abstract Set<String> extractRoles(T token)

Subclasses must override this method to extract roles from the token.

Parameters:

token -

Returns:

extractGroups

protected abstract Set<String> extractGroups(T token)

Subclasses must override this method to extract groups from the token.

Parameters:

token -

Returns: