Java Doc for PooledConnection.java in  » 6.0-JDK-Core » sql » javax » sql » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » sql » javax.sql 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.sql.PooledConnection

PooledConnection
public interface PooledConnection (Code)
An object that provides hooks for connection pool management. A PooledConnection object represents a physical connection to a data source. The connection can be recycled rather than being closed when an application is finished with it, thus reducing the number of connections that need to be made.

An application programmer does not use the PooledConnection interface directly; rather, it is used by a middle tier infrastructure that manages the pooling of connections.

When an application calls the method DataSource.getConnection, it gets back a Connection object. If connection pooling is being done, that Connection object is actually a handle to a PooledConnection object, which is a physical connection.

The connection pool manager, typically the application server, maintains a pool of PooledConnection objects. If there is a PooledConnection object available in the pool, the connection pool manager returns a Connection object that is a handle to that physical connection. If no PooledConnection object is available, the connection pool manager calls the ConnectionPoolDataSource method getPoolConnection to create a new physical connection. The JDBC driver implementing ConnectionPoolDataSource creates a new PooledConnection object and returns a handle to it.

When an application closes a connection, it calls the Connection method close. When connection pooling is being done, the connection pool manager is notified because it has registered itself as a ConnectionEventListener object using the ConnectionPool method addConnectionEventListener. The connection pool manager deactivates the handle to the PooledConnection object and returns the PooledConnection object to the pool of connections so that it can be used again. Thus, when an application closes its connection, the underlying physical connection is recycled rather than being closed.

The physical connection is not closed until the connection pool manager calls the PooledConnection method close. This method is generally called to have an orderly shutdown of the server or if a fatal error has made the connection unusable.

A connection pool manager is often also a statement pool manager, maintining a pool of PreparedStatement objects. When an application closes a prepared statement, it calls the PreparedStatement method close. When Statement pooling is being done, the pool manager is notified because it has registered itself as a StatementEventListener object using the ConnectionPool method addStatementEventListener. Thus, when an application closes its PreparedStatement, the underlying prepared statement is recycled rather than being closed.


since:
   1.4





Method Summary
 voidaddConnectionEventListener(ConnectionEventListener listener)
     Registers the given event listener so that it will be notified when an event occurs on this PooledConnection object.
public  voidaddStatementEventListener(StatementEventListener listener)
     Registers a StatementEventListener with this PooledConnection object.
 voidclose()
     Closes the physical connection that this PooledConnection object represents.
 ConnectiongetConnection()
     Creates and returns a Connection object that is a handle for the physical connection that this PooledConnection object represents. The connection pool manager calls this method when an application has called the method DataSource.getConnection and there are no PooledConnection objects available.
 voidremoveConnectionEventListener(ConnectionEventListener listener)
     Removes the given event listener from the list of components that will be notified when an event occurs on this PooledConnection object.
public  voidremoveStatementEventListener(StatementEventListener listener)
     Removes the specified StatementEventListener from the list of components that will be notified when the driver detects that a PreparedStatement has been closed or is invalid.



Method Detail
addConnectionEventListener
void addConnectionEventListener(ConnectionEventListener listener)(Code)
Registers the given event listener so that it will be notified when an event occurs on this PooledConnection object.
Parameters:
  listener - a component, usually the connection pool manager,that has implemented theConnectionEventListener interface and wants to benotified when the connection is closed or has an error
See Also:   PooledConnection.removeConnectionEventListener



addStatementEventListener
public void addStatementEventListener(StatementEventListener listener)(Code)
Registers a StatementEventListener with this PooledConnection object. Components that wish to be notified when PreparedStatements created by the connection are closed or are detected to be invalid may use this method to register a StatementEventListener with this PooledConnection object.


Parameters:
  listener - an component which implements the StatementEventListener interface that is to be registered with this PooledConnection object


since:
   1.6




close
void close() throws SQLException(Code)
Closes the physical connection that this PooledConnection object represents. An application never calls this method directly; it is called by the connection pool module, or manager.

See the PooledConnection interface description for more information.
exception:
  SQLException - if a database access error occurs
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.4




getConnection
Connection getConnection() throws SQLException(Code)
Creates and returns a Connection object that is a handle for the physical connection that this PooledConnection object represents. The connection pool manager calls this method when an application has called the method DataSource.getConnection and there are no PooledConnection objects available. See the PooledConnection interface description for more information. a Connection object that is a handle tothis PooledConnection object
exception:
  SQLException - if a database access error occurs
exception:
  SQLFeatureNotSupportedException - if the JDBC driver does not supportthis method
since:
   1.4



removeConnectionEventListener
void removeConnectionEventListener(ConnectionEventListener listener)(Code)
Removes the given event listener from the list of components that will be notified when an event occurs on this PooledConnection object.
Parameters:
  listener - a component, usually the connection pool manager,that has implemented theConnectionEventListener interface and been registered with this PooledConnection object as a listener
See Also:   PooledConnection.addConnectionEventListener



removeStatementEventListener
public void removeStatementEventListener(StatementEventListener listener)(Code)
Removes the specified StatementEventListener from the list of components that will be notified when the driver detects that a PreparedStatement has been closed or is invalid.


Parameters:
  listener - the component which implements theStatementEventListener interface that was previously registered with this PooledConnection object


since:
   1.6




www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.