com.hcl.domino.keep.security

Enum JwtManagerHolder

java.lang.Object

java.lang.Enum<JwtManagerHolder>

com.hcl.domino.keep.security.JwtManagerHolder

All Implemented Interfaces:

JwtManager, java.io.Serializable, java.lang.Comparable<JwtManagerHolder>

public enum JwtManagerHolder
extends java.lang.Enum<JwtManagerHolder>
implements JwtManager

Holds the JWT Configuration for the running session of KEEP

Nested Class Summary

Nested classes/interfaces inherited from interface com.hcl.domino.keep.security.JwtManager

JwtManager.JwtNotSetupException

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton for JwtManager

Method Summary

Modifier and Type	Method and Description
io.vertx.core.Future<java.lang.String>	extractScopes(java.lang.String jwt) Extracts the Scope string a valid JWT Token might present,
io.vertx.core.Future<KeepUser>	extractUser(java.lang.String jwt) Turns a JWT string into a Domino user based on a JWT Claim
io.vertx.ext.auth.jwt.JWTAuth	getAuthprovider()
java.util.Optional<io.vertx.core.json.JsonObject>	getTokenForUserSync(java.lang.String username, java.lang.String scopes)
io.vertx.core.Future<io.vertx.ext.auth.jwt.JWTAuth>	initializeAuthprovider(io.vertx.core.Vertx vertx, io.vertx.core.json.JsonObject systemConfig)
boolean	isAllowJwtMail()
void	setAuthProvider(io.vertx.ext.auth.jwt.JWTAuth newProvider) Replace the authentication provider, used for tests only
static JwtManagerHolder	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JwtManagerHolder[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hcl.domino.keep.security.JwtManager

extractScopeSet, extractUserUnverified, getTokenForUser, hasDecryptScope, timeToExpiry

Enum Constant Detail

INSTANCE

public static final JwtManagerHolder INSTANCE

Singleton for JwtManager

Method Detail

values

public static JwtManagerHolder[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JwtManagerHolder c : JwtManagerHolder.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JwtManagerHolder valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

extractScopes

public io.vertx.core.Future<java.lang.String> extractScopes(java.lang.String jwt)

Description copied from interface: JwtManager

Extracts the Scope string a valid JWT Token might present,

Specified by:

extractScopes in interface JwtManager

Parameters:

jwt - The JWT Token

Returns:

the found claim or an empty String

extractUser

public io.vertx.core.Future<KeepUser> extractUser(@Nonnull
                                                  java.lang.String jwt)

Turns a JWT string into a Domino user based on a JWT Claim

Specified by:

extractUser in interface JwtManager

Parameters:

jwt - the JWT token

Returns:

a complete KeepUser

getAuthprovider

public io.vertx.ext.auth.jwt.JWTAuth getAuthprovider()
                                              throws JwtManager.JwtNotSetupException

Specified by:

getAuthprovider in interface JwtManager

Returns:

the authentication provider if setup otherwise null

Throws:

JwtManager.JwtNotSetupException

getTokenForUserSync

public java.util.Optional<io.vertx.core.json.JsonObject> getTokenForUserSync(java.lang.String username,
                                                                             java.lang.String scopes)

Specified by:

getTokenForUserSync in interface JwtManager

Parameters:

username -

• Notes Name

scopes -

• scopes to access, null if default

Returns:

a qualified JWT Token or an empty Optional

initializeAuthprovider

public io.vertx.core.Future<io.vertx.ext.auth.jwt.JWTAuth> initializeAuthprovider(io.vertx.core.Vertx vertx,
                                                                                  io.vertx.core.json.JsonObject systemConfig)

Specified by:

initializeAuthprovider in interface JwtManager

Returns:

JWTAuth - a future with the auth provider

isAllowJwtMail

public boolean isAllowJwtMail()

Specified by:

isAllowJwtMail in interface JwtManager

Returns:

Does the JWT Manager allow to extract the Mail info from JWT

setAuthProvider

public void setAuthProvider(io.vertx.ext.auth.jwt.JWTAuth newProvider)

Description copied from interface: JwtManager

Replace the authentication provider, used for tests only

Specified by:

setAuthProvider in interface JwtManager