com.hcl.domino.keep.cache.impl

Enum NameLookupCacheHolder

java.lang.Object

java.lang.Enum<NameLookupCacheHolder>

com.hcl.domino.keep.cache.impl.NameLookupCacheHolder

All Implemented Interfaces:

KeepBaseCache, NameLookupCache, java.io.Serializable, java.lang.Comparable<NameLookupCacheHolder>

public enum NameLookupCacheHolder
extends java.lang.Enum<NameLookupCacheHolder>
implements NameLookupCache

Implementaton of NameLookupCache using the Domino backend classes

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Lookup cache instance as Singleton

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String notesName, java.lang.String eMail) Manually adds a cache entry into the caches
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
void	evict(java.lang.String notesName, java.lang.String eMail) Removes an cache entry from both Name and eMail lookup
java.util.Optional<java.lang.String>	getEmailFromNotesName(com.hcl.domino.DominoClient client, java.lang.String notesName, boolean ignoreCache) Retrieve the Internet eMail associated with a NotesName
java.util.Optional<java.lang.String>	getNotesNameFromEmail(com.hcl.domino.DominoClient client, java.lang.String eMailString, boolean ignoreCache) Retrieve a NotesName from an eMailId
boolean	hasEntry(java.lang.String key) Is a specific entry in the cache?
long	size()
java.util.Set<java.lang.String>	toEMail(com.hcl.domino.DominoClient client, java.util.Collection<java.lang.String> source) Translates a set of NotesName / eMail mix to eMails When an eMail is not found, the un-converted Name (which could be a group) gets returned
java.util.Set<java.lang.String>	toNotesName(com.hcl.domino.DominoClient client, java.util.Collection<java.lang.String> source) Translates a set of eMails to NotesNames When an NotesName is not found, the un-converted eMail gets returned
static NameLookupCacheHolder	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NameLookupCacheHolder[]	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.NameLookupCache

getEmailFromNotesName, getNotesNameFromEmail, toEMailJson

Methods inherited from interface com.hcl.domino.keep.cache.KeepBaseCache

getCachePrefix

Enum Constant Detail

INSTANCE

public static final NameLookupCacheHolder INSTANCE

Lookup cache instance as Singleton

Method Detail

values

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

Returns:

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

valueOf

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

add

public void add(java.lang.String notesName,
                java.lang.String eMail)

Description copied from interface: NameLookupCache

Manually adds a cache entry into the caches

Specified by:

add in interface NameLookupCache

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

evict

public void evict(java.lang.String notesName,
                  java.lang.String eMail)

Description copied from interface: NameLookupCache

Removes an cache entry from both Name and eMail lookup

Specified by:

evict in interface NameLookupCache

getEmailFromNotesName

public java.util.Optional<java.lang.String> getEmailFromNotesName(com.hcl.domino.DominoClient client,
                                                                  java.lang.String notesName,
                                                                  boolean ignoreCache)

Description copied from interface: NameLookupCache

Retrieve the Internet eMail associated with a NotesName

Specified by:

getEmailFromNotesName in interface NameLookupCache

Parameters:

client - DominoClient

notesName - a fully qualified Notes Name (X500) e.g. CN=John Doe/OU=Alpha/O=Acme Corp

ignoreCache -

• true -> cache is ignored, full scan

Returns:

Optional with eMail, empty if that user doesn’t exist

getNotesNameFromEmail

public java.util.Optional<java.lang.String> getNotesNameFromEmail(com.hcl.domino.DominoClient client,
                                                                  java.lang.String eMailString,
                                                                  boolean ignoreCache)

Description copied from interface: NameLookupCache

Retrieve a NotesName from an eMailId

Specified by:

getNotesNameFromEmail in interface NameLookupCache

Parameters:

client - DominoClient

eMailString -

• the eMail too look up

ignoreCache -

• true -> cache is ignored, full scan

Returns:

a qualified NotesName as Optional, empty if user not found

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

size

public long size()

Returns:

Number of entries in the bucket

toEMail

public java.util.Set<java.lang.String> toEMail(com.hcl.domino.DominoClient client,
                                               java.util.Collection<java.lang.String> source)

Description copied from interface: NameLookupCache

Translates a set of NotesName / eMail mix to eMails When an eMail is not found, the un-converted Name (which could be a group) gets returned

Specified by:

toEMail in interface NameLookupCache

Returns:

mostly eMails

toNotesName

public java.util.Set<java.lang.String> toNotesName(com.hcl.domino.DominoClient client,
                                                   java.util.Collection<java.lang.String> source)

Description copied from interface: NameLookupCache

Translates a set of eMails to NotesNames When an NotesName is not found, the un-converted eMail gets returned

Specified by:

toNotesName in interface NameLookupCache

Returns:

mostly eMails