com.hcl.domino.admin.idvault

Interface IdVaultTokenHandler<T>

Type Parameters:

T - the class consumed by this handler

All Superinterfaces:

UserTokenHandler<T>

public interface IdVaultTokenHandler<T>
extends UserTokenHandler<T>

This service interface represents a provider that is able to process a token supplied to IdVault.getUserIdWithToken(Object, String) and retrieve a UserId implementation.

Since:

1.0.19

Author:

Jesse Gallagher

Method Summary

Modifier and Type	Method and Description
Optional<UserId>	getUserId(T token, String serverName, IdVault contextIdVault) Processes the provided token object to look up a UserId representation.

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

canProcess

Method Detail

getUserId

Optional<UserId> getUserId(T token,
                           String serverName,
                           IdVault contextIdVault)

Processes the provided token object to look up a UserId representation.

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

1. Return an Optional describing a user ID 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)

contextIdVault - the IdVault instance calling the method

Returns:

an Optional describing a UserId, or an empty one if a matching user cannot be located