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.sql.Connection;
25: import java.sql.SQLException;
26:
27: /**
28: * A PooledConnection object is a connection object that provides hooks for connection pool management.
29: * A PooledConnection object represents a physical connection to a data source.
30: */
31: public interface PooledConnection {
32:
33: /**
34: * Add an event listener.
35: *
36: * @param connectionEventListener - The listener
37: */
38: public void addConnectionEventListener(
39: ConnectionEventListener connectionEventListener);
40:
41: /**
42: * Close the physical connection.
43: *
44: * @exception SQLException - if a database-access error occurs.
45: */
46: public void close() throws SQLException;
47:
48: /**
49: * Create an object handle for this physical connection. The object returned is a temporary handle used by
50: * application code to refer to a physical connection that is being pooled.
51: *
52: * @return a Connection object
53: * @exception SQLException - if a database-access error occurs.
54: */
55: public Connection getConnection() throws SQLException;
56:
57: /**
58: * Remove an event listener.
59: *
60: * @param connectionEventListener - The listener
61: */
62: public void removeConnectionEventListener(
63: ConnectionEventListener connectionEventListener);
64: }
|