| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:38:49 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ExternalConnectionPool (EclipseLink 3.0.2, API Reference)</title> |
| <meta name="date" content="2021-07-16"> |
| <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="ExternalConnectionPool (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/sessions/server/ReadConnectionPool.html" title="class in org.eclipse.persistence.sessions.server"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/sessions/server/ExternalConnectionPool.html" target="_top">Frames</a></li> |
| <li><a href="ExternalConnectionPool.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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">org.eclipse.persistence.sessions.server</div> |
| <h2 title="Class ExternalConnectionPool" class="title">Class ExternalConnectionPool</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">org.eclipse.persistence.sessions.server.ConnectionPool</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.persistence.sessions.server.ExternalConnectionPool</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">ExternalConnectionPool</span> |
| extends <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">ConnectionPool</a></pre> |
| <div class="block"><p> |
| <b>Purpose</b>: This subclass is intended to be used with external connection pools. |
| For these pools, TopLink does not control the pooling behavior. |
| The login should have the usesExternalConnectionPooling set to "true".</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.databaseaccess.Accessor</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html#cachedConnection">cachedConnection</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.sessions.server.ConnectionPool"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.persistence.sessions.server.<a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">ConnectionPool</a></h3> |
| <code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#checkConnections">checkConnections</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#connectionsAvailable">connectionsAvailable</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#connectionsUsed">connectionsUsed</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#DEAD_CHECK_TIME">DEAD_CHECK_TIME</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#deadCheckTime">deadCheckTime</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#failoverConnectionPools">failoverConnectionPools</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#INITIAL_CONNECTIONS">INITIAL_CONNECTIONS</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#initialNumberOfConnections">initialNumberOfConnections</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#isConnected">isConnected</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#isDead">isDead</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#login">login</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#MAX_CONNECTIONS">MAX_CONNECTIONS</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#maxNumberOfConnections">maxNumberOfConnections</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#MIN_CONNECTIONS">MIN_CONNECTIONS</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#minNumberOfConnections">minNumberOfConnections</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#MONITOR_HEADER">MONITOR_HEADER</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#name">name</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#owner">owner</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#timeOfDeath">timeOfDeath</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#WAIT_TIMEOUT">WAIT_TIMEOUT</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#waitTimeout">waitTimeout</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html#ExternalConnectionPool--">ExternalConnectionPool</a></span>()</code> |
| <div class="block">PUBLIC: |
| Build a new external connection pool.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html#ExternalConnectionPool-java.lang.String-org.eclipse.persistence.sessions.Login-org.eclipse.persistence.sessions.server.ServerSession-">ExternalConnectionPool</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a> login, |
| <a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a> owner)</code> |
| <div class="block">PUBLIC: |
| Build a new external connection pool.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>org.eclipse.persistence.internal.databaseaccess.Accessor</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html#acquireConnection--">acquireConnection</a></span>()</code> |
| <div class="block">INTERNAL: |
| When we acquire a connection from an ExternalConnectionPool we build |
| a new connection (retrieve it from the external pool).</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.databaseaccess.Accessor</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html#getCachedConnection--">getCachedConnection</a></span>()</code> |
| <div class="block">INTERNAL: |
| Return the currently cached connection to the external connection pool</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html#hasConnectionAvailable--">hasConnectionAvailable</a></span>()</code> |
| <div class="block">INTERNAL: |
| Assume true as the driver is responsible for blocking.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html#isThereConflictBetweenLoginAndType--">isThereConflictBetweenLoginAndType</a></span>()</code> |
| <div class="block">INTERNAL: |
| Checks for a conflict between pool's type and pool's login</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html#releaseConnection-org.eclipse.persistence.internal.databaseaccess.Accessor-">releaseConnection</a></span>(org.eclipse.persistence.internal.databaseaccess.Accessor connection)</code> |
| <div class="block">INTERNAL: |
| When you release an external connection, you simply let it go.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html#setCachedConnection-org.eclipse.persistence.internal.databaseaccess.Accessor-">setCachedConnection</a></span>(org.eclipse.persistence.internal.databaseaccess.Accessor cachedConnection)</code> |
| <div class="block">Set the currently cached connection to the external connection pool.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html#setCheckConnections--">setCheckConnections</a></span>()</code> |
| <div class="block">INTERNAL: |
| This method is called to indicate that all available connections should be checked.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html#shutDown--">shutDown</a></span>()</code> |
| <div class="block">INTERNAL: |
| This mehtod is a no-op for external pools.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html#startUp--">startUp</a></span>()</code> |
| <div class="block">INTERNAL: |
| Build the default connection.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.sessions.server.ConnectionPool"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.persistence.sessions.server.<a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">ConnectionPool</a></h3> |
| <code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#addFailoverConnectionPool-java.lang.String-">addFailoverConnectionPool</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#buildConnection--">buildConnection</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#failover--">failover</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getConnectionsAvailable--">getConnectionsAvailable</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getConnectionsUsed--">getConnectionsUsed</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getFailoverConnectionPools--">getFailoverConnectionPools</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getInitialNumberOfConnections--">getInitialNumberOfConnections</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getLogin--">getLogin</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getMaxNumberOfConnections--">getMaxNumberOfConnections</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getMinNumberOfConnections--">getMinNumberOfConnections</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getName--">getName</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getOwner--">getOwner</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getTotalNumberOfConnections--">getTotalNumberOfConnections</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getWaitTimeout--">getWaitTimeout</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#isConnected--">isConnected</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#isDead--">isDead</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#resetConnections--">resetConnections</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setConnectionsAvailable-java.util.Vector-">setConnectionsAvailable</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setConnectionsUsed-java.util.Vector-">setConnectionsUsed</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setFailoverConnectionPools-java.util.List-">setFailoverConnectionPools</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setInitialNumberOfConnections-int-">setInitialNumberOfConnections</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setIsConnected-boolean-">setIsConnected</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setIsDead-boolean-">setIsDead</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setLogin-org.eclipse.persistence.sessions.Login-">setLogin</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setMaxNumberOfConnections-int-">setMaxNumberOfConnections</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setMinNumberOfConnections-int-">setMinNumberOfConnections</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setName-java.lang.String-">setName</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setOwner-org.eclipse.persistence.sessions.server.ServerSession-">setOwner</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setWaitTimeout-int-">setWaitTimeout</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#toString--">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="cachedConnection"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>cachedConnection</h4> |
| <pre>protected org.eclipse.persistence.internal.databaseaccess.Accessor cachedConnection</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ExternalConnectionPool--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ExternalConnectionPool</h4> |
| <pre>public ExternalConnectionPool()</pre> |
| <div class="block">PUBLIC: |
| Build a new external connection pool. The JDBC driver is responsible for pooling the connections.</div> |
| </li> |
| </ul> |
| <a name="ExternalConnectionPool-java.lang.String-org.eclipse.persistence.sessions.Login-org.eclipse.persistence.sessions.server.ServerSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ExternalConnectionPool</h4> |
| <pre>public ExternalConnectionPool(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a> login, |
| <a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a> owner)</pre> |
| <div class="block">PUBLIC: |
| Build a new external connection pool. The JDBC driver is responsible for pooling the connections.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="acquireConnection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acquireConnection</h4> |
| <pre>public org.eclipse.persistence.internal.databaseaccess.Accessor acquireConnection() |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/ConcurrencyException.html" title="class in org.eclipse.persistence.exceptions">ConcurrencyException</a></pre> |
| <div class="block">INTERNAL: |
| When we acquire a connection from an ExternalConnectionPool we build |
| a new connection (retrieve it from the external pool).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#acquireConnection--">acquireConnection</a></code> in class <code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">ConnectionPool</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/ConcurrencyException.html" title="class in org.eclipse.persistence.exceptions">ConcurrencyException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCachedConnection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCachedConnection</h4> |
| <pre>protected org.eclipse.persistence.internal.databaseaccess.Accessor getCachedConnection()</pre> |
| <div class="block">INTERNAL: |
| Return the currently cached connection to the external connection pool</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>org.eclipse.persistence.internal.databaseaccess.Accessor</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasConnectionAvailable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasConnectionAvailable</h4> |
| <pre>public boolean hasConnectionAvailable()</pre> |
| <div class="block">INTERNAL: |
| Assume true as the driver is responsible for blocking.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#hasConnectionAvailable--">hasConnectionAvailable</a></code> in class <code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">ConnectionPool</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isThereConflictBetweenLoginAndType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isThereConflictBetweenLoginAndType</h4> |
| <pre>public boolean isThereConflictBetweenLoginAndType()</pre> |
| <div class="block">INTERNAL: |
| Checks for a conflict between pool's type and pool's login</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#isThereConflictBetweenLoginAndType--">isThereConflictBetweenLoginAndType</a></code> in class <code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">ConnectionPool</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="releaseConnection-org.eclipse.persistence.internal.databaseaccess.Accessor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>releaseConnection</h4> |
| <pre>public void releaseConnection(org.eclipse.persistence.internal.databaseaccess.Accessor connection) |
| throws <a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre> |
| <div class="block">INTERNAL: |
| When you release an external connection, you simply let it go.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#releaseConnection-org.eclipse.persistence.internal.databaseaccess.Accessor-">releaseConnection</a></code> in class <code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">ConnectionPool</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCachedConnection-org.eclipse.persistence.internal.databaseaccess.Accessor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCachedConnection</h4> |
| <pre>protected void setCachedConnection(org.eclipse.persistence.internal.databaseaccess.Accessor cachedConnection)</pre> |
| <div class="block">Set the currently cached connection to the external connection pool.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cachedConnection</code> - </dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setCheckConnections--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCheckConnections</h4> |
| <pre>public void setCheckConnections()</pre> |
| <div class="block">INTERNAL: |
| This method is called to indicate that all available connections should be checked. |
| Noop on external connection pool.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setCheckConnections--">setCheckConnections</a></code> in class <code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">ConnectionPool</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shutDown--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutDown</h4> |
| <pre>public void shutDown()</pre> |
| <div class="block">INTERNAL: |
| This mehtod is a no-op for external pools.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#shutDown--">shutDown</a></code> in class <code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">ConnectionPool</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startUp--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>startUp</h4> |
| <pre>public void startUp()</pre> |
| <div class="block">INTERNAL: |
| Build the default connection. |
| This validates that connect will work and sets up the parent accessor to clone.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#startUp--">startUp</a></code> in class <code><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">ConnectionPool</a></code></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 class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html" title="class in org.eclipse.persistence.sessions.server"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/persistence/sessions/server/ReadConnectionPool.html" title="class in org.eclipse.persistence.sessions.server"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/persistence/sessions/server/ExternalConnectionPool.html" target="_top">Frames</a></li> |
| <li><a href="ExternalConnectionPool.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
