Package org.forgerock.openam.authentication.modules.common.mapping

Interface AccountProvider

@SupportedAll
public interface AccountProvider

Implementations of this interface provide the means to search for and create users given a map of attributes.

See Also:

DefaultAccountProvider

Method Summary

Modifier and Type	Method	Description
AMIdentity	provisionUser(AMIdentityRepository idrepo, Map<String,Set<String>> attributes)	Provisions a user with the specified attributes.
AMIdentity	searchUser(AMIdentityRepository idrepo, Map<String,Set<String>> attr)	Search for a user given a map of attributes.

Method Detail

searchUser

AMIdentity searchUser(AMIdentityRepository idrepo,
                      Map<String,Set<String>> attr)

Search for a user given a map of attributes.

Parameters:

idrepo - The identity repository.

attr - The set of attributes, which should be treated as 'or' statements.

Returns:

The first matching user found.

provisionUser

AMIdentity provisionUser(AMIdentityRepository idrepo,
                         Map<String,Set<String>> attributes)
                  throws AuthLoginException

Provisions a user with the specified attributes.

Parameters:

idrepo - The identity repository in which the user will be created.

attributes - The user attributes.

Returns:

The created user identity.

Throws:

AuthLoginException - Thrown if user creation fails.