blob: e94db6b0cac5ca4943ba72fa9a98e186cff9bdfa [file] [log] [blame]
<!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>ConnectionPool (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="ConnectionPool (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,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":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/ConnectionPolicy.ExclusiveMode.html" title="enum in org.eclipse.persistence.sessions.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html" title="class in org.eclipse.persistence.sessions.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/sessions/server/ConnectionPool.html" target="_top">Frames</a></li>
<li><a href="ConnectionPool.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 ConnectionPool" class="title">Class ConnectionPool</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>org.eclipse.persistence.sessions.server.ConnectionPool</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">ExternalConnectionPool</a>, <a href="../../../../../org/eclipse/persistence/sessions/server/ReadConnectionPool.html" title="class in org.eclipse.persistence.sessions.server">ReadConnectionPool</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ConnectionPool</span>
extends <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></pre>
<div class="block"><p>
<b>Purpose</b>: Used to specify how connection should be pooled in a server session.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server"><code>ServerSession</code></a></dd>
</dl>
</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">&nbsp;</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 boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#checkConnections">checkConnections</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.eclipse.persistence.internal.databaseaccess.Accessor&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#connectionsAvailable">connectionsAvailable</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.eclipse.persistence.internal.databaseaccess.Accessor&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#connectionsUsed">connectionsUsed</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#DEAD_CHECK_TIME">DEAD_CHECK_TIME</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#deadCheckTime">deadCheckTime</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#failoverConnectionPools">failoverConnectionPools</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#INITIAL_CONNECTIONS">INITIAL_CONNECTIONS</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#initialNumberOfConnections">initialNumberOfConnections</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#isConnected">isConnected</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#isDead">isDead</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#login">login</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#MAX_CONNECTIONS">MAX_CONNECTIONS</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#maxNumberOfConnections">maxNumberOfConnections</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#MIN_CONNECTIONS">MIN_CONNECTIONS</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#minNumberOfConnections">minNumberOfConnections</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#MONITOR_HEADER">MONITOR_HEADER</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#name">name</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#owner">owner</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#timeOfDeath">timeOfDeath</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#WAIT_TIMEOUT">WAIT_TIMEOUT</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#waitTimeout">waitTimeout</a></span></code>&nbsp;</td>
</tr>
</table>
</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">&nbsp;</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/ConnectionPool.html#ConnectionPool--">ConnectionPool</a></span>()</code>
<div class="block">PUBLIC:
A connection pool is used to specify how connection should be pooled in a server session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#ConnectionPool-java.lang.String-org.eclipse.persistence.sessions.Login-int-int-int-org.eclipse.persistence.sessions.server.ServerSession-">ConnectionPool</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>&nbsp;name,
<a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a>&nbsp;login,
int&nbsp;initialNumberOfConnections,
int&nbsp;minNumberOfConnections,
int&nbsp;maxNumberOfConnections,
<a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a>&nbsp;owner)</code>
<div class="block">PUBLIC:
A connection pool is used to specify how connection should be pooled in a server session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#ConnectionPool-java.lang.String-org.eclipse.persistence.sessions.Login-int-int-org.eclipse.persistence.sessions.server.ServerSession-">ConnectionPool</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>&nbsp;name,
<a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a>&nbsp;login,
int&nbsp;minNumberOfConnections,
int&nbsp;maxNumberOfConnections,
<a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a>&nbsp;owner)</code>
<div class="block">PUBLIC:
A connection pool is used to specify how connection should be pooled in a server session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#ConnectionPool-java.lang.String-org.eclipse.persistence.sessions.Login-org.eclipse.persistence.sessions.server.ServerSession-">ConnectionPool</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>&nbsp;name,
<a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a>&nbsp;login,
<a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a>&nbsp;owner)</code>
<div class="block">PUBLIC:
A connection pool is used to specify how connection should be pooled in a server session.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/ConnectionPool.html#acquireConnection--">acquireConnection</a></span>()</code>
<div class="block">INTERNAL:
Wait until a connection is available and allocate the connection for the client.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#addFailoverConnectionPool-java.lang.String-">addFailoverConnectionPool</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>&nbsp;poolName)</code>
<div class="block">PUBLIC:
Add the connection pool to used if this pool database goes down.</div>
</td>
</tr>
<tr id="i2" 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/ConnectionPool.html#buildConnection--">buildConnection</a></span>()</code>
<div class="block">INTERNAL:
Create a new connection, accessors are used as connections.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<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/ConnectionPool.html#failover--">failover</a></span>()</code>
<div class="block">INTERNAL:
The connection pool is dead fail over to the fail-over pool.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.eclipse.persistence.internal.databaseaccess.Accessor&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getConnectionsAvailable--">getConnectionsAvailable</a></span>()</code>
<div class="block">INTERNAL:
returns the connections currently available for use in the pool</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.eclipse.persistence.internal.databaseaccess.Accessor&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getConnectionsUsed--">getConnectionsUsed</a></span>()</code>
<div class="block">Return a list of the connections that are being used.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getFailoverConnectionPools--">getFailoverConnectionPools</a></span>()</code>
<div class="block">PUBLIC:
Return the list of connection pools to used if this pool database goes down.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getInitialNumberOfConnections--">getInitialNumberOfConnections</a></span>()</code>
<div class="block">PUBLIC:
Return the initial number of connections allowed.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getLogin--">getLogin</a></span>()</code>
<div class="block">PUBLIC:
Return the login used to create connections.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getMaxNumberOfConnections--">getMaxNumberOfConnections</a></span>()</code>
<div class="block">PUBLIC:
Return the maximum number of connections allowed.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getMinNumberOfConnections--">getMinNumberOfConnections</a></span>()</code>
<div class="block">PUBLIC:
Return the minimum number of connections.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getName--">getName</a></span>()</code>
<div class="block">PUBLIC:
Return the name of this pool.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getOwner--">getOwner</a></span>()</code>
<div class="block">Return the ServerSession that is the owner of this connection pool.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getTotalNumberOfConnections--">getTotalNumberOfConnections</a></span>()</code>
<div class="block">INTERNAL:
Return the total number of connections currently in use.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#getWaitTimeout--">getWaitTimeout</a></span>()</code>
<div class="block">PUBLIC:
Return the time in milliseconds to wait for a available connection.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#hasConnectionAvailable--">hasConnectionAvailable</a></span>()</code>
<div class="block">INTERNAL:
Wait until a connection is avaiable and allocate the connection for the client.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#isConnected--">isConnected</a></span>()</code>
<div class="block">INTERNAL:
Return if this pool has been connected to the database.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#isDead--">isDead</a></span>()</code>
<div class="block">ADVANCED:
Return if the connection pool's database is down, and failover should be used.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.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="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#releaseConnection-org.eclipse.persistence.internal.databaseaccess.Accessor-">releaseConnection</a></span>(org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;connection)</code>
<div class="block">INTERNAL:
Add the connection as single that a new connection is available.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#resetConnections--">resetConnections</a></span>()</code>
<div class="block">INTERNAL:
Reset the connections on shutDown and when the pool is started.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.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="i22" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setConnectionsAvailable-java.util.Vector-">setConnectionsAvailable</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;connectionsAvailable)</code>
<div class="block">INTERNAL:
Set this list of connections available</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setConnectionsUsed-java.util.Vector-">setConnectionsUsed</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;connectionsUsed)</code>
<div class="block">INTERNAL:
Set the list of connections being used.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setFailoverConnectionPools-java.util.List-">setFailoverConnectionPools</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;failoverConnectionPools)</code>
<div class="block">PUBLIC:
Set the list of connection pools to used if this pool database goes down.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setInitialNumberOfConnections-int-">setInitialNumberOfConnections</a></span>(int&nbsp;initialNumberOfConnections)</code>
<div class="block">PUBLIC:
Set the initial number of connections allowed.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setIsConnected-boolean-">setIsConnected</a></span>(boolean&nbsp;isConnected)</code>
<div class="block">INTERNAL:
Set if this pool has been connected to the database.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setIsDead-boolean-">setIsDead</a></span>(boolean&nbsp;isDead)</code>
<div class="block">ADVANCED:
Set if the connection pool's database is down, and failover should be used.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setLogin-org.eclipse.persistence.sessions.Login-">setLogin</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a>&nbsp;login)</code>
<div class="block">PUBLIC:
Set the login used to create connections.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setMaxNumberOfConnections-int-">setMaxNumberOfConnections</a></span>(int&nbsp;maxNumberOfConnections)</code>
<div class="block">PUBLIC:
Set the maximum number of connections allowed.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setMinNumberOfConnections-int-">setMinNumberOfConnections</a></span>(int&nbsp;minNumberOfConnections)</code>
<div class="block">PUBLIC:
Set the minimum number of connections.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setName-java.lang.String-">setName</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>&nbsp;name)</code>
<div class="block">PUBLIC:
Set the name of this pool.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setOwner-org.eclipse.persistence.sessions.server.ServerSession-">setOwner</a></span>(<a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a>&nbsp;owner)</code>
<div class="block">Set the ServerSession that owns this connection pool</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#setWaitTimeout-int-">setWaitTimeout</a></span>(int&nbsp;waitTimeout)</code>
<div class="block">PUBLIC:
Set the time in milliseconds to wait for an available connection.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#shutDown--">shutDown</a></span>()</code>
<div class="block">INTERNAL:
Disconnect all connections.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#startUp--">startUp</a></span>()</code>
<div class="block">INTERNAL:
Allocate the minimum connections.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/persistence/sessions/server/ConnectionPool.html#toString--">toString</a></span>()</code>
<div class="block">INTERNAL:
return a string representation of this connection pool</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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="MONITOR_HEADER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MONITOR_HEADER</h4>
<pre>protected static final&nbsp;<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> MONITOR_HEADER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.persistence.sessions.server.ConnectionPool.MONITOR_HEADER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="isConnected">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConnected</h4>
<pre>protected&nbsp;boolean isConnected</pre>
</li>
</ul>
<a name="maxNumberOfConnections">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxNumberOfConnections</h4>
<pre>protected&nbsp;int maxNumberOfConnections</pre>
</li>
</ul>
<a name="minNumberOfConnections">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minNumberOfConnections</h4>
<pre>protected&nbsp;int minNumberOfConnections</pre>
</li>
</ul>
<a name="initialNumberOfConnections">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialNumberOfConnections</h4>
<pre>protected&nbsp;int initialNumberOfConnections</pre>
</li>
</ul>
<a name="waitTimeout">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>waitTimeout</h4>
<pre>protected&nbsp;int waitTimeout</pre>
</li>
</ul>
<a name="connectionsAvailable">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectionsAvailable</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.eclipse.persistence.internal.databaseaccess.Accessor&gt; connectionsAvailable</pre>
</li>
</ul>
<a name="connectionsUsed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectionsUsed</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.eclipse.persistence.internal.databaseaccess.Accessor&gt; connectionsUsed</pre>
</li>
</ul>
<a name="login">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>login</h4>
<pre>protected&nbsp;<a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a> login</pre>
</li>
</ul>
<a name="name">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>protected&nbsp;<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</pre>
</li>
</ul>
<a name="owner">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>owner</h4>
<pre>protected&nbsp;<a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a> owner</pre>
</li>
</ul>
<a name="checkConnections">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkConnections</h4>
<pre>protected volatile&nbsp;boolean checkConnections</pre>
</li>
</ul>
<a name="timeOfDeath">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>timeOfDeath</h4>
<pre>protected volatile&nbsp;long timeOfDeath</pre>
</li>
</ul>
<a name="deadCheckTime">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deadCheckTime</h4>
<pre>protected volatile&nbsp;long deadCheckTime</pre>
</li>
</ul>
<a name="isDead">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDead</h4>
<pre>protected volatile&nbsp;boolean isDead</pre>
</li>
</ul>
<a name="failoverConnectionPools">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>failoverConnectionPools</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt; failoverConnectionPools</pre>
</li>
</ul>
<a name="DEAD_CHECK_TIME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEAD_CHECK_TIME</h4>
<pre>public static final&nbsp;long DEAD_CHECK_TIME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.persistence.sessions.server.ConnectionPool.DEAD_CHECK_TIME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MAX_CONNECTIONS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAX_CONNECTIONS</h4>
<pre>public static final&nbsp;int MAX_CONNECTIONS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.persistence.sessions.server.ConnectionPool.MAX_CONNECTIONS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MIN_CONNECTIONS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MIN_CONNECTIONS</h4>
<pre>public static final&nbsp;int MIN_CONNECTIONS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.persistence.sessions.server.ConnectionPool.MIN_CONNECTIONS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INITIAL_CONNECTIONS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INITIAL_CONNECTIONS</h4>
<pre>public static final&nbsp;int INITIAL_CONNECTIONS</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.persistence.sessions.server.ConnectionPool.INITIAL_CONNECTIONS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="WAIT_TIMEOUT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WAIT_TIMEOUT</h4>
<pre>public static final&nbsp;int WAIT_TIMEOUT</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.persistence.sessions.server.ConnectionPool.WAIT_TIMEOUT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ConnectionPool--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ConnectionPool</h4>
<pre>public&nbsp;ConnectionPool()</pre>
<div class="block">PUBLIC:
A connection pool is used to specify how connection should be pooled in a server session.</div>
</li>
</ul>
<a name="ConnectionPool-java.lang.String-org.eclipse.persistence.sessions.Login-org.eclipse.persistence.sessions.server.ServerSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ConnectionPool</h4>
<pre>public&nbsp;ConnectionPool(<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>&nbsp;name,
<a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a>&nbsp;login,
<a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a>&nbsp;owner)</pre>
<div class="block">PUBLIC:
A connection pool is used to specify how connection should be pooled in a server session.</div>
</li>
</ul>
<a name="ConnectionPool-java.lang.String-org.eclipse.persistence.sessions.Login-int-int-org.eclipse.persistence.sessions.server.ServerSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ConnectionPool</h4>
<pre>public&nbsp;ConnectionPool(<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>&nbsp;name,
<a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a>&nbsp;login,
int&nbsp;minNumberOfConnections,
int&nbsp;maxNumberOfConnections,
<a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a>&nbsp;owner)</pre>
<div class="block">PUBLIC:
A connection pool is used to specify how connection should be pooled in a server session.</div>
</li>
</ul>
<a name="ConnectionPool-java.lang.String-org.eclipse.persistence.sessions.Login-int-int-int-org.eclipse.persistence.sessions.server.ServerSession-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ConnectionPool</h4>
<pre>public&nbsp;ConnectionPool(<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>&nbsp;name,
<a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a>&nbsp;login,
int&nbsp;initialNumberOfConnections,
int&nbsp;minNumberOfConnections,
int&nbsp;maxNumberOfConnections,
<a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a>&nbsp;owner)</pre>
<div class="block">PUBLIC:
A connection pool is used to specify how connection should be pooled in a server session.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="failover--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>failover</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;failover()</pre>
<div class="block">INTERNAL:
The connection pool is dead fail over to the fail-over pool.</div>
</li>
</ul>
<a name="acquireConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acquireConnection</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;acquireConnection()
throws <a href="../../../../../org/eclipse/persistence/exceptions/ConcurrencyException.html" title="class in org.eclipse.persistence.exceptions">ConcurrencyException</a></pre>
<div class="block">INTERNAL:
Wait until a connection is available and allocate the connection for the client.</div>
<dl>
<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="buildConnection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildConnection</h4>
<pre>protected&nbsp;org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;buildConnection()</pre>
<div class="block">INTERNAL:
Create a new connection, accessors are used as connections.</div>
</li>
</ul>
<a name="getConnectionsAvailable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionsAvailable</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.eclipse.persistence.internal.databaseaccess.Accessor&gt;&nbsp;getConnectionsAvailable()</pre>
<div class="block">INTERNAL:
returns the connections currently available for use in the pool</div>
</li>
</ul>
<a name="getConnectionsUsed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionsUsed</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.eclipse.persistence.internal.databaseaccess.Accessor&gt;&nbsp;getConnectionsUsed()</pre>
<div class="block">Return a list of the connections that are being used.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>java.util.Vector</dd>
</dl>
</li>
</ul>
<a name="getLogin--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogin</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a>&nbsp;getLogin()</pre>
<div class="block">PUBLIC:
Return the login used to create connections.</div>
</li>
</ul>
<a name="getMaxNumberOfConnections--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxNumberOfConnections</h4>
<pre>public&nbsp;int&nbsp;getMaxNumberOfConnections()</pre>
<div class="block">PUBLIC:
Return the maximum number of connections allowed.
If all connections are in use, a new connection will be created until the maximum size is reach.
Only the minimum number of connections will be pooled, if the pool is between the min and max size
the connection will be disconnected when returned to the pool.
Typically it is desirable to have the min and max connections the same to avoid connects and disconnects.
When the max is reached clients must wait for a connection to become available.</div>
</li>
</ul>
<a name="getMinNumberOfConnections--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinNumberOfConnections</h4>
<pre>public&nbsp;int&nbsp;getMinNumberOfConnections()</pre>
<div class="block">PUBLIC:
Return the minimum number of connections.
If all connections are in use, a new connection will be created until the maximum size is reach.
Only the minimum number of connections will be pooled, if the pool is between the min and max size
the connection will be disconnected when returned to the pool.
Typically it is desirable to have the min and max connections the same to avoid connects and disconnects.</div>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<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>&nbsp;getName()</pre>
<div class="block">PUBLIC:
Return the name of this pool.
Pools are identified by name to allow multiple connection pools.</div>
</li>
</ul>
<a name="getOwner--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwner</h4>
<pre>protected&nbsp;<a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a>&nbsp;getOwner()</pre>
<div class="block">Return the ServerSession that is the owner of this connection pool.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>org.eclipse.persistence.sessions.server.ServerSession</dd>
</dl>
</li>
</ul>
<a name="getTotalNumberOfConnections--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalNumberOfConnections</h4>
<pre>public&nbsp;int&nbsp;getTotalNumberOfConnections()</pre>
<div class="block">INTERNAL:
Return the total number of connections currently in use.</div>
</li>
</ul>
<a name="hasConnectionAvailable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasConnectionAvailable</h4>
<pre>public&nbsp;boolean&nbsp;hasConnectionAvailable()</pre>
<div class="block">INTERNAL:
Wait until a connection is avaiable and allocate the connection for the client.</div>
</li>
</ul>
<a name="isConnected--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConnected</h4>
<pre>public&nbsp;boolean&nbsp;isConnected()</pre>
<div class="block">INTERNAL:
Return if this pool has been connected to the database.</div>
</li>
</ul>
<a name="isThereConflictBetweenLoginAndType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isThereConflictBetweenLoginAndType</h4>
<pre>public&nbsp;boolean&nbsp;isThereConflictBetweenLoginAndType()</pre>
<div class="block">INTERNAL:
Checks for a conflict between pool's type and pool's login</div>
</li>
</ul>
<a name="releaseConnection-org.eclipse.persistence.internal.databaseaccess.Accessor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>releaseConnection</h4>
<pre>public&nbsp;void&nbsp;releaseConnection(org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;connection)
throws <a href="../../../../../org/eclipse/persistence/exceptions/DatabaseException.html" title="class in org.eclipse.persistence.exceptions">DatabaseException</a></pre>
<div class="block">INTERNAL:
Add the connection as single that a new connection is available.</div>
<dl>
<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="resetConnections--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetConnections</h4>
<pre>public&nbsp;void&nbsp;resetConnections()</pre>
<div class="block">INTERNAL:
Reset the connections on shutDown and when the pool is started.</div>
</li>
</ul>
<a name="setCheckConnections--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCheckConnections</h4>
<pre>public&nbsp;void&nbsp;setCheckConnections()</pre>
<div class="block">INTERNAL:
This method is called to indicate that all available connections should be checked.</div>
</li>
</ul>
<a name="setConnectionsAvailable-java.util.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConnectionsAvailable</h4>
<pre>protected&nbsp;void&nbsp;setConnectionsAvailable(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;connectionsAvailable)</pre>
<div class="block">INTERNAL:
Set this list of connections available</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connectionsAvailable</code> - </dd>
</dl>
</li>
</ul>
<a name="setConnectionsUsed-java.util.Vector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConnectionsUsed</h4>
<pre>protected&nbsp;void&nbsp;setConnectionsUsed(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;connectionsUsed)</pre>
<div class="block">INTERNAL:
Set the list of connections being used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connectionsUsed</code> - </dd>
</dl>
</li>
</ul>
<a name="setIsConnected-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIsConnected</h4>
<pre>public&nbsp;void&nbsp;setIsConnected(boolean&nbsp;isConnected)</pre>
<div class="block">INTERNAL:
Set if this pool has been connected to the database.</div>
</li>
</ul>
<a name="setLogin-org.eclipse.persistence.sessions.Login-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLogin</h4>
<pre>public&nbsp;void&nbsp;setLogin(<a href="../../../../../org/eclipse/persistence/sessions/Login.html" title="interface in org.eclipse.persistence.sessions">Login</a>&nbsp;login)</pre>
<div class="block">PUBLIC:
Set the login used to create connections.</div>
</li>
</ul>
<a name="getInitialNumberOfConnections--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialNumberOfConnections</h4>
<pre>public&nbsp;int&nbsp;getInitialNumberOfConnections()</pre>
<div class="block">PUBLIC:
Return the initial number of connections allowed.
This is the number of connections connected on startup.</div>
</li>
</ul>
<a name="setInitialNumberOfConnections-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInitialNumberOfConnections</h4>
<pre>public&nbsp;void&nbsp;setInitialNumberOfConnections(int&nbsp;initialNumberOfConnections)</pre>
<div class="block">PUBLIC:
Set the initial number of connections allowed.
This is the number of connections connected on startup.
The default is 1.</div>
</li>
</ul>
<a name="setMaxNumberOfConnections-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxNumberOfConnections</h4>
<pre>public&nbsp;void&nbsp;setMaxNumberOfConnections(int&nbsp;maxNumberOfConnections)</pre>
<div class="block">PUBLIC:
Set the maximum number of connections allowed.
If all connections are in use, a new connection will be created until the maximum size is reach.
Only the minimum number of connections will be pooled, if the pool is between the min and max size
the connection will be disconnected when returned to the pool.
Typically it is desirable to have the min and max connections the same to avoid connects and disconnects.
When the max is reached clients must wait for a connection to become available.
The default is 32.</div>
</li>
</ul>
<a name="setMinNumberOfConnections-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMinNumberOfConnections</h4>
<pre>public&nbsp;void&nbsp;setMinNumberOfConnections(int&nbsp;minNumberOfConnections)</pre>
<div class="block">PUBLIC:
Set the minimum number of connections.
If all connections are in use, a new connection will be created until the maximum size is reach.
Only the minimum number of connections will be pooled, if the pool is between the min and max size
the connection will be disconnected when returned to the pool.
Typically it is desirable to have the min and max connections the same to avoid connects and disconnects.
The default is 32.</div>
</li>
</ul>
<a name="setName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public&nbsp;void&nbsp;setName(<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>&nbsp;name)</pre>
<div class="block">PUBLIC:
Set the name of this pool.
Pools are identified by name to allow multiple connection pools.</div>
</li>
</ul>
<a name="setOwner-org.eclipse.persistence.sessions.server.ServerSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOwner</h4>
<pre>protected&nbsp;void&nbsp;setOwner(<a href="../../../../../org/eclipse/persistence/sessions/server/ServerSession.html" title="class in org.eclipse.persistence.sessions.server">ServerSession</a>&nbsp;owner)</pre>
<div class="block">Set the ServerSession that owns this connection pool</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>owner</code> - </dd>
</dl>
</li>
</ul>
<a name="shutDown--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutDown</h4>
<pre>public&nbsp;void&nbsp;shutDown()</pre>
<div class="block">INTERNAL:
Disconnect all connections.</div>
</li>
</ul>
<a name="startUp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startUp</h4>
<pre>public&nbsp;void&nbsp;startUp()</pre>
<div class="block">INTERNAL:
Allocate the minimum connections.</div>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<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>&nbsp;toString()</pre>
<div class="block">INTERNAL:
return a string representation of this connection pool</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</li>
</ul>
<a name="getWaitTimeout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWaitTimeout</h4>
<pre>public&nbsp;int&nbsp;getWaitTimeout()</pre>
<div class="block">PUBLIC:
Return the time in milliseconds to wait for a available connection.
If the wait time is exceeded and exception will occur.
The default is 180000 or 3 minutes.
A value of 0 means wait forever.</div>
</li>
</ul>
<a name="setWaitTimeout-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setWaitTimeout</h4>
<pre>public&nbsp;void&nbsp;setWaitTimeout(int&nbsp;waitTimeout)</pre>
<div class="block">PUBLIC:
Set the time in milliseconds to wait for an available connection.
If the wait time is exceeded an exception will occur.
The default is 180000 or 3 minutes.
A value of 0 means wait forever.</div>
</li>
</ul>
<a name="isDead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDead</h4>
<pre>public&nbsp;boolean&nbsp;isDead()</pre>
<div class="block">ADVANCED:
Return if the connection pool's database is down, and failover should be used.</div>
</li>
</ul>
<a name="setIsDead-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIsDead</h4>
<pre>public&nbsp;void&nbsp;setIsDead(boolean&nbsp;isDead)</pre>
<div class="block">ADVANCED:
Set if the connection pool's database is down, and failover should be used.</div>
</li>
</ul>
<a name="getFailoverConnectionPools--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFailoverConnectionPools</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;getFailoverConnectionPools()</pre>
<div class="block">PUBLIC:
Return the list of connection pools to used if this pool database goes down.
The failover pools should be a clustered, replicated or backuped database.</div>
</li>
</ul>
<a name="setFailoverConnectionPools-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFailoverConnectionPools</h4>
<pre>public&nbsp;void&nbsp;setFailoverConnectionPools(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<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>&gt;&nbsp;failoverConnectionPools)</pre>
<div class="block">PUBLIC:
Set the list of connection pools to used if this pool database goes down.
The failover pools should be a clustered, replicated or backuped database.</div>
</li>
</ul>
<a name="addFailoverConnectionPool-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addFailoverConnectionPool</h4>
<pre>public&nbsp;boolean&nbsp;addFailoverConnectionPool(<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>&nbsp;poolName)</pre>
<div class="block">PUBLIC:
Add the connection pool to used if this pool database goes down.
The failover pools should be a clustered, replicated or backuped database.</div>
</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/ConnectionPolicy.ExclusiveMode.html" title="enum in org.eclipse.persistence.sessions.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/persistence/sessions/server/ExternalConnectionPool.html" title="class in org.eclipse.persistence.sessions.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/persistence/sessions/server/ConnectionPool.html" target="_top">Frames</a></li>
<li><a href="ConnectionPool.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>