4.1.1/apidocs/org/apache/openjpa/kernel/VersionLockManager.html - openjpa-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang>
 <head>
 <!-- Generated by javadoc -->
 <title>VersionLockManager (OpenJPA Parent POM 4.1.1 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
 <!--[if IE]>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
 <![endif]-->
 <script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="VersionLockManager (OpenJPA Parent POM 4.1.1 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"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";
 var pathtoroot = "../../../../";
 var useModuleDirectories = true;
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.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" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <ul class="navListSearch">
 <li><label for="search">SEARCH:</label>
 <input type="text" id="search" value="search" disabled="disabled">
 <input type="reset" id="reset" value="reset" disabled="disabled">
 </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>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </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>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 id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.openjpa.kernel</a></div>
 <h2 title="Class VersionLockManager" class="title">Class VersionLockManager</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
 <li>
 <ul class="inheritance">
 <li><a href="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><code><a href="LockLevels.html" title="interface in org.apache.openjpa.kernel">LockLevels</a></code>, <code><a href="LockManager.html" title="interface in org.apache.openjpa.kernel">LockManager</a></code>, <code><a href="../lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></code></dd>
 </dl>
 <dl>
 <dt>Direct Known Subclasses:</dt>
 <dd><code><a href="../jdbc/kernel/PessimisticLockManager.html" title="class in org.apache.openjpa.jdbc.kernel">PessimisticLockManager</a></code></dd>
 </dl>
 <hr>
 <pre>public class <span class="typeNameLabel">VersionLockManager</span>
 extends <a href="AbstractLockManager.html" title="class in org.apache.openjpa.kernel">AbstractLockManager</a></pre>
 <div class="block"><a href="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 =========== -->
 <section>
 <ul class="blockList">
 <li class="blockList"><a id="field.summary">
 <!--   -->
 </a>
 <h3>Field Summary</h3>
 <ul class="blockList">
 <li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.kernel.AbstractLockManager">
 <!--   -->
 </a>
 <h3>Fields inherited from class&nbsp;org.apache.openjpa.kernel.<a href="AbstractLockManager.html" title="class in org.apache.openjpa.kernel">AbstractLockManager</a></h3>
 <code><a href="AbstractLockManager.html#ctx">ctx</a>, <a href="AbstractLockManager.html#log">log</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="fields.inherited.from.class.org.apache.openjpa.kernel.LockLevels">
 <!--   -->
 </a>
 <h3>Fields inherited from interface&nbsp;org.apache.openjpa.kernel.<a href="LockLevels.html" title="interface in org.apache.openjpa.kernel">LockLevels</a></h3>
 <code><a href="LockLevels.html#LOCK_NONE">LOCK_NONE</a>, <a href="LockLevels.html#LOCK_READ">LOCK_READ</a>, <a href="LockLevels.html#LOCK_WRITE">LOCK_WRITE</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <section>
 <ul class="blockList">
 <li class="blockList"><a id="constructor.summary">
 <!--   -->
 </a>
 <h3>Constructor Summary</h3>
 <table class="memberSummary">
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Constructor</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">VersionLockManager</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 <!-- ========== METHOD SUMMARY =========== -->
 <section>
 <ul class="blockList">
 <li class="blockList"><a id="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary">
 <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="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockLevel(org.apache.openjpa.kernel.OpenJPAStateManager)">getLockLevel</a></span>&#8203;(<a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm)</code></th>
 <td class="colLast">
 <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>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersionCheckOnReadLock()">getVersionCheckOnReadLock</a></span>()</code></th>
 <td class="colLast">
 <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>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersionUpdateOnWriteLock()">getVersionUpdateOnWriteLock</a></span>()</code></th>
 <td class="colLast">
 <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>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lock(org.apache.openjpa.kernel.OpenJPAStateManager,int,int,java.lang.Object)">lock</a></span>&#8203;(<a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
     int&nbsp;level,
     int&nbsp;timeout,
     <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;sdata)</code></th>
 <td class="colLast">
 <div class="block">Delegates to <a href="#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>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lockInternal(org.apache.openjpa.kernel.OpenJPAStateManager,int,int,java.lang.Object,boolean)">lockInternal</a></span>&#8203;(<a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
             int&nbsp;level,
             int&nbsp;timeout,
             <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;sdata,
             boolean&nbsp;postLockVersionCheck)</code></th>
 <td class="colLast">
 <div class="block">Marks the instance's transactional status in accordance with
  the settings of <a href="#getVersionCheckOnReadLock()"><code>getVersionCheckOnReadLock()</code></a>
  and <a href="#getVersionUpdateOnWriteLock()"><code>getVersionUpdateOnWriteLock()</code></a>.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#optimisticLockInternal(org.apache.openjpa.kernel.OpenJPAStateManager,int,int,java.lang.Object,boolean)">optimisticLockInternal</a></span>&#8203;(<a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
                       int&nbsp;level,
                       int&nbsp;timeout,
                       <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;sdata,
                       boolean&nbsp;postLockVersionCheck)</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refreshLock(org.apache.openjpa.kernel.OpenJPAStateManager,int,int,java.lang.Object)">refreshLock</a></span>&#8203;(<a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
            int&nbsp;level,
            int&nbsp;timeout,
            <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;sdata)</code></th>
 <td class="colLast">
 <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>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#release(org.apache.openjpa.kernel.OpenJPAStateManager)">release</a></span>&#8203;(<a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm)</code></th>
 <td class="colLast">
 <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>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLockLevel(org.apache.openjpa.kernel.OpenJPAStateManager,int)">setLockLevel</a></span>&#8203;(<a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
             int&nbsp;level)</code></th>
 <td class="colLast">
 <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>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setVersionCheckOnReadLock(boolean)">setVersionCheckOnReadLock</a></span>&#8203;(boolean&nbsp;versionCheckOnReadLock)</code></th>
 <td class="colLast">
 <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>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setVersionUpdateOnWriteLock(boolean)">setVersionUpdateOnWriteLock</a></span>&#8203;(boolean&nbsp;versionUpdateOnWriteLock)</code></th>
 <td class="colLast">
 <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 id="methods.inherited.from.class.org.apache.openjpa.kernel.AbstractLockManager">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.openjpa.kernel.<a href="AbstractLockManager.html" title="class in org.apache.openjpa.kernel">AbstractLockManager</a></h3>
 <code><a href="AbstractLockManager.html#beginTransaction()">beginTransaction</a>, <a href="AbstractLockManager.html#close()">close</a>, <a href="AbstractLockManager.html#endTransaction()">endTransaction</a>, <a href="AbstractLockManager.html#getContext()">getContext</a>, <a href="AbstractLockManager.html#lockAll(java.util.Collection,int,int,java.lang.Object)">lockAll</a>, <a href="AbstractLockManager.html#setContext(org.apache.openjpa.kernel.StoreContext)">setContext</a>, <a href="AbstractLockManager.html#skipRelationFieldLock()">skipRelationFieldLock</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <section>
 <ul class="blockList">
 <li class="blockList"><a id="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a id="&lt;init&gt;()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>VersionLockManager</h4>
 <pre>public&nbsp;VersionLockManager()</pre>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ============ METHOD DETAIL ========== -->
 <section>
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="getLockLevel(org.apache.openjpa.kernel.OpenJPAStateManager)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getLockLevel</h4>
 <pre class="methodSignature">public&nbsp;int&nbsp;getLockLevel&#8203;(<a href="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 id="setLockLevel(org.apache.openjpa.kernel.OpenJPAStateManager,int)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setLockLevel</h4>
 <pre class="methodSignature">protected&nbsp;void&nbsp;setLockLevel&#8203;(<a href="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 id="release(org.apache.openjpa.kernel.OpenJPAStateManager)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>release</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;release&#8203;(<a href="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="OpenJPAStateManager.html#setLock(java.lang.Object)"><code>OpenJPAStateManager.setLock(java.lang.Object)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="lock(org.apache.openjpa.kernel.OpenJPAStateManager,int,int,java.lang.Object)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>lock</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;lock&#8203;(<a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
                  int&nbsp;level,
                  int&nbsp;timeout,
                  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;sdata)</pre>
 <div class="block">Delegates to <a href="#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="#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="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="OpenJPAStateManager.html#setLock(java.lang.Object)"><code>OpenJPAStateManager.setLock(java.lang.Object)</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="refreshLock(org.apache.openjpa.kernel.OpenJPAStateManager,int,int,java.lang.Object)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>refreshLock</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;refreshLock&#8203;(<a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
                         int&nbsp;level,
                         int&nbsp;timeout,
                         <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;sdata)</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="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 id="lockInternal(org.apache.openjpa.kernel.OpenJPAStateManager,int,int,java.lang.Object,boolean)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>lockInternal</h4>
 <pre class="methodSignature">protected&nbsp;void&nbsp;lockInternal&#8203;(<a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
                             int&nbsp;level,
                             int&nbsp;timeout,
                             <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">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="#getVersionCheckOnReadLock()"><code>getVersionCheckOnReadLock()</code></a>
  and <a href="#getVersionUpdateOnWriteLock()"><code>getVersionUpdateOnWriteLock()</code></a>. Override to perform
  additional locking.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="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 id="optimisticLockInternal(org.apache.openjpa.kernel.OpenJPAStateManager,int,int,java.lang.Object,boolean)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>optimisticLockInternal</h4>
 <pre class="methodSignature">protected&nbsp;void&nbsp;optimisticLockInternal&#8203;(<a href="OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a>&nbsp;sm,
                                       int&nbsp;level,
                                       int&nbsp;timeout,
                                       <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&nbsp;sdata,
                                       boolean&nbsp;postLockVersionCheck)</pre>
 </li>
 </ul>
 <a id="setVersionCheckOnReadLock(boolean)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setVersionCheckOnReadLock</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;setVersionCheckOnReadLock&#8203;(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 id="getVersionCheckOnReadLock()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getVersionCheckOnReadLock</h4>
 <pre class="methodSignature">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 id="setVersionUpdateOnWriteLock(boolean)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setVersionUpdateOnWriteLock</h4>
 <pre class="methodSignature">public&nbsp;void&nbsp;setVersionUpdateOnWriteLock&#8203;(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 id="getVersionUpdateOnWriteLock()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>getVersionUpdateOnWriteLock</h4>
 <pre class="methodSignature">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>
 </section>
 </li>
 </ul>
 </div>
 </div>
 </main>
 <!-- ========= END OF CLASS DATA ========= -->
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.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" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses.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>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </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>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 id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>