oracle.ifs.beans

Class ConnectedLibraryObjectCache

java.lang.Object

oracle.ifs.common.Cache

oracle.ifs.common.BoundedCache

oracle.ifs.common.LibraryObjectCache

oracle.ifs.beans.ConnectedLibraryObjectCache

public final class ConnectedLibraryObjectCache
extends LibraryObjectCache

A ConnectedLibraryObjectCache is a cache that is "connected" to a oracle.ifs.server.cache.BoundedLibraryObjectCache for access to cached LibraryObjects. Since BoundedLibraryObjectCache depends on JDK version 1.2 or higher, this class cannot be utilized in earlier versons of the VM.

A ConnectedLibraryObjectCache is just a subclass of Cache, and not BoundedCache - even though the cache entries are actually bounded by the underlying BoundedLibraryObjectCache.

Note: this class requires JRE 1.2.2 or higher.

Version:

1.0

Author:

Dave Long

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected BoundedLibraryObjectCache	m_ServerCache The server-side BoundedLibraryObjectCache that this cache is connected to.
protected LibrarySession	m_Session The server-side BoundedLibraryObjectCache that this cache is connected to.

Fields inherited from class oracle.ifs.common.Cache

m_Configuration

Constructor Summary

Constructors

Constructor and Description
ConnectedLibraryObjectCache(BoundedCacheConfiguration configuration, S_LibrarySession ssession, LibrarySession session) Construct a ConnectedLibraryObjectCache

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes this cache.
Object	find(Object id) Gets an item from this cache.
CachePerformance	getCachePerformance() Gets the performance information for this cache.
Enumeration	getElements() Gets an Enumeration of the LibraryObjects in this cache.
void	lock(Object id, Object value) Locks an item in this cache.
void	markEntriesAsUntrusted() Mark all PublicObject entries as untrusted.
void	markEntryAsUntrusted(Object itemKey) Mark an entry as untrusted due to security changes for the specified object.
void	markFreeCancelled(Long id) Respond to a FREE event that has been rolled back for the specified object.
void	markFreeInitiated(Long id) Respond to an uncommitted free operation.
void	performNormalPurgeIfNeeded() Purge Cache if a request for "normal" purge is indicated
void	performUrgentPurgeIfNeeded() Purge Cache if a request for "urgent" purge is indicated
void	put(Object id, Object value) Puts an item in this cache.
void	remove(Object id) Removes an item from this cache.
void	resetCachePerformance() Resets the performance information for this cache.
void	setCacheConfiguration(CacheConfiguration configuration) Alters the configuration of this cache.

Methods inherited from class oracle.ifs.common.Cache

getCacheConfiguration, reset

Methods inherited from class java.lang.Object

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

Field Detail

m_ServerCache

protected BoundedLibraryObjectCache m_ServerCache

The server-side BoundedLibraryObjectCache that this cache is connected to.

(Unpublished)

m_Session

protected LibrarySession m_Session

The server-side BoundedLibraryObjectCache that this cache is connected to.

(Unpublished)

Constructor Detail

ConnectedLibraryObjectCache

public ConnectedLibraryObjectCache(BoundedCacheConfiguration configuration,
                                   S_LibrarySession ssession,
                                   LibrarySession session)

Construct a ConnectedLibraryObjectCache

Parameters:

configuration - the configuration paramaters for the new cache

(Unpublished)

Method Detail

setCacheConfiguration

public final void setCacheConfiguration(CacheConfiguration configuration)
                                 throws IfsException

Alters the configuration of this cache. This currently does nothing; the cache configuration of the server-side BoundedLibraryObjectCache is modified by calling setCacheConfiguration() on that class directly.

Specified by:

setCacheConfiguration in class Cache

Parameters:

configuration - the configuration parameters; must be a BoundedCacheConfiguration

Throws:

IfsException - if the operation fails

(Unpublished)

find

public final Object find(Object id)
                  throws IfsException

Gets an item from this cache.

Specified by:

find in class Cache

Parameters:

id - the item id

Returns:

the item, or null if the item is not in this cache

Throws:

IfsException - if operation fails

(Unpublished)

remove

public final void remove(Object id)
                  throws IfsException

Removes an item from this cache.

Specified by:

remove in class Cache

Parameters:

id - the item id

Throws:

IfsException - if operation fails

(Unpublished)

put

public final void put(Object id,
                      Object value)
               throws IfsException

Puts an item in this cache.

Specified by:

put in class Cache

Parameters:

id - the item id

value - the item

Throws:

IfsException - if operation fails

(Unpublished)

getElements

public Enumeration getElements()
                        throws IfsException

Gets an Enumeration of the LibraryObjects in this cache.

Overrides:

getElements in class Cache

Returns:

the enumeration of LibraryObjects

Throws:

IfsException - if operation fails

(Unpublished)

lock

public void lock(Object id,
                 Object value)
          throws IfsException

Locks an item in this cache.

Specified by:

lock in class BoundedCache

Parameters:

id - the item id

value - the item

Throws:

IfsException - if the operation fails

(Unpublished)

performNormalPurgeIfNeeded

public void performNormalPurgeIfNeeded()

Purge Cache if a request for "normal" purge is indicated

Specified by:

performNormalPurgeIfNeeded in class BoundedCache

(Unpublished)

performUrgentPurgeIfNeeded

public void performUrgentPurgeIfNeeded()

Purge Cache if a request for "urgent" purge is indicated

Specified by:

performUrgentPurgeIfNeeded in class BoundedCache

(Unpublished)

markEntryAsUntrusted

public void markEntryAsUntrusted(Object itemKey)
                          throws IfsException

Mark an entry as untrusted due to security changes for the specified object.

Specified by:

markEntryAsUntrusted in class LibraryObjectCache

Parameters:

itemKey - the ID of the entry

Throws:

IfsException - if the operation fails

(Unpublished)

markEntriesAsUntrusted

public void markEntriesAsUntrusted()
                            throws IfsException

Mark all PublicObject entries as untrusted.

Called whenever a session leaves admin mode, when a user is impersonated, or when an impersonation is cancelled.

Specified by:

markEntriesAsUntrusted in class LibraryObjectCache

Throws:

IfsException - if the operation fails

(Unpublished)

markFreeInitiated

public void markFreeInitiated(Long id)
                       throws IfsException

Respond to an uncommitted free operation.

This occurs during a transaction. If the transaction is committed, a subsequent remove will be issued for the object. If instead the transaction is aborted, a subsequent markFreeCancelled will be issued for the object.

Specified by:

markFreeInitiated in class LibraryObjectCache

Parameters:

id - the item id

Throws:

IfsException - if the operation fails

(Unpublished)

markFreeCancelled

public void markFreeCancelled(Long id)
                       throws IfsException

Respond to a FREE event that has been rolled back for the specified object.

Specified by:

markFreeCancelled in class LibraryObjectCache

Parameters:

id - the item id

Throws:

IfsException - if the operation fails

(Unpublished)

getCachePerformance

public final CachePerformance getCachePerformance()

Gets the performance information for this cache. Returns null if the cache has been disposed.

Specified by:

getCachePerformance in class Cache

Returns:

a cache performance object

(Unpublished)

resetCachePerformance

public final void resetCachePerformance()

Resets the performance information for this cache.

Specified by:

resetCachePerformance in class Cache

(Unpublished)

dispose

public void dispose()

Disposes this cache.

After the cache is disposed, it is invalid to use this cache.

Overrides:

dispose in class Cache

(Unpublished)