PoolMatchFactory


1   /*
2    * JOnAS: Java(TM) Open Application Server
3    * Copyright (C) 1999 Bull S.A.
4    * Contact: jonas-team@objectweb.org
5    *
6    * ObjectWeb Connector: an implementation of JCA Sun specification along
7    *                      with some extensions of this specification.
8    * Copyright (C) 2001-2002 France Telecom R&D - INRIA
9    *
10   * This library is free software; you can redistribute it and/or
11   * modify it under the terms of the GNU Lesser General Public
12   * License as published by the Free Software Foundation; either
13   * version 2 of the License, or (at your option) any later version.
14   *
15   * This library is distributed in the hope that it will be useful,
16   * but WITHOUT ANY WARRANTY; without even the implied warranty of
17   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18   * Lesser General Public License for more details.
19   *
20   * You should have received a copy of the GNU Lesser General Public
21   * License along with this library; if not, write to the Free Software
22   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23   *
24   * Based on PoolMatchFactory in ObjectWeb common
25   *
26   * --------------------------------------------------------------------------
27   * $Id: PoolMatchFactory.java,v 1.5 2004/10/29 23:33:37 ehardesty Exp $
28   * --------------------------------------------------------------------------
29   *
30   */
31  
32  /**
33   * Package definition.
34   *
35   * Author: E. Hardesty
36   */
37  package org.objectweb.jonas.resource.pool.api;
38  
39  /**
40   * Import clauses: one for each external Java definition used. Do not use
41   * clauses in the form "import package.*".
42   */
43  import java.util.Set  ;
44  
45  /**
46   * The interface <b>PoolMatchFactory</b> defines the object used by a Pool to
47   * test if a given resource of a Pool matches with the hints passed with the
48   * Pool getResource method. It also allows such a Pool to allocate a
49   * Object as needed, conforming to the passed hints.
50   */
51  public interface PoolMatchFactory {
52          /**
53           * <b>createResource</b> creates a new Object.
54           * @param hints        The "properties" that the created Object should
55           *                                conform to.
56           * @return                The created Object.
57           * @throws Exception if an error occurs
58           */
59          Object   createResource(Object   hints) throws Exception  ;
60  
61      /**
62       * <b>matchResource</b> tests if a given resource of a Pool matches with
63           * the hints passed with the Pool getResource method.
64           * @param pr        The Object to test its matching with some
65           *                                "properties" specified by hints.
66           * @param hints        The "properties" that the Object specified by pr
67           *                                should match.
68           * @return                <b>true</b> if the pr Object matches the hints
69           *                                "properties".
70           */
71          boolean matchResource(Object   pr, Object   hints);
72  
73      /**
74       * <b>matchResource</b> tests if a given resource of a Pool matches with
75           * the hints passed with the Pool getResource method.
76           * @param res          A set of Objects to test if matching with some
77           *                                "properties" specified by hints.
78           * @param hints        The "properties" that the Object specified by pr
79           *                                should match.
80           * @return                <b>Object</b> that matches the hints "properties".
81           *                              or null if no match.
82           * @exception  Exception  Description of Exception
83           */
84          Object   matchResource(Set   res, Object   hints) throws Exception  ;
85      /**
86       * <b>releaseResource</b> make sure that any cleanup needed for this entry is done
87           * @param pr          The Object to release
88           * @exception  Exception  Description of Exception
89           */
90          void releaseResource(Object   pr) throws Exception  ;
91      /**
92       * <b>validateResource</b> tests if a given resource of a Pool is invalid
93           * @param res          A set of Objects to test if matching with some
94           *                                "properties" specified by hints.
95           * @exception  Exception  Description of Exception
96           */
97          void validateResource(Set   res) throws Exception  ;
98  }
99  
100 
101
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags