01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.sql;
23:
24: import java.util.EventListener;
25:
26: /**
27: * <p>A ConnectionEventListener is an object that registers to receive events generated by a PooledConnection.</p>
28: *
29: * <p>The ConnectionEventListener interface is implemented by a connection pooling component. A connection pooling component
30: * will usually be provided by a JDBC driver vendor, or another system software vendor. A ConnectionEventListener is
31: * notified by a JDBC driver when an application is finished using its Connection object. This event occurs after the
32: * application calls close on its representation of the PooledConnection. A ConnectionEventListener is also notified when
33: * a Connection error occurs due to the fact that the PooledConnection is unfit for future use---the server has crashed, for example.
34: * The listener is notified, by the JDBC driver, just before the driver throws an SQLException to the application using the
35: * PooledConnection.</p>
36: */
37: public interface ConnectionEventListener extends EventListener {
38:
39: /**
40: * Invoked when the application calls close() on its representation of the connection.
41: *
42: * @param connectionEvent - an event object describing the source of the event
43: */
44: public void connectionClosed(ConnectionEvent connectionEvent);
45:
46: /**
47: * Invoked when a fatal connection error occurs, just before an SQLException is thrown to the application.
48: *
49: * @param connectionEvent - an event object describing the source of the event
50: */
51: public void connectionErrorOccurred(ConnectionEvent connectionEvent);
52: }
|