Top Description Methods
io.undertow.security.idm

public Interface IdentityManager

The IdentityManager interface to be implemented by an identity manager implementation providing user verification and identity loading to Undertow.

Note

The IdentityManager interface is very much work in progress, methods are added to cover use cases as identified and then simplified as common cases are defined.

Author
Darran Lofthouse

Method Summary

Modifier and TypeMethod and Description
public Account

Returns:

An updates Account if verification is successful, null otherwise.
verify(final Account
- The Account to verify.
account)

Verify a previously authenticated account.

public Account

Returns:

The Account for the user if verification was successful, null otherwise.
verify(final String
- The requested ID for the account.
id, final Credential
- The Credential to verify.
credential)

Verify a supplied Credential against a requested ID.

public Account
verify(final Credential credential)

Perform verification when all we have is the Credential, in this case the IdentityManager is also responsible for mapping the Credential to an account.

Method Detail

verifyback to summary
public Account verify(final Account account)

Verify a previously authenticated account. Typical checks could be along the lines of verifying that the account is not now locked or that the password has not been reset since last verified, also this provides an opportunity for roles to be re-loaded if membership information has changed.

Parameters
account:Account

- The Account to verify.

Returns:Account

An updates Account if verification is successful, null otherwise.

verifyback to summary
public Account verify(final String id, final Credential credential)

Verify a supplied Credential against a requested ID.

Parameters
id:String

- The requested ID for the account.

credential:Credential

- The Credential to verify.

Returns:Account

The Account for the user if verification was successful, null otherwise.

verifyback to summary
public Account verify(final Credential credential)

Perform verification when all we have is the Credential, in this case the IdentityManager is also responsible for mapping the Credential to an account. The most common scenario for this would be mapping an X509Certificate to the user it is associated with.