| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_79) on Mon Mar 21 21:59:40 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>LockManager (OpenJPA Parent POM 2.4.1 API)</title> |
| <meta name="date" content="2016-03-21"> |
| <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="LockManager (OpenJPA Parent POM 2.4.1 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/LockManager.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/LockLevels.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/LockScopes.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/LockManager.html" target="_top">Frames</a></li> |
| <li><a href="LockManager.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">org.apache.openjpa.kernel</div> |
| <h2 title="Interface LockManager" class="title">Interface LockManager</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></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/openjpa/jdbc/kernel/JDBCLockManager.html" title="interface in org.apache.openjpa.jdbc.kernel">JDBCLockManager</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html" title="class in org.apache.openjpa.kernel">AbstractLockManager</a>, <a href="../../../../org/apache/openjpa/jdbc/kernel/MixedLockManager.html" title="class in org.apache.openjpa.jdbc.kernel">MixedLockManager</a>, <a href="../../../../org/apache/openjpa/kernel/NoneLockManager.html" title="class in org.apache.openjpa.kernel">NoneLockManager</a>, <a href="../../../../org/apache/openjpa/jdbc/kernel/PessimisticLockManager.html" title="class in org.apache.openjpa.jdbc.kernel">PessimisticLockManager</a>, <a href="../../../../org/apache/openjpa/kernel/VersionLockManager.html" title="class in org.apache.openjpa.kernel">VersionLockManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">LockManager</span> |
| extends <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></pre> |
| <div class="block">Handles obtaining and releasing locks on objects. The lock manager |
| generally does not have to worry about synchronization, as the context is |
| responsible for synchronizing the calls it makes to the lock manager.</div> |
| <dl><dt><span class="strong">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.LockLevels"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface 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"> </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/kernel/LockManager.html#beginTransaction()">beginTransaction</a></strong>()</code> |
| <div class="block">Notification that a transaction is beginning.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/LockManager.html#close()">close</a></strong>()</code> |
| <div class="block">Free any resources.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/LockManager.html#endTransaction()">endTransaction</a></strong>()</code> |
| <div class="block">Notification that the current transaction has ended.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/LockManager.html#getLockLevel(org.apache.openjpa.kernel.OpenJPAStateManager)">getLockLevel</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm)</code> |
| <div class="block">Return the lock level of the specified instance, or |
| <a href="../../../../org/apache/openjpa/kernel/LockLevels.html#LOCK_NONE"><code>LockLevels.LOCK_NONE</code></a> if not locked.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/LockManager.html#lock(org.apache.openjpa.kernel.OpenJPAStateManager,%20int,%20int,%20java.lang.Object)">lock</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| int level, |
| int timeout, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> sdata)</code> |
| <div class="block">Obtain a lock on the specified object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/LockManager.html#lockAll(java.util.Collection,%20int,%20int,%20java.lang.Object)">lockAll</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> sms, |
| int level, |
| int timeout, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> sdata)</code> |
| <div class="block">Obtain locks on the specified objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/LockManager.html#refreshLock(org.apache.openjpa.kernel.OpenJPAStateManager,%20int,%20int,%20java.lang.Object)">refreshLock</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| int level, |
| int timeout, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> 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 class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/LockManager.html#release(org.apache.openjpa.kernel.OpenJPAStateManager)">release</a></strong>(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm)</code> |
| <div class="block">Release the lock on the given object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/LockManager.html#setContext(org.apache.openjpa.kernel.StoreContext)">setContext</a></strong>(<a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</code> |
| <div class="block">Set the context this lock manager is associated with.</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="setContext(org.apache.openjpa.kernel.StoreContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContext</h4> |
| <pre>void setContext(<a href="../../../../org/apache/openjpa/kernel/StoreContext.html" title="interface in org.apache.openjpa.kernel">StoreContext</a> ctx)</pre> |
| <div class="block">Set the context this lock manager is associated with. |
| This will be invoked in the lock manager before any other methods are |
| called.</div> |
| </li> |
| </ul> |
| <a name="getLockLevel(org.apache.openjpa.kernel.OpenJPAStateManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLockLevel</h4> |
| <pre>int getLockLevel(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm)</pre> |
| <div class="block">Return the lock level of the specified instance, or |
| <a href="../../../../org/apache/openjpa/kernel/LockLevels.html#LOCK_NONE"><code>LockLevels.LOCK_NONE</code></a> if not locked.</div> |
| </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>void lock(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| int level, |
| int timeout, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> sdata)</pre> |
| <div class="block">Obtain a lock on the specified object. This method may be called when |
| a user explicitly locks an object, and is also called automatically |
| for every object accessed during a transaction. The implementation |
| must track already-locked objects, and must be optimized to return |
| quickly when the given object does not need additional locking. |
| The lock manager might use the state manager's lock object for |
| bookkeeping information.</div> |
| <dl><dt><span class="strong">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="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/util/LockException.html" title="class in org.apache.openjpa.util">LockException</a></code> - if a lock cannot be |
| obtained in the given number of milliseconds</dd><dt><span class="strong">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>void refreshLock(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm, |
| int level, |
| int timeout, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> sdata)</pre> |
| <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="lockAll(java.util.Collection, int, int, java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lockAll</h4> |
| <pre>void lockAll(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> sms, |
| int level, |
| int timeout, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> sdata)</pre> |
| <div class="block">Obtain locks on the specified objects.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/openjpa/kernel/LockManager.html#lock(org.apache.openjpa.kernel.OpenJPAStateManager,%20int,%20int,%20java.lang.Object)"><code>lock(org.apache.openjpa.kernel.OpenJPAStateManager, int, int, java.lang.Object)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="release(org.apache.openjpa.kernel.OpenJPAStateManager)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>release</h4> |
| <pre>void release(<a href="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</a> sm)</pre> |
| <div class="block">Release the lock on the given object. This method will be called |
| automatically for each state manager with a lock object set on |
| transaction completion, just before the call to <a href="../../../../org/apache/openjpa/kernel/LockManager.html#endTransaction()"><code>endTransaction()</code></a>. |
| The lock manager should null the state manager's lock object. Note |
| that some state manager may be garbage collected during a transaction; |
| thus lock managers cannot rely on this method being called for every |
| state manager.</div> |
| <dl><dt><span class="strong">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="beginTransaction()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beginTransaction</h4> |
| <pre>void beginTransaction()</pre> |
| <div class="block">Notification that a transaction is beginning. Locks are only obtained |
| within transactions, so an implementation might use this method to |
| initialize bookkeeping datastructures, etc.</div> |
| </li> |
| </ul> |
| <a name="endTransaction()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endTransaction</h4> |
| <pre>void endTransaction()</pre> |
| <div class="block">Notification that the current transaction has ended. Clear all |
| datastructures, release any left over locks, etc.</div> |
| </li> |
| </ul> |
| <a name="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <div class="block">Free any resources.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/openjpa/lib/util/Closeable.html#close()">close</a></code> in interface <code><a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></code></dd> |
| </dl> |
| </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/LockManager.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/LockLevels.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openjpa/kernel/LockScopes.html" title="interface in org.apache.openjpa.kernel"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openjpa/kernel/LockManager.html" target="_top">Frames</a></li> |
| <li><a href="LockManager.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–2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |