javax.resource.spi.ValidatingManagedConnectionFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of connector-api

There is a newer version: 1.6-alpha-1

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

package javax.resource.spi;

import java.util.Set;
import javax.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.
 *
 *  @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;
}