oracle.apps.fnd.appltest.diagfwk.engine.provider.cache
Class CacheProvider

java.lang.Object
  oracle.apps.fnd.appltest.diagfwk.common.DiagBaseFactory
      oracle.apps.fnd.appltest.diagfwk.engine.provider.cache.CacheProvider

All Implemented Interfaces:

DiagConstants

Direct Known Subclasses:

DefaultGlobalCacheProvider

public abstract class CacheProvider
extends DiagBaseFactory

A generic cache provider API. Currently only supports global cache but could be extended in the future to provide implementations that are session specific.

Since:

release specific (what release of product did this appear in)

Version:

$Header: atgpf/appltest/applications/Diagnostics/Engine/src/oracle/apps/fnd/appltest/diagfwk/engine/provider/cache/CacheProvider.java /main/1 2008/12/03 18:46:35 ppradhan Exp $

Author:

ppradhan

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

DiagConstants.ExecutionMode, DiagConstants.Format, DiagConstants.LinkType, DiagConstants.Status

Field Summary

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

APPS_MSG_ID_TAG_NAME, CFG_ADR_PROVIDER_CLASS, CFG_CACHE_PROVIDER_CLASS, CFG_CRED_PROVIDER_CLASS, CFG_DAO_FACTORY_CLASS, CFG_DB_CONN_INFO_PROVIDER_CLASS, CFG_DB_CONN_PROVIDER_CLASS, CFG_NLS_PROVIDER_CLASS, CFG_PLSQL_PROVIDER_CLASS, CFG_PROFILE_PROVIDER_CLASS, CFG_SECURITY_PROVIDER_CLASS, CFG_SESSION_INFO_PROVIDER_CLASS, CFG_URL_PROVIDER_FACTORY_CLASS, CFG_WLS_MBEANSRV_CONNINFO_PROVIDER_CLASS, DATA_SECURITY_PERMISSION_ALLOWED, DATA_SECURITY_PERMISSION_NOT_ALLOWED, DELIM_URL, EXEC_MODE_CLI, EXEC_MODE_ESS, EXEC_MODE_INCIDENT, EXEC_MODE_JAVA, EXEC_MODE_UI, EXECUTABLE_TYPE_JAVA, EXECUTABLE_TYPE_PLSQL, EXECUTABLE_TYPE_TESTREF, FORMAT_HTML, FORMAT_XML, GUID_ORACLE_MINUS1, GUID_ORACLE_ZERO, INPUTS_STATUS_ALL_OPT_INPUTS, INPUTS_STATUS_NO_INPUTS, INPUTS_STATUS_REQ_INPUTS_NO_DEFAULTS, INPUTS_STATUS_REQ_INPUTS_W_DEFAULTS, IO_FLAG_I, IO_FLAG_O, JMX_API_BASE_OBJECT_NAME, LINK_EXTERNAL, LINK_INTERNAL, LINK_METALINK, N, NLS_BUNDLE_JAVA_RES, NLS_BUNDLE_MSG_SVC, NLS_BUNDLE_RES_REF, NLS_BUNDLE_XLIFF, NO, NULL, ODF_MBEAN_DOMAIN_NAME, PARAM_MON_INTERVAL, PLSQL_DEBUG_ENABLED_SYSTEM_PROP, PREREQ_TYPE_TAG_VALUE, PREREQ_TYPE_TEST, SECONDS_IN_ONE_DAY, SECONDS_IN_ONE_HOUR, STATUS_CANCELED, STATUS_EXECERROR, STATUS_FAILURE, STATUS_RUNNING, STATUS_SUCCESS, STATUS_WARNING, SYS_PROP_MAX_MONITOR_INTERNVAL, SYS_PROP_MAX_NUM_THREADS, SYSPROP_APPCONNFILE, SYSPROP_DIAG_CONFIG_FILE, TAG_TYPE_DIAG, TAG_TYPE_TAXONOMY, TEST_TYPE_DECL, TEST_TYPE_JAVA, USER_NAME, WEB_APP_NAME_TAG_NAME, Y, YES

Constructor Summary

CacheProvider()

Method Summary

static void	clear() Clears the cache of all existing objects
abstract void	clearCache() Clears the cache of all existing objects
static boolean	containsKey(java.lang.String pKey) Checks wether an object exists in the cache with the given key
static java.lang.Object	get(java.lang.String pKey) Gets an object from the cache with the given key
abstract java.util.Set	getKeys() Returns keys to all the existing objects in the caches
abstract java.lang.Object	getObject(java.lang.String pKey) Gets an object from the cache with the given key
abstract boolean	hasKey(java.lang.String pKey) Checks wether an object exists in the cache with the given key
static java.util.Set	keySet() Returns keys to all the existing objects in the caches
static void	put(java.lang.String pKey, java.lang.Object pObj) Puts the given object into the cache with the given key
abstract void	putObject(java.lang.String pKey, java.lang.Object pObj) Puts the given object into the cache with the given key
static void	remove(java.lang.String pKey) Removes the object with the given key from the cache
abstract void	removeObject(java.lang.String pKey) Removes the object with the given key from the cache

Methods inherited from class oracle.apps.fnd.appltest.diagfwk.common.DiagBaseFactory

createClassLoader, loadClassFor

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheProvider

public CacheProvider()

Method Detail

getObject

public abstract java.lang.Object getObject(java.lang.String pKey)

Gets an object from the cache with the given key

Parameters:

pKey - key for the object to lookup from cache

Returns:

object from cache with the given key if it exists. Otherwise returns null.

putObject

public abstract void putObject(java.lang.String pKey,
                               java.lang.Object pObj)

Puts the given object into the cache with the given key

Parameters:

pKey - key for the object to put into the cache

pObj - object to put into the cahce

removeObject

public abstract void removeObject(java.lang.String pKey)

Removes the object with the given key from the cache

Parameters:

pKey - key for the object to remove from the cache

getKeys

public abstract java.util.Set getKeys()

Returns keys to all the existing objects in the caches

Returns:

the keys to all the existing objects in the cache.

hasKey

public abstract boolean hasKey(java.lang.String pKey)

Checks wether an object exists in the cache with the given key

Parameters:

pKey - key to check for in the cache

Returns:

true if the key exists in cache. Returns false otherwise

clearCache

public abstract void clearCache()

Clears the cache of all existing objects

get

public static java.lang.Object get(java.lang.String pKey)

Gets an object from the cache with the given key

Parameters:

pKey - key for the object to lookup from cache

Returns:

object from cache with the given key if it exists. Otherwise returns null.

put

public static void put(java.lang.String pKey,
                       java.lang.Object pObj)

Puts the given object into the cache with the given key

Parameters:

pKey - key for the object to put into the cache

pObj - object to put into the cahce

remove

public static void remove(java.lang.String pKey)

Removes the object with the given key from the cache

Parameters:

pKey - key for the object to remove from the cache

clear

public static void clear()

Clears the cache of all existing objects

keySet

public static java.util.Set keySet()

Returns keys to all the existing objects in the caches

Returns:

the keys to all the existing objects in the cache.

containsKey

public static boolean containsKey(java.lang.String pKey)

Checks wether an object exists in the cache with the given key

Parameters:

pKey - key to check for in the cache

Returns:

true if the key exists in cache. Returns false otherwise