blob: 2bc6f8469ee3dc0cc7b5298a449747f69d0ea831 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:01 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JDBCLockManager (OpenJPA Parent POM 2.4.3 API)</title>
<meta name="date" content="2018-06-14">
<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="JDBCLockManager (OpenJPA Parent POM 2.4.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/JDBCLockManager.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-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfigurationImpl.JDBCConfigurationState.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCSeq.html" title="interface in org.apache.openjpa.jdbc.kernel"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/kernel/JDBCLockManager.html" target="_top">Frames</a></li>
<li><a href="JDBCLockManager.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.apache.openjpa.jdbc.kernel</div>
<h2 title="Interface JDBCLockManager" class="title">Interface JDBCLockManager</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a>, <a href="../../../../../org/apache/openjpa/kernel/LockLevels.html" title="interface in org.apache.openjpa.kernel">LockLevels</a>, <a href="../../../../../org/apache/openjpa/kernel/LockManager.html" title="interface in org.apache.openjpa.kernel">LockManager</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/jdbc/kernel/MixedLockManager.html" title="class in org.apache.openjpa.jdbc.kernel">MixedLockManager</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/PessimisticLockManager.html" title="class in org.apache.openjpa.jdbc.kernel">PessimisticLockManager</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">JDBCLockManager</span>
extends <a href="../../../../../org/apache/openjpa/kernel/LockManager.html" title="interface in org.apache.openjpa.kernel">LockManager</a></pre>
<div class="block">Extension of the <a href="../../../../../org/apache/openjpa/kernel/LockManager.html" title="interface in org.apache.openjpa.kernel"><code>LockManager</code></a> interface with methods for
datastore locking during the select and load process. Implementors of
this interface can also take advantage of the fact that in the
<a href="../../../../../org/apache/openjpa/kernel/LockManager.html#lock(org.apache.openjpa.kernel.OpenJPAStateManager,%20int,%20int,%20java.lang.Object)"><code>LockManager.lock(org.apache.openjpa.kernel.OpenJPAStateManager, int, int, java.lang.Object)</code></a> and <a href="../../../../../org/apache/openjpa/kernel/LockManager.html#lockAll(java.util.Collection,%20int,%20int,%20java.lang.Object)"><code>LockManager.lockAll(java.util.Collection, int, int, java.lang.Object)</code></a> methods, the
given <code>conn</code> parameter, if any, will be an instance of
<a href="../../../../../org/apache/openjpa/jdbc/kernel/ConnectionInfo.html" title="class in org.apache.openjpa.jdbc.kernel"><code>ConnectionInfo</code></a>.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Abe White</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>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.openjpa.kernel.LockLevels">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.openjpa.kernel.<a href="../../../../../org/apache/openjpa/kernel/LockLevels.html" title="interface in org.apache.openjpa.kernel">LockLevels</a></h3>
<code><a href="../../../../../org/apache/openjpa/kernel/LockLevels.html#LOCK_NONE">LOCK_NONE</a>, <a href="../../../../../org/apache/openjpa/kernel/LockLevels.html#LOCK_READ">LOCK_READ</a>, <a href="../../../../../org/apache/openjpa/kernel/LockLevels.html#LOCK_WRITE">LOCK_WRITE</a></code></li>
</ul>
</li>
</ul>
<!-- ========== 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">&nbsp;</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCLockManager.html#loadedForUpdate(org.apache.openjpa.kernel.OpenJPAStateManager)">loadedForUpdate</a></strong>(<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm)</code>
<div class="block">Notification that the given instance was loaded via a result set
produced by a FOR UPDATE select.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCLockManager.html#selectForUpdate(org.apache.openjpa.jdbc.sql.Select,%20int)">selectForUpdate</a></strong>(<a href="../../../../../org/apache/openjpa/jdbc/sql/Select.html" title="interface in org.apache.openjpa.jdbc.sql">Select</a>&nbsp;sel,
int&nbsp;lockLevel)</code>
<div class="block">Return whether to issue the given select FOR UPDATE, depending on
the capabilities of the dictionary and the fetch configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCLockManager.html#skipRelationFieldLock()">skipRelationFieldLock</a></strong>()</code>
<div class="block">Return true if locking is not desired for relation fields.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.kernel.LockManager">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.kernel.<a href="../../../../../org/apache/openjpa/kernel/LockManager.html" title="interface in org.apache.openjpa.kernel">LockManager</a></h3>
<code><a href="../../../../../org/apache/openjpa/kernel/LockManager.html#beginTransaction()">beginTransaction</a>, <a href="../../../../../org/apache/openjpa/kernel/LockManager.html#close()">close</a>, <a href="../../../../../org/apache/openjpa/kernel/LockManager.html#endTransaction()">endTransaction</a>, <a href="../../../../../org/apache/openjpa/kernel/LockManager.html#getLockLevel(org.apache.openjpa.kernel.OpenJPAStateManager)">getLockLevel</a>, <a href="../../../../../org/apache/openjpa/kernel/LockManager.html#lock(org.apache.openjpa.kernel.OpenJPAStateManager,%20int,%20int,%20java.lang.Object)">lock</a>, <a href="../../../../../org/apache/openjpa/kernel/LockManager.html#lockAll(java.util.Collection,%20int,%20int,%20java.lang.Object)">lockAll</a>, <a href="../../../../../org/apache/openjpa/kernel/LockManager.html#refreshLock(org.apache.openjpa.kernel.OpenJPAStateManager,%20int,%20int,%20java.lang.Object)">refreshLock</a>, <a href="../../../../../org/apache/openjpa/kernel/LockManager.html#release(org.apache.openjpa.kernel.OpenJPAStateManager)">release</a>, <a href="../../../../../org/apache/openjpa/kernel/LockManager.html#setContext(org.apache.openjpa.kernel.StoreContext)">setContext</a></code></li>
</ul>
</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="selectForUpdate(org.apache.openjpa.jdbc.sql.Select, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>selectForUpdate</h4>
<pre>boolean&nbsp;selectForUpdate(<a href="../../../../../org/apache/openjpa/jdbc/sql/Select.html" title="interface in org.apache.openjpa.jdbc.sql">Select</a>&nbsp;sel,
int&nbsp;lockLevel)</pre>
<div class="block">Return whether to issue the given select FOR UPDATE, depending on
the capabilities of the dictionary and the fetch configuration.</div>
</li>
</ul>
<a name="loadedForUpdate(org.apache.openjpa.kernel.OpenJPAStateManager)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadedForUpdate</h4>
<pre>void&nbsp;loadedForUpdate(<a href="../../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm)</pre>
<div class="block">Notification that the given instance was loaded via a result set
produced by a FOR UPDATE select.</div>
</li>
</ul>
<a name="skipRelationFieldLock()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>skipRelationFieldLock</h4>
<pre>boolean&nbsp;skipRelationFieldLock()</pre>
<div class="block">Return true if locking is not desired for relation fields.</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/JDBCLockManager.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-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCFetchConfigurationImpl.JDBCConfigurationState.html" title="class in org.apache.openjpa.jdbc.kernel"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/jdbc/kernel/JDBCSeq.html" title="interface in org.apache.openjpa.jdbc.kernel"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/jdbc/kernel/JDBCLockManager.html" target="_top">Frames</a></li>
<li><a href="JDBCLockManager.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>