KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > resource > spi > ValidatingManagedConnectionFactory


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */

23
24 package javax.resource.spi;
25
26 import java.util.Set JavaDoc;
27 import javax.resource.ResourceException JavaDoc;
28
29 /**
30  * This interface is implemented by a <code>ManagedConnectionFactory</code>
31  * instance that supports the ability to validate
32  * <code>ManagedConnection</code> objects.
33  *
34  * <p>This may be used by the application server to prune invalid
35  * <code>ManagedConnection</code> objects from its connection pool.
36  *
37  * @author Ram Jeyaraman
38  * @version 1.0
39  */

40 public interface ValidatingManagedConnectionFactory {
41
42     /**
43      * This method returns a set of invalid <code>ManagedConnection</code>
44      * objects chosen from a specified set of <code>ManagedConnection</code>
45      * objects.
46      *
47      * @param connectionSet a set of <code>ManagedConnection</code> objects
48      * that need to be validated.
49      *
50      * @return a set of invalid <code>ManagedConnection</code> objects.
51      *
52      * @throws ResourceException generic exception.
53      */

54     Set JavaDoc getInvalidConnections(Set JavaDoc connectionSet) throws ResourceException JavaDoc;
55 }
56
Popular Tags