1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 package javax.resource.spi;
38
39 import java.util.Set;
40 import javax.resource.ResourceException;
41
42 /**
43 * This interface is implemented by a <code>ManagedConnectionFactory</code>
44 * instance that supports the ability to validate
45 * <code>ManagedConnection</code> objects.
46 *
47 * <p>This may be used by the application server to prune invalid
48 * <code>ManagedConnection</code> objects from its connection pool.
49 *
50 * @author Ram Jeyaraman
51 * @version 1.0
52 */
53 public interface ValidatingManagedConnectionFactory {
54
55 /**
56 * This method returns a set of invalid <code>ManagedConnection</code>
57 * objects chosen from a specified set of <code>ManagedConnection</code>
58 * objects.
59 *
60 * @param connectionSet a set of <code>ManagedConnection</code> objects
61 * that need to be validated.
62 *
63 * @return a set of invalid <code>ManagedConnection</code> objects.
64 *
65 * @throws ResourceException generic exception.
66 */
67 Set getInvalidConnections(Set connectionSet) throws ResourceException;
68 }
Save This Page