com.hcl.domino.keep.security

Class KeepUser

java.lang.Object

com.hcl.domino.keep.security.KeepUser

All Implemented Interfaces:

io.vertx.ext.auth.User

public class KeepUser
extends java.lang.Object
implements io.vertx.ext.auth.User

Information about the current user and the permissions the user has in various places

Method Summary

Modifier and Type	Method and Description
io.vertx.core.json.JsonObject	attributes()
java.lang.String	getInternetEmail()
java.lang.String	getMailDomain()
java.lang.String	getMailFileName()
java.lang.String	getMailServer()
io.vertx.core.json.JsonObject	getPrincipal()
static KeepUser	getUser(java.lang.String incoming)
static KeepUser	getUser(io.vertx.ext.auth.User vertxUser, boolean allowJwtMail) Creates a keep user based on an authenticated user coming in from the platform
java.lang.String	getUserName()
io.vertx.ext.auth.User	isAuthorized(io.vertx.ext.auth.authorization.Authorization authority, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>> resultHandler) Deprecated.
boolean	isLocalUser()
KeepUser	isLocalUser(boolean isLocal)
boolean	isTryMailReplica()
KeepUser	mergeIn(KeepUser ku)
io.vertx.core.json.JsonObject	principal()
void	setAuthProvider(io.vertx.ext.auth.AuthProvider authProvider) Deprecated.
KeepUser	setInternetEmail(java.lang.String internetEmail)
KeepUser	setMailDomain(java.lang.String mailDomain)
KeepUser	setMailFileName(java.lang.String mailFileName)
KeepUser	setMailServer(java.lang.String mailServer)
java.lang.String	toString()
KeepUser	updateFromJson(io.vertx.core.json.JsonObject result)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.vertx.ext.auth.User

authorizations, clearCache, containsKey, create, create, expired, expired, fromName, fromToken, get, isAuthorized, isAuthorized, isAuthorized

Method Detail

getUser

public static KeepUser getUser(java.lang.String incoming)

Parameters:

incoming -

Returns:

a KeepUser

getUser

public static KeepUser getUser(io.vertx.ext.auth.User vertxUser,
                               boolean allowJwtMail)

Creates a keep user based on an authenticated user coming in from the platform

Parameters:

vertxUser -

• User coming in from vert.x platform

allowJwtMail -

• true if a mail file name in the JWT can be accepted

Returns:

a Keep User

attributes

public io.vertx.core.json.JsonObject attributes()

Specified by:

attributes in interface io.vertx.ext.auth.User

getInternetEmail

public java.lang.String getInternetEmail()

Returns:

the internetEmail

getMailDomain

public java.lang.String getMailDomain()

Returns:

the mailDomain

getMailFileName

public java.lang.String getMailFileName()

Returns:

the mailFileName

getMailServer

public java.lang.String getMailServer()

Returns:

the mailServer

getPrincipal

public io.vertx.core.json.JsonObject getPrincipal()

Returns:

The JSON object showing the principal, JWT claim for JWT

getUserName

public java.lang.String getUserName()

Returns:

User name

isAuthorized

@Deprecated
public io.vertx.ext.auth.User isAuthorized(io.vertx.ext.auth.authorization.Authorization authority,
                                                       io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>> resultHandler)

Deprecated.

Specified by:

isAuthorized in interface io.vertx.ext.auth.User

isLocalUser

public boolean isLocalUser()

Returns:

true if this was a local user

isLocalUser

public KeepUser isLocalUser(boolean isLocal)

Parameters:

isLocal -

• is this a local user

Returns:

fluent

isTryMailReplica

public boolean isTryMailReplica()

Returns:

the tryMailReplica

mergeIn

public KeepUser mergeIn(KeepUser ku)

Parameters:

ku -

• new KeepUser info

Returns:

the updated user

principal

public io.vertx.core.json.JsonObject principal()

Specified by:

principal in interface io.vertx.ext.auth.User

setAuthProvider

@Deprecated
public void setAuthProvider(io.vertx.ext.auth.AuthProvider authProvider)

Deprecated.

Specified by:

setAuthProvider in interface io.vertx.ext.auth.User

setInternetEmail

public KeepUser setInternetEmail(java.lang.String internetEmail)

Parameters:

internetEmail - the internetEmail to set

Returns:

fluent

setMailDomain

public KeepUser setMailDomain(java.lang.String mailDomain)

Parameters:

mailDomain - the mailDomain to set

Returns:

fluent

setMailFileName

public KeepUser setMailFileName(java.lang.String mailFileName)

Parameters:

mailFileName - the mailFileName to set

Returns:

fluent

setMailServer

public KeepUser setMailServer(java.lang.String mailServer)

Parameters:

mailServer - the mailServer to set

Returns:

fluent

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

updateFromJson

public KeepUser updateFromJson(io.vertx.core.json.JsonObject result)

Parameters:

result -

• A JsonObject

Returns:

fluent