com.hcl.domino.keep.cache.impl

Enum KeepUsersHolder

java.lang.Object

java.lang.Enum<KeepUsersHolder>

com.hcl.domino.keep.cache.impl.KeepUsersHolder

All Implemented Interfaces:

KeepBaseCache, KeepUsers, java.io.Serializable, java.lang.Comparable<KeepUsersHolder>

public enum KeepUsersHolder
extends java.lang.Enum<KeepUsersHolder>
implements KeepUsers

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton implementation using an ENUM

Method Summary

Modifier and Type	Method and Description
KeepUsers	addServers(io.vertx.core.json.JsonObject serverListIncoming)
KeepUser	addUser(KeepUser keepUser) Update a vert.x user into to cache to capture additional propertied
void	clear() Clears the cache of all current members
boolean	evict(java.lang.String key) Removes an entry from cache removing a non-existing key is still a success
io.vertx.core.Future<java.lang.String>	getMailboxDatabaseName(io.vertx.core.Vertx vertx, KeepFactory factory, KeepUser incomingUser, java.lang.String calendarName, java.lang.String alternateMailboxId)
KeepUser	getUser(java.lang.String userName) Returns a KeepUser instance from Cache for processing and update
KeepUser	getUser(io.vertx.ext.auth.User vertxUser, boolean allowJwtMail) Converts a Vert.x user object into a KeepUser
boolean	hasEntry(java.lang.String key) Is a specific entry in the cache?
static KeepUsersHolder	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KeepUsersHolder[]	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.cache.KeepBaseCache

getCachePrefix

Enum Constant Detail

INSTANCE

public static final KeepUsersHolder INSTANCE

Singleton implementation using an ENUM

Method Detail

values

public static KeepUsersHolder[] 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 (KeepUsersHolder c : KeepUsersHolder.values())
    System.out.println(c);

Returns:

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

valueOf

public static KeepUsersHolder 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

addServers

public KeepUsers addServers(io.vertx.core.json.JsonObject serverListIncoming)

Specified by:

addServers in interface KeepUsers

Parameters:

serverListIncoming -

• list of servers with details

Returns:

fluent

addUser

public KeepUser addUser(KeepUser keepUser)

Description copied from interface: KeepUsers

Update a vert.x user into to cache to capture additional propertied

Specified by:

addUser in interface KeepUsers

Returns:

updated keepUser

clear

public void clear()

Description copied from interface: KeepBaseCache

Clears the cache of all current members

Specified by:

clear in interface KeepBaseCache

evict

public boolean evict(java.lang.String key)

Description copied from interface: KeepBaseCache

Removes an entry from cache removing a non-existing key is still a success

Specified by:

evict in interface KeepBaseCache

Parameters:

key -

• key to remove

Returns:

success of eviction, true if eviction worked

getMailboxDatabaseName

public io.vertx.core.Future<java.lang.String> getMailboxDatabaseName(io.vertx.core.Vertx vertx,
                                                                     KeepFactory factory,
                                                                     KeepUser incomingUser,
                                                                     java.lang.String calendarName,
                                                                     java.lang.String alternateMailboxId)

Specified by:

getMailboxDatabaseName in interface KeepUsers

factory -

• Keep factory

incomingUser -

• current user

calendarName -

• name of the calendar - might need a different database

alternateMailboxId - Delegated access

Returns:

the mail file of the user

getUser

public KeepUser getUser(java.lang.String userName)

Description copied from interface: KeepUsers

Returns a KeepUser instance from Cache for processing and update

Specified by:

getUser in interface KeepUsers

Parameters:

userName -

• Full qualified user name

Returns:

• KeepUser object

getUser

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

Description copied from interface: KeepUsers

Converts a Vert.x user object into a KeepUser

Specified by:

getUser in interface KeepUsers

Parameters:

vertxUser -

• vert.x platform user

allowJwtMail -

• allow to use JWT defined emails

Returns:

KeepUser - KeepUser

hasEntry

public boolean hasEntry(java.lang.String key)

Description copied from interface: KeepBaseCache

Is a specific entry in the cache?

Specified by:

hasEntry in interface KeepBaseCache

Parameters:

key -

• hash value of the request

Returns:

true if the cache contains that value