| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ConnectionManager</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ConnectionManager"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/resource/spi/ConnectionEventListener.html" title="interface in jakarta.resource.spi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/resource/spi/ConnectionRequestInfo.html" title="interface in jakarta.resource.spi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/resource/spi/ConnectionManager.html" target="_top">Frames</a></li> |
| <li><a href="ConnectionManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.resource.spi</div> |
| <h2 title="Interface ConnectionManager" class="title">Interface ConnectionManager</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ConnectionManager</span> |
| extends java.io.Serializable</pre> |
| <div class="block"><p>ConnectionManager interface provides a hook for the resource adapter to |
| pass a connection request to the application server. |
| |
| <p>An application server provides implementation of the ConnectionManager |
| interface. This implementation is not specific to any particular type of |
| the resource adapter or connection factory interface. |
| |
| <p>The ConnectionManager implementation delegates to the application |
| server to enable latter to provide quality of services (QoS) - security, |
| connection pool management, transaction management and error |
| logging/tracing. |
| |
| <p>An application server implements these services in a generic manner, |
| independent of any resource adapter and EIS specific mechanisms. The |
| connector architecture does not specify how an application server |
| implements these services; the implementation is specific to an |
| application server. |
| |
| <p>After an application server hooks-in its services, the connection |
| request gets delegated to a ManagedConnectionFactory instance either |
| for the creation of a new physical connection or for the matching of |
| an already existing physical connection. |
| |
| <p>An implementation class for ConnectionManager interface is |
| required to implement the <code>java.io.Serializable</code> interface. |
| |
| <p>In the non-managed application scenario, the ConnectionManager |
| implementation class can be provided either by a resource adapter (as |
| a default ConnectionManager implementation) or by application |
| developers. In both cases, QOS can be provided as components by third |
| party vendors.</p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.6</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/resource/spi/ManagedConnectionFactory.html" title="interface in jakarta.resource.spi"><code>ManagedConnectionFactory</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/ConnectionManager.html#allocateConnection-jakarta.resource.spi.ManagedConnectionFactory-jakarta.resource.spi.ConnectionRequestInfo-">allocateConnection</a></span>(<a href="../../../jakarta/resource/spi/ManagedConnectionFactory.html" title="interface in jakarta.resource.spi">ManagedConnectionFactory</a> mcf, |
| <a href="../../../jakarta/resource/spi/ConnectionRequestInfo.html" title="interface in jakarta.resource.spi">ConnectionRequestInfo</a> cxRequestInfo)</code> |
| <div class="block">The method allocateConnection gets called by the resource adapter's |
| connection factory instance.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="allocateConnection-jakarta.resource.spi.ManagedConnectionFactory-jakarta.resource.spi.ConnectionRequestInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>allocateConnection</h4> |
| <pre>java.lang.Object allocateConnection(<a href="../../../jakarta/resource/spi/ManagedConnectionFactory.html" title="interface in jakarta.resource.spi">ManagedConnectionFactory</a> mcf, |
| <a href="../../../jakarta/resource/spi/ConnectionRequestInfo.html" title="interface in jakarta.resource.spi">ConnectionRequestInfo</a> cxRequestInfo) |
| throws <a href="../../../jakarta/resource/ResourceException.html" title="class in jakarta.resource">ResourceException</a></pre> |
| <div class="block"><p>The method allocateConnection gets called by the resource adapter's |
| connection factory instance. This lets connection factory instance |
| (provided by the resource adapter) pass a connection request to |
| the ConnectionManager instance.</p> |
| |
| <p>The connectionRequestInfo parameter represents information specific |
| to the resource adapter for handling of the connection request.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mcf</code> - used by application server to delegate |
| connection matching/creation</dd> |
| <dd><code>cxRequestInfo</code> - connection request Information</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>connection handle with an EIS specific connection interface.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../jakarta/resource/ResourceException.html" title="class in jakarta.resource">ResourceException</a></code> - Generic exception</dd> |
| <dd><code><a href="../../../jakarta/resource/spi/ApplicationServerInternalException.html" title="class in jakarta.resource.spi">ApplicationServerInternalException</a></code> - Application server specific exception</dd> |
| <dd><code><a href="../../../jakarta/resource/spi/SecurityException.html" title="class in jakarta.resource.spi">SecurityException</a></code> - Security related error</dd> |
| <dd><code><a href="../../../jakarta/resource/spi/ResourceAllocationException.html" title="class in jakarta.resource.spi">ResourceAllocationException</a></code> - Failed to allocate system resources for |
| connection request</dd> |
| <dd><code><a href="../../../jakarta/resource/spi/ResourceAdapterInternalException.html" title="class in jakarta.resource.spi">ResourceAdapterInternalException</a></code> - Resource adapter related error condition</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../jakarta/resource/spi/ConnectionEventListener.html" title="interface in jakarta.resource.spi"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/resource/spi/ConnectionRequestInfo.html" title="interface in jakarta.resource.spi"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/resource/spi/ConnectionManager.html" target="_top">Frames</a></li> |
| <li><a href="ConnectionManager.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
