|
Oracle Application Server Java Object Cache API Reference 10g Release 2 (10.1.2) B14018-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.ias.cache.PoolAccess
PoolAccess provides the cache pooling API. A pool is a special collection of objects managed by the cache. It is a set of identical object instances. Objects within a pool are instanciated by the cache system using a user defined factory object. Attributes such as "time to live", "idle time" or CacheEventListener may be associated with a pool. The time out attributes are applied to the objects within the pool. The listener is associated with the pool as a whole. See the Attributes class for more detail on how attributes are applied to a pool. A minimum and maximum size of the pool can be specified when the pool is created.
Attributes
Method Summary | |
void |
close() releases the PoolAccess object. |
java.lang.Object |
get() gets an object from the pool. |
static PoolAccess |
getPool(java.lang.String name) returns a PoolAccess object associated with the pool name in the default region. |
static PoolAccess |
getPool(java.lang.String region, java.lang.String name) a static method that returns a PoolAccess object to access the pool in a region. |
void |
release() releases an object and returns the object to the pool. |
void |
returnToPool() returns the object to the pool. |
java.lang.String |
toString() dumps the contents of the pool for debugging. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public static PoolAccess getPool(java.lang.String name) throws NotAPoolException, oracle.ias.cache.ObjectNotFoundException, CacheException
name
- the name of the poolNotAPoolException
- If name doesn't refer to a pool in the specified regionoracle.ias.cache.ObjectNotFoundException
- If name is not in the cacheCacheException
- if any other error occursCacheAccess.createPool
public static PoolAccess getPool(java.lang.String region, java.lang.String name) throws NotAPoolException, oracle.ias.cache.ObjectNotFoundException, CacheException
region
- the region of the poolname
- the name of the poolNotAPoolException
- If name doesn't refer to a pool in the specified regionoracle.ias.cache.ObjectNotFoundException
- If name is not in the cacheCacheException
- if any other error occursCacheAccess.createPool
public void close() throws CacheException
CacheException
- if any error occurs.public java.lang.Object get() throws NoObjectAvailableException, CacheException
NoObjectAvailableException
- if no more object is availableCacheException
- if any other error occurspublic void returnToPool()
public void release()
public java.lang.String toString()
|
Oracle Application Server Java Object Cache API Reference 10g Release 2 (10.1.2) B14018-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |