Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 3.0.0 / apidocs / org / apache / openjpa / kernel / VersionLockManager.html
blob: 2d1a2cb3e74c31a75bffd191849b3cf68b6d74a8 [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 (1.8.0_171) on Thu Jun 14 10:06:05 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>VersionLockManager (OpenJPA Parent POM 3.0.0 API)</title>
<meta name="date" content="2018-06-14">
<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="VersionLockManager (OpenJPA Parent POM 3.0.0 API)";
}
}
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};
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="class-use/VersionLockManager.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/kernel/UUIDType4StringSeq.html" title="class in org.apache.openjpa.kernel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/kernel/VersionLockManager.html" target="_top">Frames</a></li>
<li><a href="VersionLockManager.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="#fields.inherited.from.class.org.apache.openjpa.kernel.AbstractLockManager">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>Field&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.apache.openjpa.kernel</div>
<h2 title="Class VersionLockManager" class="title">Class VersionLockManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html" title="class in org.apache.openjpa.kernel">org.apache.openjpa.kernel.AbstractLockManager</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openjpa.kernel.VersionLockManager</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><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>, <a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><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 class <span class="typeNameLabel">VersionLockManager</span>
extends <a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html" title="class in org.apache.openjpa.kernel">AbstractLockManager</a></pre>
<div class="block"><a href="../../../../org/apache/openjpa/kernel/LockManager.html" title="interface in org.apache.openjpa.kernel"><code>LockManager</code></a> implementation that provides support
for version checking and version updating when locks are acquired.
This lock manager may be used standalone or extended for additional locking.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Marc Prud'hommeaux</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.AbstractLockManager">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html" title="class in org.apache.openjpa.kernel">AbstractLockManager</a></h3>
<code><a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html#ctx">ctx</a>, <a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html#log">log</a></code></li>
</ul>
<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>
<!-- ======== 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/apache/openjpa/kernel/VersionLockManager.html#VersionLockManager--">VersionLockManager</a></span>()</code>&nbsp;</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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#getLockLevel-org.apache.openjpa.kernel.OpenJPAStateManager-">getLockLevel</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm)</code>
<div class="block">Returns the given instance's lock level, assuming that the state's
lock object is a number.</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/apache/openjpa/kernel/VersionLockManager.html#getVersionCheckOnReadLock--">getVersionCheckOnReadLock</a></span>()</code>
<div class="block">Whether or not we should force a version check at commit
time when a read lock is requested in order to verify read
consistency.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#getVersionUpdateOnWriteLock--">getVersionUpdateOnWriteLock</a></span>()</code>
<div class="block">Whether or not we should force an update to the version at commit
time when a write lock is requested.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#lock-org.apache.openjpa.kernel.OpenJPAStateManager-int-int-java.lang.Object-">lock</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
int&nbsp;level,
int&nbsp;timeout,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;sdata)</code>
<div class="block">Delegates to <a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#lockInternal-org.apache.openjpa.kernel.OpenJPAStateManager-int-int-java.lang.Object-boolean-"><code>lockInternal(org.apache.openjpa.kernel.OpenJPAStateManager, int, int, java.lang.Object, boolean)</code></a> after traversing to owning
instance (if embedded) and assuring that the instance is persistent,
is not new, and is not already locked at a higher level.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#lockInternal-org.apache.openjpa.kernel.OpenJPAStateManager-int-int-java.lang.Object-boolean-">lockInternal</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
int&nbsp;level,
int&nbsp;timeout,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;sdata,
boolean&nbsp;postLockVersionCheck)</code>
<div class="block">Marks the instance's transactional status in accordance with
the settings of <a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#getVersionCheckOnReadLock--"><code>getVersionCheckOnReadLock()</code></a>
and <a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#getVersionUpdateOnWriteLock--"><code>getVersionUpdateOnWriteLock()</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#optimisticLockInternal-org.apache.openjpa.kernel.OpenJPAStateManager-int-int-java.lang.Object-boolean-">optimisticLockInternal</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
int&nbsp;level,
int&nbsp;timeout,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;sdata,
boolean&nbsp;postLockVersionCheck)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#refreshLock-org.apache.openjpa.kernel.OpenJPAStateManager-int-int-java.lang.Object-">refreshLock</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
int&nbsp;level,
int&nbsp;timeout,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;sdata)</code>
<div class="block">Perform the same function as previous lock method and has the option
to perform a version check after the lock function has completed.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#release-org.apache.openjpa.kernel.OpenJPAStateManager-">release</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm)</code>
<div class="block">Nulls given instance's lock object.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#setLockLevel-org.apache.openjpa.kernel.OpenJPAStateManager-int-">setLockLevel</a></span>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
int&nbsp;level)</code>
<div class="block">Sets the given instance's lock level to the given number.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#setVersionCheckOnReadLock-boolean-">setVersionCheckOnReadLock</a></span>(boolean&nbsp;versionCheckOnReadLock)</code>
<div class="block">Whether or not we should force a version check at commit
time when a read lock is requested in order to verify read
consistency.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#setVersionUpdateOnWriteLock-boolean-">setVersionUpdateOnWriteLock</a></span>(boolean&nbsp;versionUpdateOnWriteLock)</code>
<div class="block">Whether or not we should force an update to the version at commit
time when a write lock is requested.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.kernel.AbstractLockManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html" title="class in org.apache.openjpa.kernel">AbstractLockManager</a></h3>
<code><a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html#beginTransaction--">beginTransaction</a>, <a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html#close--">close</a>, <a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html#endTransaction--">endTransaction</a>, <a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html#getContext--">getContext</a>, <a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html#lockAll-java.util.Collection-int-int-java.lang.Object-">lockAll</a>, <a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html#setContext-org.apache.openjpa.kernel.StoreContext-">setContext</a>, <a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html#skipRelationFieldLock--">skipRelationFieldLock</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://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="http://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="http://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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="VersionLockManager--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>VersionLockManager</h4>
<pre>public&nbsp;VersionLockManager()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getLockLevel-org.apache.openjpa.kernel.OpenJPAStateManager-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLockLevel</h4>
<pre>public&nbsp;int&nbsp;getLockLevel(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm)</pre>
<div class="block">Returns the given instance's lock level, assuming that the state's
lock object is a number. If the given instance is embedded, traverses
to its owner. Override if lock is not stored as a number.</div>
</li>
</ul>
<a name="setLockLevel-org.apache.openjpa.kernel.OpenJPAStateManager-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLockLevel</h4>
<pre>protected&nbsp;void&nbsp;setLockLevel(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
int&nbsp;level)</pre>
<div class="block">Sets the given instance's lock level to the given number. Override
to store something else as the lock.</div>
</li>
</ul>
<a name="release-org.apache.openjpa.kernel.OpenJPAStateManager-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>release</h4>
<pre>public&nbsp;void&nbsp;release(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm)</pre>
<div class="block">Nulls given instance's lock object.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setLock-java.lang.Object-"><code>OpenJPAStateManager.setLock(java.lang.Object)</code></a></dd>
</dl>
</li>
</ul>
<a name="lock-org.apache.openjpa.kernel.OpenJPAStateManager-int-int-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lock</h4>
<pre>public&nbsp;void&nbsp;lock(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
int&nbsp;level,
int&nbsp;timeout,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;sdata)</pre>
<div class="block">Delegates to <a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#lockInternal-org.apache.openjpa.kernel.OpenJPAStateManager-int-int-java.lang.Object-boolean-"><code>lockInternal(org.apache.openjpa.kernel.OpenJPAStateManager, int, int, java.lang.Object, boolean)</code></a> after traversing to owning
instance (if embedded) and assuring that the instance is persistent,
is not new, and is not already locked at a higher level. After
locking, calls <a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#setLockLevel-org.apache.openjpa.kernel.OpenJPAStateManager-int-"><code>setLockLevel(org.apache.openjpa.kernel.OpenJPAStateManager, int)</code></a> with the given level.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sm</code> - the object to lock</dd>
<dd><code>level</code> - one of the lock constants defined in <a href="../../../../org/apache/openjpa/kernel/LockLevels.html" title="interface in org.apache.openjpa.kernel"><code>LockLevels</code></a>,
or a custom level</dd>
<dd><code>timeout</code> - the timeout in milliseconds, or a negative number for
no timeout</dd>
<dd><code>sdata</code> - the context information passed from the store manager
to the persistence context, if any; lock managers
specific to a certain back end may be able to take
advantage of this; others should ignore it</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setLock-java.lang.Object-"><code>OpenJPAStateManager.setLock(java.lang.Object)</code></a></dd>
</dl>
</li>
</ul>
<a name="refreshLock-org.apache.openjpa.kernel.OpenJPAStateManager-int-int-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refreshLock</h4>
<pre>public&nbsp;void&nbsp;refreshLock(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
int&nbsp;level,
int&nbsp;timeout,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;sdata)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/LockManager.html#refreshLock-org.apache.openjpa.kernel.OpenJPAStateManager-int-int-java.lang.Object-">LockManager</a></code></span></div>
<div class="block">Perform the same function as previous lock method and has the option
to perform a version check after the lock function has completed.</div>
</li>
</ul>
<a name="lockInternal-org.apache.openjpa.kernel.OpenJPAStateManager-int-int-java.lang.Object-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lockInternal</h4>
<pre>protected&nbsp;void&nbsp;lockInternal(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
int&nbsp;level,
int&nbsp;timeout,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;sdata,
boolean&nbsp;postLockVersionCheck)</pre>
<div class="block">Marks the instance's transactional status in accordance with
the settings of <a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#getVersionCheckOnReadLock--"><code>getVersionCheckOnReadLock()</code></a>
and <a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html#getVersionUpdateOnWriteLock--"><code>getVersionUpdateOnWriteLock()</code></a>. Override to perform
additional locking.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/openjpa/kernel/StoreContext.html#transactional-java.lang.Object-boolean-org.apache.openjpa.kernel.OpCallbacks-"><code>StoreContext.transactional(java.lang.Object, boolean, org.apache.openjpa.kernel.OpCallbacks)</code></a></dd>
</dl>
</li>
</ul>
<a name="optimisticLockInternal-org.apache.openjpa.kernel.OpenJPAStateManager-int-int-java.lang.Object-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optimisticLockInternal</h4>
<pre>protected&nbsp;void&nbsp;optimisticLockInternal(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
int&nbsp;level,
int&nbsp;timeout,
<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;sdata,
boolean&nbsp;postLockVersionCheck)</pre>
</li>
</ul>
<a name="setVersionCheckOnReadLock-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVersionCheckOnReadLock</h4>
<pre>public&nbsp;void&nbsp;setVersionCheckOnReadLock(boolean&nbsp;versionCheckOnReadLock)</pre>
<div class="block">Whether or not we should force a version check at commit
time when a read lock is requested in order to verify read
consistency. Defaults to true.</div>
</li>
</ul>
<a name="getVersionCheckOnReadLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersionCheckOnReadLock</h4>
<pre>public&nbsp;boolean&nbsp;getVersionCheckOnReadLock()</pre>
<div class="block">Whether or not we should force a version check at commit
time when a read lock is requested in order to verify read
consistency. Defaults to true.</div>
</li>
</ul>
<a name="setVersionUpdateOnWriteLock-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVersionUpdateOnWriteLock</h4>
<pre>public&nbsp;void&nbsp;setVersionUpdateOnWriteLock(boolean&nbsp;versionUpdateOnWriteLock)</pre>
<div class="block">Whether or not we should force an update to the version at commit
time when a write lock is requested. Defaults to true.</div>
</li>
</ul>
<a name="getVersionUpdateOnWriteLock--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getVersionUpdateOnWriteLock</h4>
<pre>public&nbsp;boolean&nbsp;getVersionUpdateOnWriteLock()</pre>
<div class="block">Whether or not we should force an update to the version at commit
time when a write lock is requested. Defaults to true.</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="class-use/VersionLockManager.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/kernel/UUIDType4StringSeq.html" title="class in org.apache.openjpa.kernel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/kernel/VersionLockManager.html" target="_top">Frames</a></li>
<li><a href="VersionLockManager.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="#fields.inherited.from.class.org.apache.openjpa.kernel.AbstractLockManager">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>Field&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; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>