jakarta.resource.spi.ValidatingManagedConnectionFactory Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.resource.spi;
import java.util.Set;
import jakarta.resource.ResourceException;
/**
* This interface is implemented by a ManagedConnectionFactory
* instance that supports the ability to validate
* ManagedConnection objects.
*
* This may be used by the application server to prune invalid
* ManagedConnection objects from its connection pool.
*
*
The application server may use this functionality to test the
* validity of a ManagedConnection by passing in a
* Set of size one( with the ManagedConnection
* that has to be tested for validity as the only member of the
* Set.
*
*
* @author Ram Jeyaraman
* @version 1.0
*/
public interface ValidatingManagedConnectionFactory {
/**
* This method returns a set of invalid ManagedConnection
* objects chosen from a specified set of ManagedConnection
* objects.
*
* @param connectionSet a set of ManagedConnection objects
* that need to be validated.
*
* @return a set of invalid ManagedConnection objects.
*
* @throws ResourceException generic exception.
*/
Set getInvalidConnections(Set connectionSet) throws ResourceException;
}