org.springframework.security.saml.userdetails

Interface SAMLUserDetailsService

public interface SAMLUserDetailsService

The SAMLUserDetailsService interface is similar to UserDetailsService with difference that SAML data is used in order obtain information about the user. Implementers of the interface are supposed to locate user in a arbitrary dataStore based on information present in the SAMLCredential and return such a date in a form of application specific UserDetails object.

Author:

Vladimir Schäfer

Method Summary

Modifier and Type	Method and Description
Object	loadUserBySAML(SAMLCredential credential) The method is supposed to identify local account of user referenced by data in the SAML assertion and return UserDetails object describing the user.

Method Detail

loadUserBySAML

Object loadUserBySAML(SAMLCredential credential)
               throws org.springframework.security.core.userdetails.UsernameNotFoundException

The method is supposed to identify local account of user referenced by data in the SAML assertion and return UserDetails object describing the user. In case the user has no local account, implementation may decide to create one or just populate UserDetails object with data from assertion.

Returned object should correctly implement the getAuthorities method as it will be used to populate entitlements inside the Authentication object.

Parameters:

credential - data populated from SAML message used to validate the user

Returns:

a fully populated user record (never null)

Throws:

org.springframework.security.core.userdetails.UsernameNotFoundException - if the user details object can't be populated