org.objectweb.jonas.resource.pool.api.PoolMatchFactory Interface Reference

List of all members.

Public Member Functions
Object	createResource (Object hints) throws Exception
Package Functions
boolean	matchResource (Object pr, Object hints)
Object	matchResource (Set res, Object hints) throws Exception
void	releaseResource (Object pr) throws Exception
void	validateResource (Set res) throws Exception

---

Detailed Description

The interface PoolMatchFactory defines the object used by a Pool to test if a given resource of a Pool matches with the hints passed with the Pool getResource method. It also allows such a Pool to allocate a Object as needed, conforming to the passed hints.

Definition at line 51 of file PoolMatchFactory.java.

---

Member Function Documentation

Object org.objectweb.jonas.resource.pool.api.PoolMatchFactory.createResource (  Object  hints  )  throws Exception

createResource creates a new Object. Parameters: hints  The "properties" that the created Object should conform to. Returns: The created Object. Exceptions: Exception  if an error occurs

Object org.objectweb.jonas.resource.pool.api.PoolMatchFactory.matchResource (  Set  res, Object  hints )  throws Exception [package]

matchResource tests if a given resource of a Pool matches with the hints passed with the Pool getResource method. Parameters: res  A set of Objects to test if matching with some "properties" specified by hints. hints  The "properties" that the Object specified by pr should match. Returns: Object that matches the hints "properties". or null if no match. Exceptions: Exception  Description of Exception

boolean org.objectweb.jonas.resource.pool.api.PoolMatchFactory.matchResource (  Object  pr, Object  hints )  [package]

matchResource tests if a given resource of a Pool matches with the hints passed with the Pool getResource method. Parameters: pr  The Object to test its matching with some "properties" specified by hints. hints  The "properties" that the Object specified by pr should match. Returns: true if the pr Object matches the hints "properties".

void org.objectweb.jonas.resource.pool.api.PoolMatchFactory.releaseResource (  Object  pr  )  throws Exception [package]

releaseResource make sure that any cleanup needed for this entry is done Parameters: pr  The Object to release Exceptions: Exception  Description of Exception

void org.objectweb.jonas.resource.pool.api.PoolMatchFactory.validateResource (  Set  res  )  throws Exception [package]

validateResource tests if a given resource of a Pool is invalid Parameters: res  A set of Objects to test if matching with some "properties" specified by hints. Exceptions: Exception  Description of Exception

---

The documentation for this interface was generated from the following file:

• src/org/objectweb/jonas/resource/pool/api/PoolMatchFactory.java

---