com.bea.wli.config.derivedcache

Interface DerivedResourceManager

All Known Implementing Classes:

DerivedResourceManagerImpl

public interface DerivedResourceManager

This class manages 'derived' objects.

A derived object is an object that is created based on one or more resources (potentially of different types), or even other derived objects. Examples of such derived types: a compiled xquery, a WSDL object model (e.g. WSDL4J).

Derived objects of a given type are kept in a cache. Various cahing behaviours are available and should be used to best fit the need for the derived objects. E.g. objects that are transient, like a WSDL object model used for design time, could be registered using a weak o soft cache.

The lifecycle of a derived object is automatically handled by this manager. Especially, if a resource used by a derived object has been updated, the next time that derived object is queried it will be re-computed based on the updated resources. As such, client code of derived objects should not cache this derived object but instead query it everytime it is used.

Method Summary

Modifier and Type	Method and Description
<T> T	get(Ref ref) Returns the derived value associated with the given reference
<T> T	get(Ref ref, boolean recompute)
<T extends DerivedTypeDef> T	getDerivedTypeDef(java.lang.String typeId) Returns the derived type definition with the given id.
DerivedCachesDocument	getDiagnostics() Returns the DFW diagnostics for all the derived caches maintained by the derived resource manager
DerivedCachesDocument	getDiagnostics(java.lang.String typeId) Returns the DFW diagnostics given a DerivedType ID
boolean	isDerivedTypeId(java.lang.String typeId) Returns true if the given type id represents a DerivedTypeDef
boolean	isValidRef(Ref ref) Returns true if the derived resource with the given reference is valid, i.e., exists
<V> void	registerHardDerivedType(DerivedTypeDef<V> derivedTypeDef) Registers a derived type whose values will be stored using hard references.
<V> void	registerLRUDerivedType(DerivedTypeDef<V> derivedTypeDef, int cacheSize, EvictionHandler<V> handler) Registers a derived type whose values will be stored in an LRU cache and therefore can be evicted from the cache
<V> void	registerMultiLevelDerivedType(DerivedTypeDef<V> derivedTypeDef, int cacheSize, GarbageCollectionHandler<V,?> handler) Creates a multi level cache.
<V> void	registerSoftDerivedType(DerivedTypeDef<V> derivedTypeDef, GarbageCollectionHandler<V,?> handler) Registers a derived type whose values will be stored using soft references.
<V> void	registerWeakDerivedType(DerivedTypeDef<V> derivedTypeDef, GarbageCollectionHandler<V,?> handler) Registers a derived type whose values will be stored using weak references.

Method Detail

registerHardDerivedType

<V> void registerHardDerivedType(DerivedTypeDef<V> derivedTypeDef)

Registers a derived type whose values will be stored using hard references.

Type Parameters:

V - the type of the derived value

Parameters:

derivedTypeDef - the derived type.

registerSoftDerivedType

<V> void registerSoftDerivedType(DerivedTypeDef<V> derivedTypeDef,
                                 GarbageCollectionHandler<V,?> handler)

Registers a derived type whose values will be stored using soft references.

Type Parameters:

V - the type of the derived value

Parameters:

derivedTypeDef - the derived type.

handler - handler to be notified after a derived value has been garbage collected. Can be null.

registerWeakDerivedType

<V> void registerWeakDerivedType(DerivedTypeDef<V> derivedTypeDef,
                                 GarbageCollectionHandler<V,?> handler)

Registers a derived type whose values will be stored using weak references.

Type Parameters:

V - the type of the derived value

Parameters:

derivedTypeDef - the derived type.

handler - handler to be notified after a derived value has been garbage collected. Can be null.

registerLRUDerivedType

<V> void registerLRUDerivedType(DerivedTypeDef<V> derivedTypeDef,
                                int cacheSize,
                                EvictionHandler<V> handler)

Registers a derived type whose values will be stored in an LRU cache and therefore can be evicted from the cache

Parameters:

derivedTypeDef - the derived type

cacheSize - the size of the LRU cache

handler - the handler that will be called some time after a derived value has been evicted from the cache. Can be null.

registerMultiLevelDerivedType

<V> void registerMultiLevelDerivedType(DerivedTypeDef<V> derivedTypeDef,
                                       int cacheSize,
                                       GarbageCollectionHandler<V,?> handler)

Creates a multi level cache. The top level cache is an LRU cache with finite size. The second level cache is an infinitely sized soft cache. Derived values that are frequently requested are kept in the top level LRU cache. Others are evicted and placed in the second level cache. They remain in the soft cache until they are garbage collected.

Parameters:

derivedTypeDef - the derived type

cacheSize - the size of the LRU cache

handler - handler to be notified after a derived value has been garbage collected. Can be null.

isDerivedTypeId

boolean isDerivedTypeId(java.lang.String typeId)

Returns true if the given type id represents a DerivedTypeDef

getDerivedTypeDef

<T extends DerivedTypeDef> T getDerivedTypeDef(java.lang.String typeId)

Returns the derived type definition with the given id.

isValidRef

boolean isValidRef(Ref ref)

Returns true if the derived resource with the given reference is valid, i.e., exists

Parameters:

ref - reference to the derived resource

get

<T> T get(Ref ref)
   throws NotFoundException

Returns the derived value associated with the given reference

Parameters:

ref - reference to the derived resource

Throws:

NotFoundException - thrown if the reference does not exist or the derived object could not be computed.

get

<T> T get(Ref ref,
          boolean recompute)
   throws NotFoundException

Throws:

NotFoundException

getDiagnostics

DerivedCachesDocument getDiagnostics()

Returns the DFW diagnostics for all the derived caches maintained by the derived resource manager

getDiagnostics

DerivedCachesDocument getDiagnostics(java.lang.String typeId)

Returns the DFW diagnostics given a DerivedType ID

Parameters:

the - derived type id