javax.sql.ConnectionEvent Maven / Gradle / Ivy
/*
* Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javax.sql;
import java.sql.SQLException;
/**
* An {@code Event} object that provides information about the
* source of a connection-related event. {@code ConnectionEvent}
* objects are generated when an application closes a pooled connection
* and when an error occurs. The {@code ConnectionEvent} object
* contains two kinds of information:
*
* - The pooled connection closed by the application
*
- In the case of an error event, the {@code SQLException}
* about to be thrown to the application
*
*
* @since 1.4
*/
public class ConnectionEvent extends java.util.EventObject {
/**
* Constructs a {@code ConnectionEvent} object initialized with
* the given {@code PooledConnection} object. {@code SQLException}
* defaults to {@code null}.
*
* @param con the pooled connection that is the source of the event
* @throws IllegalArgumentException if {@code con} is null.
*/
public ConnectionEvent(PooledConnection con) {
super(con);
}
/**
*
Constructs a {@code ConnectionEvent} object initialized with
* the given {@code PooledConnection} object and
* {@code SQLException} object.
*
* @param con the pooled connection that is the source of the event
* @param ex the SQLException about to be thrown to the application
* @throws IllegalArgumentException if {@code con} is null.
*/
public ConnectionEvent(PooledConnection con, SQLException ex) {
super(con);
this.ex = ex;
}
/**
*
Retrieves the {@code SQLException} for this
* {@code ConnectionEvent} object. May be {@code null}.
*
* @return the SQLException about to be thrown or {@code null}
*/
public SQLException getSQLException() { return ex; }
/**
* The {@code SQLException} that the driver will throw to the
* application when an error occurs and the pooled connection is no
* longer usable.
* @serial
*/
private SQLException ex = null;
/**
* Private serial version unique ID to ensure serialization
* compatibility.
*/
static final long serialVersionUID = -4843217645290030002L;
}