Package javax.xml.xquery
Interface PooledXQConnection
-
public interface PooledXQConnectionAn object that provides hooks for connection pool management. APooledXQConnectionobject 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 thePooledXQConnectioninterface directly; rather, it is used by a middle tier infrastructure that manages the pooling of connections. When an application calls the methodXQDataSource.getConnection, it gets back anXQConnectionobject. If connection pooling is being done, thatXQConnectionobject is actually a handle to aPooledXQConnectionobject, which is a physical connection. The connection pool manager, typically the application server, maintains a pool ofPooledXQConnectionobjects. If there is aPooledXQConnectionobject available in the pool, the connection pool manager returns anXQConnectionobject that is a handle to that physical connection. If noPooledXQConnectionobject is available, the connection pool manager calls theConnectionPoolXQDataSourcemethodgetPooledConnectionto create a new physical connection and returns a handle to it. When an application closes a connection, it calls theXQConnectionmethodclose. When connection pooling is being done, the connection pool manager is notified because it has registered itself as anXQConnectionEventListenerobject using thePooledXQConnectionmethodaddConnectionEventListener. The connection pool manager deactivates the handle to thePooledXQConnectionobject and returns thePooledXQConnectionobject 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 thePooledXQConnectionmethodclose. This method is generally called to have an orderly shutdown of the server or if a fatal error has made the physical connection unusable.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddConnectionEventListener(XQConnectionEventListener listener)Registers the given event listener so that it will be notified when an event occurs on thisPooledXQConnectionobject.voidclose()Closes the physical connection that thisPooledXQConnectionobject represents.XQConnectiongetConnection()Creates and returns anXQConnectionobject that is a handle for the physical connection that thisPooledXQConnectionobject represents.voidremoveConnectionEventListener(XQConnectionEventListener listener)Removes the given event listener from the list of components that will be notified when an event occurs on thisPooledXQConnectionobject.
-
-
-
Method Detail
-
getConnection
XQConnection getConnection() throws XQException
Creates and returns anXQConnectionobject that is a handle for the physical connection that thisPooledXQConnectionobject represents. The connection pool manager calls this method when an application has called theXQDataSourcemethodgetConnectionand there are noPooledXQConnectionobjects available.- Returns:
- an
XQConnectionobject that is a handle to thisPooledXQConnectionobject - Throws:
XQException- if a datasource access error occurs
-
close
void close() throws XQExceptionCloses the physical connection that thisPooledXQConnectionobject represents. An application never calls this method directly; it is called by the connection pool manager.- Throws:
XQException- if a datasource access error occurs
-
addConnectionEventListener
void addConnectionEventListener(XQConnectionEventListener listener)
Registers the given event listener so that it will be notified when an event occurs on thisPooledXQConnectionobject.- Parameters:
listener- a component, usually the connection pool manager, that has implemented theXQConnectionEventListenerinterface and wants to be notified when the connection is closed or has an error- See Also:
removeConnectionEventListener(javax.xml.xquery.XQConnectionEventListener)
-
removeConnectionEventListener
void removeConnectionEventListener(XQConnectionEventListener listener)
Removes the given event listener from the list of components that will be notified when an event occurs on thisPooledXQConnectionobject.- Parameters:
listener- a component, usually the connection pool manager, that has implemented theXQConnectionEventListenerinterface and been registered with thisPooledXQConnectionobject as a listener- See Also:
addConnectionEventListener(javax.xml.xquery.XQConnectionEventListener)
-
-