com.hcl.domino.security

Interface CredentialValidationTokenHandler<T>

Type Parameters:

T - the class consumed by this handler

All Superinterfaces:

UserTokenHandler<T>

public interface CredentialValidationTokenHandler<T>
extends UserTokenHandler<T>

This service interface represents a provider that is able to process a token supplied to DominoClient.validateCredentialsWithToken(String, Object) and retrieve the user's distinguished name.

Since:

1.0.19

Author:

Jesse Gallagher

Method Summary

Modifier and Type	Method and Description
Optional<String>	getUserDn(T token, String serverName, DominoClient contextDominoClient) Processes the provided token object to look up the user DN.

Methods inherited from interface com.hcl.domino.security.UserTokenHandler

canProcess

Method Detail

getUserDn

Optional<String> getUserDn(T token,
                           String serverName,
                           DominoClient contextDominoClient)
                    throws NameNotFoundException,
                           AuthenticationException,
                           AuthenticationNotSupportedException

Processes the provided token object to look up the user DN.

This method is potentially called when UserTokenHandler.canProcess(Object) returns true and should either:

1. Return an Optional describing a user DN if found,
2. Return an empty optional if the token was processable but no matching user exists (e.g. if this object represents one of many potential directories), or
3. Throw an exception if the token was invalid or otherwise unprocessable.

Parameters:

token - the token to process

serverName - the name of the server to look up on (may be ignored by implementations)

contextDominoClient - the DominoClient instance calling the method

Returns:

an Optional describing the user's DN, or an empty one if a matching user cannot be located

Throws:

NameNotFoundException - if the token does not match a user but this implementation is considered fully authoritative

AuthenticationException - if the credential matches a user but does not meet authentication requirements (e.g. if the password is incorrect)

AuthenticationNotSupportedException - if the user exists but is not configured to authenticate with this token