org.picketlink.identity.federation.core.wstrust

Interface ClaimsProcessor

public interface ClaimsProcessor

A ClaimsProcessor implementation is responsible for parsing the WS-Trust claims according to the specified claims dialect and retrieving the attributes that correspond to the required claims. ClaimsProcessors may use the properties specified in the configuration to perform its job (for instance, to connect to an external LDAP server or IDM system when retrieving the attributes).

Author:

Stefan Guilhen

Method Summary

Methods

Modifier and Type	Method and Description
void	initialize(Map<String,String> properties) Initializes the ClaimsProcessor using the specified properties map.
Map<String,Object>	processClaims(ClaimsType claims, Principal principal) Parses the specified claims according to the claims dialect and returns a Map of attributes that correspond to the required claims.

Method Detail

initialize

void initialize(Map<String,String> properties)

Initializes the ClaimsProcessor using the specified properties map.

Parameters:

properties - a Map<String, String> that contains the properties that have been configured for this ClaimsProcessor.

processClaims

Map<String,Object> processClaims(ClaimsType claims,
                               Principal principal)
                                 throws WSTrustException

Parses the specified claims according to the claims dialect and returns a Map of attributes that correspond to the required claims. Implementing classes may get the attributes from a local context or from an external system (like an LDAP server or IDM system).

Parameters:

claims - a reference to the ClaimsType instance that contains the claims that must be inserted into generated tokens as attributes.

principal - the Principal to which the claims refer.

Returns:

a Map<String, Object> of attributes that correspond to the required claims.

Throws:

WSTrustException - if an error occurs while processing the claims.