Package com.webmethods.portal.service.cache.caches

Interface IAliasCache

All Superinterfaces:

ICache, IComponent, IDBCache, IInitializable

public interface IAliasCache
extends IDBCache

The Alias key class manages the various aliases There are three main concepts in aliases: 1) Source is the key identifier That's what this represents. This can be either an IURI or a string 2) Target is the value. This can be either an IURI|IThingID or a string 3) Params are the optional name value pairs to append to the target

See Also:

• AliasKey
• AliasValue

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface com.webmethods.portal.service.cache.ICache

ID, ISCLUSTERED, MAX_SIZE

Fields inherited from interface com.webmethods.portal.service.cache.caches.IDBCache

INVAL_KEYA, INVAL_KEYB, INVAL_KEYNAME, INVAL_PRIMARY, INVAL_SECONDARY

Method Summary

Modifier and Type	Method	Description
ICacheKey	createKey(IThingID thingID)	Create a new cache key based on a thingID
ICacheKey	createKey(IURI uri)	Create a new cache key based on a uri
ICacheKey	createKey(String aliasKey)	Create a new cache key based on just a string
ICacheKey	createKey(String key, IThingID userID)	Create a new cache key based on a key and a user's id call #releaseKey after
Collection<ICacheEntry>	lookupKeys()	retrieve a list of all available ICacheEntrys
Collection<IAliasKey>	lookupKeysForValue(IAliasValue aliasValue)	Give the current AliasValue, retrieve a list of AliasKeys that point to that AliasValue
void	reload()	Reload alias cache
void	removeAlias(ICacheKey cacheKey)	Removes an alias
void	setMetaContext(IMetaContext mc)	sets the meta context(for remote cache lookups)

Methods inherited from interface com.webmethods.portal.service.cache.ICache

createKey, createKey, createKey, flush, flushAll, flushAll, getCacheManager, getEntry, getMaxSize, getModified, getName, getReport, getSize, getValue, isClustered, put, refresh, update

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.service.cache.caches.IDBCache

createKey, invalidateByKey, purgeCache

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

createKey

ICacheKey createKey(String aliasKey)

Create a new cache key based on just a string

Parameters:

aliasKey -

Returns:

an AliasKey

createKey

ICacheKey createKey(IURI uri)

Create a new cache key based on a uri

Parameters:

uri -

Returns:

an AliasKey

createKey

ICacheKey createKey(IThingID thingID)

Create a new cache key based on a thingID

Parameters:

thingID -

Returns:

an AliasKey

createKey

ICacheKey createKey(String key,
 IThingID userID)

Create a new cache key based on a key and a user's id call #releaseKey after

Parameters:

key -

userID -

Returns:

an AliasKey

removeAlias

void removeAlias(ICacheKey cacheKey)
          throws CacheException

Removes an alias

Parameters:

cacheKey -

Throws:

CacheException

lookupKeys

Collection<ICacheEntry> lookupKeys()

retrieve a list of all available ICacheEntrys

Returns:

lookupKeysForValue

Collection<IAliasKey> lookupKeysForValue(IAliasValue aliasValue)

Give the current AliasValue, retrieve a list of AliasKeys that point to that AliasValue

Parameters:

aliasValue -

Returns:

setMetaContext

void setMetaContext(IMetaContext mc)

sets the meta context(for remote cache lookups)

Parameters:

mc -

reload

void reload()

Reload alias cache