/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 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://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/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 packager/legal/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 javax.resource.ResourceException;
import java.util.EventObject;
/** The ConnectionEvent class provides information about the source of
* a connection related event.A ConnectionEvent instance contains the
* following information:
* <UL>
* <LI>Type of the connection event
* <LI>ManagedConnection instance that generated the connection event.
* A ManagedConnection instance is returned from the method
* ConnectionEvent.getSource.
* <LI>Connection handle associated with the ManagedConnection instance;
* required for the CONNECTION_CLOSED event and optional for the
* other event types.
* <LI>Optionally, an exception indicating the connection related error.
* Note that exception is used for CONNECTION_ERROR_OCCURRED.
* </UL>
*
* <p>This class defines following types of event notifications:
* <UL>
* <LI>CONNECTION_CLOSED
* <LI>LOCAL_TRANSACTION_STARTED
* <LI>LOCAL_TRANSACTION_COMMITTED
* <LI>LOCAL_TRANSACTION_ROLLEDBACK
* <LI>CONNECTION_ERROR_OCCURRED
* </UL>
*
* @version 0.5
* @author Rahul Sharma
* @see javax.resource.spi.ConnectionEventListener
*/
public class ConnectionEvent extends java.util.EventObject {
/** Event notification that an application component has closed the
* connection
**/
public static final int CONNECTION_CLOSED = 1;
/** Event notification that a Resource Manager Local Transaction was
* started on the connection
**/
public static final int LOCAL_TRANSACTION_STARTED = 2;
/** Event notification that a Resource Manager Local Transaction was
* committed on the connection
**/
public static final int LOCAL_TRANSACTION_COMMITTED = 3;
/** Event notification that a Resource Manager Local Transaction was
* rolled back on the connection
**/
public static final int LOCAL_TRANSACTION_ROLLEDBACK = 4;
/** Event notification that an error occurred on the connection.
* This event indicates that the ManagedConnection instance is
* now invalid and unusable.
**/
public static final int CONNECTION_ERROR_OCCURRED = 5;
/** Exception associated with the <code>ConnectionEvent</code>
* instance.
*
* @serial
**/
private Exception exception;
/** Type of the event
**/
protected int id;
private Object connectionHandle;
/**
* Construct a ConnectionEvent object. Exception defaults to null.
*
* @param source ManagedConnection that is the
* source of the event
* @param eid type of the Connection event
*/
public ConnectionEvent(ManagedConnection source, int eid) {
super(source);
this.id = eid;
}
/**
* Construct a ConnectionEvent object.
*
* @param source ManagedConnection that is the
* source of the event
* @param exception exception about to be thrown to the application
* @param eid type of the Connection event
*/
public ConnectionEvent(ManagedConnection source, int eid,
Exception exception) {
super(source);
this.exception = exception;
this.id = eid;
}
/**Get the connection handle associated with the Managed
* Connection instance. Used for CONNECTION_CLOSED event.
*
* @return the connection handle. May be null
*/
public Object getConnectionHandle() {
return connectionHandle;
}
/**
* Set the connection handle. Used for CONNECTION_CLOSED event
*/
public void setConnectionHandle(Object connectionHandle) {
this.connectionHandle = connectionHandle;
}
/**
* Get the exception. May be null.
*
* @return the exception about to be thrown.
*/
public Exception getException() {
return exception;
}
/**
* Get the type of event
*/
public
int getId() {
return id;
}
}