javax.resource.spi.ConnectionEventListener.java Source code

Introduction

Here is the source code for javax.resource.spi.ConnectionEventListener.java

Source

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2018 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.resource.spi;

import java.util.EventListener;
import javax.resource.ResourceException;

/**  The <code>ConnectionEventListener</code> interface provides an event
 *   callback mechanism to enable an application server to receive 
 *   notifications from a <code>ManagedConnection</code> instance. 
 *
 *   <p>An application server uses these event notifications to manage 
 *   its connection pool, to clean up any invalid or terminated connections
 *   and to manage local transactions.
 *
 *   <p>An application server implements the 
 *   <code>ConnectionEventListener</code> interface. It registers a connection 
 *   listener with a <code>ManagedConnection</code> instance by using 
 *   <code>ManagedConnection.addConnectionEventListener</code> method.
 *  
 *   @version     0.5
 *   @author      Rahul Sharma
 *
 *   @see         javax.resource.spi.ConnectionEvent
 **/

public interface ConnectionEventListener extends java.util.EventListener {

    /** Notifies that an application component has closed the connection.
     *
     *  <p>A ManagedConnection instance notifies its registered set of 
     *  listeners by calling ConnectionEventListener.connectionClosed method
     *  when an application component closes a connection handle. The 
     *  application server uses this connection close event to put the
     *  ManagedConnection instance back in to the connection pool.
     *
     *  @param    event     event object describing the source of 
     *                      the event
     */
    public void connectionClosed(ConnectionEvent event);

    /** Notifies that a Resource Manager Local Transaction was started on
     *  the ManagedConnection instance.
     *
     *  @param    event     event object describing the source of 
     *                      the event
     */
    public void localTransactionStarted(ConnectionEvent event);

    /** Notifies that a Resource Manager Local Transaction was committed 
     *  on the ManagedConnection instance.
     *
     *  @param    event     event object describing the source of 
     *                      the event
     */
    public void localTransactionCommitted(ConnectionEvent event);

    /** Notifies that a Resource Manager Local Transaction was rolled back 
     *  on the ManagedConnection instance.
     *
     *  @param    event     event object describing the source of 
     *                      the event
     */
    public void localTransactionRolledback(ConnectionEvent event);

    /** Notifies a connection related error. 
        
     *  The ManagedConnection instance calls the method
     *  ConnectionEventListener.connectionErrorOccurred to notify 
     *  its registered listeners of the occurrence of a physical 
     *  connection-related error. The event notification happens 
     *  just before a resource adapter throws an exception to the 
     *  application component using the connection handle.
     *
     *  The connectionErrorOccurred method indicates that the 
     *  associated ManagedConnection instance is now invalid and 
     *  unusable. The application server handles the connection 
     *  error event notification by initiating application 
     *  server-specific cleanup (for example, removing ManagedConnection 
     *  instance from the connection pool) and then calling
     *  ManagedConnection.destroy method to destroy the physical 
     *  connection.
     *
     * @param     event     event object describing the source of 
     *                      the event
     */
    public void connectionErrorOccurred(ConnectionEvent event);

}