com.hcl.domino.keep.cache.impl

Enum KeepApplicationCacheHolder

java.lang.Object

java.lang.Enum<KeepApplicationCacheHolder>

com.hcl.domino.keep.cache.impl.KeepApplicationCacheHolder

All Implemented Interfaces:

KeepApplicationCache, KeepBaseCache, java.io.Serializable, java.lang.Comparable<KeepApplicationCacheHolder>

public enum KeepApplicationCacheHolder
extends java.lang.Enum<KeepApplicationCacheHolder>
implements KeepApplicationCache

Class for caching external applications

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE SIngleton Instance

Method Summary

Modifier and Type	Method and Description
KeepApplicationConfigInfo	addToCache(KeepApplicationConfigInfo config) Adds external application to cache
void	clear() Clears the cache of all current members
io.vertx.core.json.JsonObject	dumpAllForAdmin() Converts all of bucket to a JsonObject
boolean	evict(java.lang.String key) Removes an entry from cache removing a non-existing key is still a success
KeepApplicationConfigInfo	getApplicationConfigInfo(java.lang.String key) Gets an external application by its application id
KeepApplicationConfigInfo	getApplicationConfigInfo(java.lang.String key, KeepJnxSession session) Gets or loads an external application by its application id
TheBarbican	getBarbican()
boolean	hasEntry(java.lang.String key) Is a specific entry in the cache?
void	setBarbican(TheBarbican barbican)
static KeepApplicationCacheHolder	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KeepApplicationCacheHolder[]	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 KeepApplicationCacheHolder INSTANCE

SIngleton Instance

Method Detail

values

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

Returns:

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

valueOf

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

addToCache

public KeepApplicationConfigInfo addToCache(KeepApplicationConfigInfo config)

Description copied from interface: KeepApplicationCache

Adds external application to cache

Specified by:

addToCache in interface KeepApplicationCache

Parameters:

config - external application config info

Returns:

Echo back for Stream API use

clear

public void clear()

Description copied from interface: KeepBaseCache

Clears the cache of all current members

Specified by:

clear in interface KeepBaseCache

dumpAllForAdmin

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

Description copied from interface: KeepApplicationCache

Converts all of bucket to a JsonObject

Specified by:

dumpAllForAdmin in interface KeepApplicationCache

Returns:

JsonObject with all entries

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

getApplicationConfigInfo

public KeepApplicationConfigInfo getApplicationConfigInfo(java.lang.String key)
                                                   throws KeepException

Description copied from interface: KeepApplicationCache

Gets an external application by its application id

Specified by:

getApplicationConfigInfo in interface KeepApplicationCache

Parameters:

key - application id

Returns:

KeepApplicationConfigInfo

Throws:

KeepException

getApplicationConfigInfo

public KeepApplicationConfigInfo getApplicationConfigInfo(java.lang.String key,
                                                          KeepJnxSession session)
                                                   throws KeepException

Description copied from interface: KeepApplicationCache

Gets or loads an external application by its application id

Specified by:

getApplicationConfigInfo in interface KeepApplicationCache

Parameters:

key - application id

session - a Keep session to load that info

Returns:

KeepApplicationConfigInfo

Throws:

KeepException

getBarbican

public TheBarbican getBarbican()

Returns:

The existing Barbican or a new instance

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

setBarbican

public void setBarbican(TheBarbican barbican)

Parameters:

barbican - a Barbican for Access control