diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html | 370 |
1 files changed, 370 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html new file mode 100644 index 0000000..9198bd4 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html @@ -0,0 +1,370 @@ +<!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 (version 1.7.0_25) on Tue Dec 03 13:53:41 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>JDBCConnectionCapability (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="JDBCConnectionCapability (Carbonado 1.2.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/JDBCConnectionCapability.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" target="_top">Frames</a></li> +<li><a href="JDBCConnectionCapability.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.repo.jdbc</div> +<h2 title="Interface JDBCConnectionCapability" class="title">Interface JDBCConnectionCapability</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">JDBCConnectionCapability</span> +extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre> +<div class="block">Capability to directly access the JDBC connection being used by the current + transaction, which is thread-local. If no transaction is in progress, then + the connection is in auto-commit mode. + + <p>All connections retrieved from this capability must be properly + yielded. Do not close the connection directly, as this interferes with the + transaction's ability to properly manage it. + + <p>It is perfectly okay for other Carbonado calls to be made while the + connection is in use. Also, it is okay to request more connections, + although they will usually be the same instance. Failing to yield a + connection has an undefined behavior. + + <pre> + JDBCConnectionCapability cap = repo.getCapability(JDBCConnectionCapability.class); + Transaction txn = repo.enterTransaction(); + try { + Connection con = cap.getConnection(); + try { + ... + } finally { + cap.yieldConnection(con); + } + ... + txn.commit(); + } finally { + txn.exit(); + } + </pre></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.sql.Connection</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#getConnection()">getConnection</a></strong>()</code> +<div class="block">Any connection returned by this method must be closed by calling + yieldConnection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#getDatabaseProductName()">getDatabaseProductName</a></strong>()</code> +<div class="block">Returns the name of the database product connected to.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#isTransactionForUpdate()">isTransactionForUpdate</a></strong>()</code> +<div class="block">Returns true if a transaction is in progress and it is for update.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#isUniqueConstraintError(java.sql.SQLException)">isUniqueConstraintError</a></strong>(java.sql.SQLException e)</code> +<div class="block">Examines the SQLSTATE code of the given SQL exception and determines if + it is a unique constaint violation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#toFetchException(java.lang.Throwable)">toFetchException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Transforms the given throwable into an appropriate fetch exception.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#toPersistException(java.lang.Throwable)">toPersistException</a></strong>(java.lang.Throwable e)</code> +<div class="block">Transforms the given throwable into an appropriate persist exception.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#yieldConnection(java.sql.Connection)">yieldConnection</a></strong>(java.sql.Connection con)</code> +<div class="block">Gives up a connection returned from getConnection.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getConnection()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnection</h4> +<pre>java.sql.Connection getConnection() + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Any connection returned by this method must be closed by calling + yieldConnection.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="yieldConnection(java.sql.Connection)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>yieldConnection</h4> +<pre>void yieldConnection(java.sql.Connection con) + throws <a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Gives up a connection returned from getConnection. Connection must be + yielded in same thread that retrieved it.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="toFetchException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toFetchException</h4> +<pre><a href="../../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a> toFetchException(java.lang.Throwable e)</pre> +<div class="block">Transforms the given throwable into an appropriate fetch exception. If + it already is a fetch exception, it is simply casted.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd> +<dt><span class="strong">Returns:</span></dt><dd>FetchException, never null</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="toPersistException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toPersistException</h4> +<pre><a href="../../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a> toPersistException(java.lang.Throwable e)</pre> +<div class="block">Transforms the given throwable into an appropriate persist exception. If + it already is a persist exception, it is simply casted.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - required exception to transform</dd> +<dt><span class="strong">Returns:</span></dt><dd>PersistException, never null</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="isUniqueConstraintError(java.sql.SQLException)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUniqueConstraintError</h4> +<pre>boolean isUniqueConstraintError(java.sql.SQLException e)</pre> +<div class="block">Examines the SQLSTATE code of the given SQL exception and determines if + it is a unique constaint violation.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="isTransactionForUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isTransactionForUpdate</h4> +<pre>boolean isTransactionForUpdate()</pre> +<div class="block">Returns true if a transaction is in progress and it is for update.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getDatabaseProductName()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDatabaseProductName</h4> +<pre>java.lang.String getDatabaseProductName()</pre> +<div class="block">Returns the name of the database product connected to.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/JDBCConnectionCapability.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" target="_top">Frames</a></li> +<li><a href="JDBCConnectionCapability.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |