| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_15) on Fri Mar 13 09:15:45 CDT 2009 --> |
| <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <TITLE> |
| VersionLockManager (OpenJPA 1.2.1 API) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.openjpa.kernel.VersionLockManager class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="VersionLockManager (OpenJPA 1.2.1 API)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/VersionLockManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/openjpa/kernel/UUIDType4StringSeq.html" title="class in org.apache.openjpa.kernel"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/kernel/VersionLockManager.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="VersionLockManager.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.openjpa.kernel.AbstractLockManager">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.openjpa.kernel</FONT> |
| <BR> |
| Class VersionLockManager</H2> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/openjpa/kernel/AbstractLockManager.html" title="class in org.apache.openjpa.kernel">org.apache.openjpa.kernel.AbstractLockManager</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.openjpa.kernel.VersionLockManager</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <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><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/openjpa/jdbc/kernel/PessimisticLockManager.html" title="class in org.apache.openjpa.jdbc.kernel">PessimisticLockManager</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>VersionLockManager</B><DT>extends <A HREF="../../../../org/apache/openjpa/kernel/AbstractLockManager.html" title="class in org.apache.openjpa.kernel">AbstractLockManager</A></DL> |
| </PRE> |
| |
| <P> |
| <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. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Marc Prud'hommeaux</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TH> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.openjpa.kernel.AbstractLockManager"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Fields inherited from class org.apache.openjpa.kernel.<A HREF="../../../../org/apache/openjpa/kernel/AbstractLockManager.html" title="class in org.apache.openjpa.kernel">AbstractLockManager</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/openjpa/kernel/AbstractLockManager.html#ctx">ctx</A>, <A HREF="../../../../org/apache/openjpa/kernel/AbstractLockManager.html#log">log</A></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_org.apache.openjpa.kernel.LockLevels"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/VersionLockManager.html#VersionLockManager()">VersionLockManager</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/VersionLockManager.html#getLockLevel(org.apache.openjpa.kernel.OpenJPAStateManager)">getLockLevel</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm)</CODE> |
| |
| <BR> |
| Returns the given instance's lock level, assuming that the state's |
| lock object is a number.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/VersionLockManager.html#getVersionCheckOnReadLock()">getVersionCheckOnReadLock</A></B>()</CODE> |
| |
| <BR> |
| Whether or not we should force a version check at commit |
| time when a read lock is requested in order to verify read |
| consistency.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/VersionLockManager.html#getVersionUpdateOnWriteLock()">getVersionUpdateOnWriteLock</A></B>()</CODE> |
| |
| <BR> |
| Whether or not we should force an update to the version at commit |
| time when a write lock is requested.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/VersionLockManager.html#lock(org.apache.openjpa.kernel.OpenJPAStateManager, int, int, java.lang.Object)">lock</A></B>(<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://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> sdata)</CODE> |
| |
| <BR> |
| Delegates to <A HREF="../../../../org/apache/openjpa/kernel/VersionLockManager.html#lockInternal(org.apache.openjpa.kernel.OpenJPAStateManager, int, int, java.lang.Object)"><CODE>lockInternal(org.apache.openjpa.kernel.OpenJPAStateManager, int, int, java.lang.Object)</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.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/VersionLockManager.html#lockInternal(org.apache.openjpa.kernel.OpenJPAStateManager, int, int, java.lang.Object)">lockInternal</A></B>(<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://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> sdata)</CODE> |
| |
| <BR> |
| 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>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/VersionLockManager.html#release(org.apache.openjpa.kernel.OpenJPAStateManager)">release</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm)</CODE> |
| |
| <BR> |
| Nulls given instance's lock object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/VersionLockManager.html#setLockLevel(org.apache.openjpa.kernel.OpenJPAStateManager, int)">setLockLevel</A></B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| int level)</CODE> |
| |
| <BR> |
| Sets the given instance's lock level to the given number.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/VersionLockManager.html#setVersionCheckOnReadLock(boolean)">setVersionCheckOnReadLock</A></B>(boolean versionCheckOnReadLock)</CODE> |
| |
| <BR> |
| Whether or not we should force a version check at commit |
| time when a read lock is requested in order to verify read |
| consistency.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/openjpa/kernel/VersionLockManager.html#setVersionUpdateOnWriteLock(boolean)">setVersionUpdateOnWriteLock</A></B>(boolean versionUpdateOnWriteLock)</CODE> |
| |
| <BR> |
| Whether or not we should force an update to the version at commit |
| time when a write lock is requested.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.openjpa.kernel.AbstractLockManager"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.apache.openjpa.kernel.<A HREF="../../../../org/apache/openjpa/kernel/AbstractLockManager.html" title="class in org.apache.openjpa.kernel">AbstractLockManager</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="VersionLockManager()"><!-- --></A><H3> |
| VersionLockManager</H3> |
| <PRE> |
| public <B>VersionLockManager</B>()</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getLockLevel(org.apache.openjpa.kernel.OpenJPAStateManager)"><!-- --></A><H3> |
| getLockLevel</H3> |
| <PRE> |
| public int <B>getLockLevel</B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLockLevel(org.apache.openjpa.kernel.OpenJPAStateManager, int)"><!-- --></A><H3> |
| setLockLevel</H3> |
| <PRE> |
| protected void <B>setLockLevel</B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm, |
| int level)</PRE> |
| <DL> |
| <DD>Sets the given instance's lock level to the given number. Override |
| to store something else as the lock. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="release(org.apache.openjpa.kernel.OpenJPAStateManager)"><!-- --></A><H3> |
| release</H3> |
| <PRE> |
| public void <B>release</B>(<A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html" title="interface in org.apache.openjpa.kernel">OpenJPAStateManager</A> sm)</PRE> |
| <DL> |
| <DD>Nulls given instance's lock object. |
| <P> |
| <DD><DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setLock(java.lang.Object)"><CODE>OpenJPAStateManager.setLock(java.lang.Object)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="lock(org.apache.openjpa.kernel.OpenJPAStateManager, int, int, java.lang.Object)"><!-- --></A><H3> |
| lock</H3> |
| <PRE> |
| public void <B>lock</B>(<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://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> sdata)</PRE> |
| <DL> |
| <DD>Delegates to <A HREF="../../../../org/apache/openjpa/kernel/VersionLockManager.html#lockInternal(org.apache.openjpa.kernel.OpenJPAStateManager, int, int, java.lang.Object)"><CODE>lockInternal(org.apache.openjpa.kernel.OpenJPAStateManager, int, int, java.lang.Object)</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. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>sm</CODE> - the object to lock<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><CODE>timeout</CODE> - the timeout in milliseconds, or a negative number for |
| no timeout<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<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/openjpa/kernel/OpenJPAStateManager.html#setLock(java.lang.Object)"><CODE>OpenJPAStateManager.setLock(java.lang.Object)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="lockInternal(org.apache.openjpa.kernel.OpenJPAStateManager, int, int, java.lang.Object)"><!-- --></A><H3> |
| lockInternal</H3> |
| <PRE> |
| protected void <B>lockInternal</B>(<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://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> sdata)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| <DT><B>See Also:</B><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></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setVersionCheckOnReadLock(boolean)"><!-- --></A><H3> |
| setVersionCheckOnReadLock</H3> |
| <PRE> |
| public void <B>setVersionCheckOnReadLock</B>(boolean versionCheckOnReadLock)</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getVersionCheckOnReadLock()"><!-- --></A><H3> |
| getVersionCheckOnReadLock</H3> |
| <PRE> |
| public boolean <B>getVersionCheckOnReadLock</B>()</PRE> |
| <DL> |
| <DD>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. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setVersionUpdateOnWriteLock(boolean)"><!-- --></A><H3> |
| setVersionUpdateOnWriteLock</H3> |
| <PRE> |
| public void <B>setVersionUpdateOnWriteLock</B>(boolean versionUpdateOnWriteLock)</PRE> |
| <DL> |
| <DD>Whether or not we should force an update to the version at commit |
| time when a write lock is requested. Defaults to true. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getVersionUpdateOnWriteLock()"><!-- --></A><H3> |
| getVersionUpdateOnWriteLock</H3> |
| <PRE> |
| public boolean <B>getVersionUpdateOnWriteLock</B>()</PRE> |
| <DL> |
| <DD>Whether or not we should force an update to the version at commit |
| time when a write lock is requested. Defaults to true. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/VersionLockManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/openjpa/kernel/UUIDType4StringSeq.html" title="class in org.apache.openjpa.kernel"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/openjpa/kernel/VersionLockManager.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="VersionLockManager.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_org.apache.openjpa.kernel.AbstractLockManager">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2006-2009 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
