diff options
Diffstat (limited to 'docs/java/com/sleepycat/db/Environment.html')
| -rw-r--r-- | docs/java/com/sleepycat/db/Environment.html | 4726 |
1 files changed, 2386 insertions, 2340 deletions
diff --git a/docs/java/com/sleepycat/db/Environment.html b/docs/java/com/sleepycat/db/Environment.html index 63b8cbd8..444182ca 100644 --- a/docs/java/com/sleepycat/db/Environment.html +++ b/docs/java/com/sleepycat/db/Environment.html @@ -1,107 +1,105 @@ <!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.6.0_23) on Fri May 11 14:10:04 EDT 2012 --> -<TITLE> -Environment (Oracle - Berkeley DB Java API) -</TITLE> - -<META NAME="date" CONTENT="2012-05-11"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Feb 17 12:25:53 EST 2015 --> +<title>Environment (Oracle - Berkeley DB Java API)</title> +<meta name="date" content="2015-02-17"> +<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="Environment (Oracle - Berkeley DB Java API)"; } -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> -<HR> - - +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> <!-- ========= 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/Environment.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> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/db/Environment.html" target="_top"><B>FRAMES</B></A> - <A HREF="Environment.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<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/Environment.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 class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/db/Environment.html" target="_top">Frames</a></li> +<li><a href="Environment.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) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</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="#field_summary">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: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> <!-- ========= END OF TOP NAVBAR ========= --> - -<HR> <!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -com.sleepycat.db</FONT> -<BR> -Class Environment</H2> -<PRE> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.Environment</B> -</PRE> -<HR> -<DL> -<DT><PRE>public class <B>Environment</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> -</PRE> - -<P> -A database environment. Environments include support for some or +<div class="header"> +<div class="subTitle">com.sleepycat.db</div> +<h2 title="Class Environment" class="title">Class Environment</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.sleepycat.db.Environment</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">Environment</span> +extends java.lang.Object</pre> +<div class="block">A database environment. Environments include support for some or all of caching, locking, logging and transactions. <p> To open an existing environment with default attributes the application @@ -132,7 +130,7 @@ customize the configuration class. For example: Environment newlyCreatedEnv = new Environment(home, envConfig); </pre></blockquote> <p> -Environment handles are free-threaded unless <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setThreaded(boolean)"><CODE>EnvironmentConfig.setThreaded</CODE></A> is called to disable this before the environment is opened. +Environment handles are free-threaded unless <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setThreaded(boolean)"><code>EnvironmentConfig.setThreaded</code></a> is called to disable this before the environment is opened. <p> An <em>environment handle</em> is an Environment instance. More than one Environment instance may be created for the same physical directory, @@ -141,786 +139,749 @@ be open at one time for a given environment. <p> The Environment handle should not be closed while any other handle remains open that is using it as a reference (for example, -<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> or <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A>. Once <A HREF="../../../com/sleepycat/db/Environment.html#close()"><CODE>Environment.close</CODE></A> +<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> or <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a>. Once <a href="../../../com/sleepycat/db/Environment.html#close()"><code>Environment.close</code></a> is called, this object may not be accessed again, regardless of -whether or not it throws an exception. -<P> - -<P> -<HR> - -<P> +whether or not it throws an exception.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> <!-- =========== 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> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#EID_MASTER">EID_MASTER</A></B></CODE> - -<BR> - A special identifier for eid in - <A HREF="../../../com/sleepycat/db/Environment.html#openChannel(int)"><CODE>Environment.openChannel</CODE></A> - to create channel to send messages only to the master site.</TD> -</TR> -</TABLE> - +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#EID_MASTER">EID_MASTER</a></strong></code> +<div class="block">A special identifier for eid in + <a href="../../../com/sleepycat/db/Environment.html#openChannel(int)"><code>Environment.openChannel</code></a> + to create channel to send messages only to the master site.</div> +</td> +</tr> +</table> +</li> +</ul> <!-- ======== 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="../../../com/sleepycat/db/Environment.html#Environment(java.io.File, com.sleepycat.db.EnvironmentConfig)">Environment</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> home, - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config)</CODE> - -<BR> - Create a database environment handle.</TD> -</TR> -</TABLE> - +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/sleepycat/db/Environment.html#Environment(java.io.File,%20com.sleepycat.db.EnvironmentConfig)">Environment</a></strong>(java.io.File home, + <a href="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> config)</code> +<div class="block">Create a database environment handle.</div> +</td> +</tr> +</table> +</li> +</ul> <!-- ========== 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> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#backup(java.lang.String, com.sleepycat.db.BackupOptions)">backup</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> target, - <A HREF="../../../com/sleepycat/db/BackupOptions.html" title="class in com.sleepycat.db">BackupOptions</A> opt)</CODE> - -<BR> - Perform a hot back up of the open environment.</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="../../../com/sleepycat/db/Environment.html#backupDatabase(java.lang.String, java.lang.String, boolean)">backupDatabase</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> dbfile, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> target, - boolean exclusiveCreate)</CODE> - -<BR> - Perform a hot back up of a single database file contained within the environment.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#beginCDSGroup()">beginCDSGroup</A></B>()</CODE> - -<BR> - Allocate a locker ID in an environment configured for Berkeley DB - Concurrent Data Store applications.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)">beginTransaction</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> parent, - <A HREF="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</A> config)</CODE> - -<BR> - Create a new transaction in the database environment.</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="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)">checkpoint</A></B>(<A HREF="../../../com/sleepycat/db/CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</A> config)</CODE> - -<BR> - Synchronously checkpoint the database environment.</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="../../../com/sleepycat/db/Environment.html#close()">close</A></B>()</CODE> - -<BR> - Close the database environment, freeing any allocated resources and - closing any underlying subsystems.</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="../../../com/sleepycat/db/Environment.html#closeForceSync()">closeForceSync</A></B>()</CODE> - -<BR> - Close the database environment, freeing any allocated resources and - closing any underlying subsystems.</TD> -</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="../../../com/sleepycat/db/Environment.html#createLockerID()">createLockerID</A></B>()</CODE> - -<BR> - Allocate a locker ID.</TD> -</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="../../../com/sleepycat/db/Environment.html#detectDeadlocks(com.sleepycat.db.LockDetectMode)">detectDeadlocks</A></B>(<A HREF="../../../com/sleepycat/db/LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</A> mode)</CODE> - -<BR> - Run one iteration of the deadlock detector.</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="../../../com/sleepycat/db/Environment.html#electReplicationMaster(int, int)">electReplicationMaster</A></B>(int nsites, - int nvotes)</CODE> - -<BR> - Hold an election for the master of a replication group.</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="../../../com/sleepycat/db/Environment.html#flushReplication()">flushReplication</A></B>()</CODE> - -<BR> - Internal method: re-push the last log record to all clients, in case they've - lost messages and don't know it.</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="../../../com/sleepycat/db/Environment.html#freeLockerID(int)">freeLockerID</A></B>(int id)</CODE> - -<BR> - Free a locker ID.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getArchiveDatabases()">getArchiveDatabases</A></B>()</CODE> - -<BR> - Return the database files that need to be archived in order to recover the - database from catastrophic failure.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getArchiveLogFiles(boolean)">getArchiveLogFiles</A></B>(boolean includeInUse)</CODE> - -<BR> - Return an array of log files.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/CacheFileStats.html" title="class in com.sleepycat.db">CacheFileStats</A>[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getCacheFileStats(com.sleepycat.db.StatsConfig)">getCacheFileStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> - -<BR> - Return statistics for individual files in the cache.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/CacheStats.html" title="class in com.sleepycat.db">CacheStats</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getCacheStats(com.sleepycat.db.StatsConfig)">getCacheStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> - -<BR> - Returns the memory pool (that is, the buffer cache) subsystem statistics.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getConfig()">getConfig</A></B>()</CODE> - -<BR> - Return this object's configuration.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getHome()">getHome</A></B>()</CODE> - -<BR> - Return the database environment home directory.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getLock(int, boolean, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockRequestMode)">getLock</A></B>(int locker, - boolean noWait, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> object, - <A HREF="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</A> mode)</CODE> - -<BR> - Acquire a lock from the lock table returning information about it in the Lock parameter.</TD> -</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="../../../com/sleepycat/db/Environment.html#getLockerPriority(int)">getLockerPriority</A></B>(int id)</CODE> - -<BR> - Return the deadlock priority for the given locker.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/LockStats.html" title="class in com.sleepycat.db">LockStats</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getLockStats(com.sleepycat.db.StatsConfig)">getLockStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> - -<BR> - Return the database environment's locking statistics.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getLogFileName(com.sleepycat.db.LogSequenceNumber)">getLogFileName</A></B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> lsn)</CODE> - -<BR> - Return the name of the log file that contains the log record - specified by a LogSequenceNumber object.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/LogStats.html" title="class in com.sleepycat.db">LogStats</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getLogStats(com.sleepycat.db.StatsConfig)">getLogStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> - -<BR> - Return the database environment's logging statistics.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/MutexStats.html" title="class in com.sleepycat.db">MutexStats</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getMutexStats(com.sleepycat.db.StatsConfig)">getMutexStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> - -<BR> - Return the database environment's mutex statistics.</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="../../../com/sleepycat/db/Environment.html#getReplicationConfig(com.sleepycat.db.ReplicationConfig)">getReplicationConfig</A></B>(<A HREF="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</A> config)</CODE> - -<BR> - Get the configuration of the replication subsystem.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getReplicationManagerLocalSite()">getReplicationManagerLocalSite</A></B>()</CODE> - -<BR> - Return a handle for the local replication site.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getReplicationManagerSite(int)">getReplicationManagerSite</A></B>(int eid)</CODE> - -<BR> - Return a site known to the replication manager by its eid.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getReplicationManagerSite(java.lang.String, long)">getReplicationManagerSite</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> host, - long port)</CODE> - -<BR> - Return a site in the replication manager by its host and port.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/ReplicationManagerSiteInfo.html" title="class in com.sleepycat.db">ReplicationManagerSiteInfo</A>[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getReplicationManagerSiteList()">getReplicationManagerSiteList</A></B>()</CODE> - -<BR> - Return an array of all the sites known to the replication manager.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/ReplicationManagerStats.html" title="class in com.sleepycat.db">ReplicationManagerStats</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getReplicationManagerStats(com.sleepycat.db.StatsConfig)">getReplicationManagerStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> - -<BR> - Return the database environment's replication manager statistics.</TD> -</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="../../../com/sleepycat/db/Environment.html#getReplicationNumSites()">getReplicationNumSites</A></B>()</CODE> - -<BR> - Get the number of sites in a replication group.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/ReplicationStats.html" title="class in com.sleepycat.db">ReplicationStats</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getReplicationStats(com.sleepycat.db.StatsConfig)">getReplicationStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> - -<BR> - Return the database environment's replication statistics.</TD> -</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="../../../com/sleepycat/db/Environment.html#getReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType)">getReplicationTimeout</A></B>(<A HREF="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</A> type)</CODE> - -<BR> - Gets the timeout applied to the specified timeout type.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/TransactionStats.html" title="class in com.sleepycat.db">TransactionStats</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getTransactionStats(com.sleepycat.db.StatsConfig)">getTransactionStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> - -<BR> - Return the database environment's transactional statistics.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionFamily()">getVersionFamily</A></B>()</CODE> - -<BR> - Return the release's Oracle family number.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionFullString()">getVersionFullString</A></B>()</CODE> - -<BR> - Return the full release version information, suitable for display.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionMajor()">getVersionMajor</A></B>()</CODE> - -<BR> - Return the release major number.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionMinor()">getVersionMinor</A></B>()</CODE> - -<BR> - Return the release minor number.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionPatch()">getVersionPatch</A></B>()</CODE> - -<BR> - Return the release patch number.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionRelease()">getVersionRelease</A></B>()</CODE> - -<BR> - Return the release's Oracle release number.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionString()">getVersionString</A></B>()</CODE> - -<BR> - Return the release version information, suitable for display.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/TransactionStatus.html" title="class in com.sleepycat.db">TransactionStatus</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#isTransactionApplied(byte[], int)">isTransactionApplied</A></B>(byte[] token, - int maxwait)</CODE> - -<BR> - Return whether the transaction referred to by the commit token "token" has -been applied at the local replication environment.</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="../../../com/sleepycat/db/Environment.html#lockVector(int, boolean, com.sleepycat.db.LockRequest[])">lockVector</A></B>(int locker, - boolean noWait, - <A HREF="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db">LockRequest</A>[] list)</CODE> - -<BR> - Atomically obtain and release one or more locks from the lock table.</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="../../../com/sleepycat/db/Environment.html#logFlush(com.sleepycat.db.LogSequenceNumber)">logFlush</A></B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> lsn)</CODE> - -<BR> - Flush log records to stable storage.</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="../../../com/sleepycat/db/Environment.html#logPrint(com.sleepycat.db.Transaction, java.lang.String)">logPrint</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message)</CODE> - -<BR> - Append an informational message to the Berkeley DB database environment log files.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#logPut(com.sleepycat.db.DatabaseEntry, boolean)">logPut</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, - boolean flush)</CODE> - -<BR> - Append a record to the log.</TD> -</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="../../../com/sleepycat/db/Environment.html#logVerify(com.sleepycat.db.LogVerifyConfig)">logVerify</A></B>(<A HREF="../../../com/sleepycat/db/LogVerifyConfig.html" title="class in com.sleepycat.db">LogVerifyConfig</A> config)</CODE> - -<BR> - Verify integrity of the log records of an environment and write both error and - normal messages to the environment's error report destination.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/ReplicationChannel.html" title="class in com.sleepycat.db">ReplicationChannel</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#openChannel(int)">openChannel</A></B>(int eid)</CODE> - -<BR> - Create a channel.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)">openDatabase</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, - <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> config)</CODE> - -<BR> - Open a database.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/LogCursor.html" title="class in com.sleepycat.db">LogCursor</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#openLogCursor()">openLogCursor</A></B>()</CODE> - -<BR> - Return a log cursor.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#openSecondaryDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.Database, com.sleepycat.db.SecondaryConfig)">openSecondaryDatabase</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, - <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> primaryDatabase, - <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A> config)</CODE> - -<BR> - Open a database.</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="../../../com/sleepycat/db/Environment.html#panic(boolean)">panic</A></B>(boolean onoff)</CODE> - -<BR> - Set the panic state for the database environment.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/ReplicationStatus.html" title="class in com.sleepycat.db">ReplicationStatus</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)">processReplicationMessage</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> control, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> rec, - int envid)</CODE> - -<BR> - Process an incoming replication message sent by a member of the - replication group to the local database environment.</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="../../../com/sleepycat/db/Environment.html#putLock(com.sleepycat.db.Lock)">putLock</A></B>(<A HREF="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</A> lock)</CODE> - -<BR> - Release a lock.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/PreparedTransaction.html" title="class in com.sleepycat.db">PreparedTransaction</A>[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#recover(int, boolean)">recover</A></B>(int count, - boolean continued)</CODE> - -<BR> - Environment recovery restores transactions that were prepared, but not yet +<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="../../../com/sleepycat/db/Environment.html#backup(java.lang.String,%20com.sleepycat.db.BackupOptions)">backup</a></strong>(java.lang.String target, + <a href="../../../com/sleepycat/db/BackupOptions.html" title="class in com.sleepycat.db">BackupOptions</a> opt)</code> +<div class="block">Perform a hot back up of the open environment.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#backupDatabase(java.lang.String,%20java.lang.String,%20boolean)">backupDatabase</a></strong>(java.lang.String dbfile, + java.lang.String target, + boolean exclusiveCreate)</code> +<div class="block">Perform a hot back up of a single database file contained within the environment.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#beginCDSGroup()">beginCDSGroup</a></strong>()</code> +<div class="block">Allocate a locker ID in an environment configured for Berkeley DB + Concurrent Data Store applications.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction,%20com.sleepycat.db.TransactionConfig)">beginTransaction</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> parent, + <a href="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</a> config)</code> +<div class="block">Create a new transaction in the database environment.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)">checkpoint</a></strong>(<a href="../../../com/sleepycat/db/CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</a> config)</code> +<div class="block">Synchronously checkpoint the database environment.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#close()">close</a></strong>()</code> +<div class="block">Close the database environment, freeing any allocated resources and + closing any underlying subsystems.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#closeForceSync()">closeForceSync</a></strong>()</code> +<div class="block">Close the database environment, freeing any allocated resources and + closing any underlying subsystems.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#closeForceSyncAndForceSyncEnv()">closeForceSyncAndForceSyncEnv</a></strong>()</code> +<div class="block">Close the database environment, freeing any allocated resources and + closing any underlying subsystems.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#closeForceSyncEnv()">closeForceSyncEnv</a></strong>()</code> +<div class="block">Close the database environment, freeing any allocated resources and + closing any underlying subsystems.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#createLockerID()">createLockerID</a></strong>()</code> +<div class="block">Allocate a locker ID.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#detectDeadlocks(com.sleepycat.db.LockDetectMode)">detectDeadlocks</a></strong>(<a href="../../../com/sleepycat/db/LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</a> mode)</code> +<div class="block">Run one iteration of the deadlock detector.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#electReplicationMaster(int,%20int)">electReplicationMaster</a></strong>(int nsites, + int nvotes)</code> +<div class="block">Hold an election for the master of a replication group.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#flushReplication()">flushReplication</a></strong>()</code> +<div class="block">Internal method: re-push the last log record to all clients, in case they've + lost messages and don't know it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#freeLockerID(int)">freeLockerID</a></strong>(int id)</code> +<div class="block">Free a locker ID.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.File[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getArchiveDatabases()">getArchiveDatabases</a></strong>()</code> +<div class="block">Return the database files that need to be archived in order to recover the + database from catastrophic failure.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getArchiveLogFiles(boolean)">getArchiveLogFiles</a></strong>(boolean includeInUse)</code> +<div class="block">Return an array of log files.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/CacheFileStats.html" title="class in com.sleepycat.db">CacheFileStats</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getCacheFileStats(com.sleepycat.db.StatsConfig)">getCacheFileStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Return statistics for individual files in the cache.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/CacheStats.html" title="class in com.sleepycat.db">CacheStats</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getCacheStats(com.sleepycat.db.StatsConfig)">getCacheStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Returns the memory pool (that is, the buffer cache) subsystem statistics.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getConfig()">getConfig</a></strong>()</code> +<div class="block">Return this object's configuration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getHome()">getHome</a></strong>()</code> +<div class="block">Return the database environment home directory.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getLock(int,%20boolean,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.LockRequestMode)">getLock</a></strong>(int locker, + boolean noWait, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> object, + <a href="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> mode)</code> +<div class="block">Acquire a lock from the lock table returning information about it in the Lock parameter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getLockerPriority(int)">getLockerPriority</a></strong>(int id)</code> +<div class="block">Return the deadlock priority for the given locker.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/LockStats.html" title="class in com.sleepycat.db">LockStats</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getLockStats(com.sleepycat.db.StatsConfig)">getLockStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Return the database environment's locking statistics.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getLogFileName(com.sleepycat.db.LogSequenceNumber)">getLogFileName</a></strong>(<a href="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> lsn)</code> +<div class="block">Return the name of the log file that contains the log record + specified by a LogSequenceNumber object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/LogStats.html" title="class in com.sleepycat.db">LogStats</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getLogStats(com.sleepycat.db.StatsConfig)">getLogStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Return the database environment's logging statistics.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/MutexStats.html" title="class in com.sleepycat.db">MutexStats</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getMutexStats(com.sleepycat.db.StatsConfig)">getMutexStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Return the database environment's mutex statistics.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getReplicationConfig(com.sleepycat.db.ReplicationConfig)">getReplicationConfig</a></strong>(<a href="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> config)</code> +<div class="block">Get the configuration of the replication subsystem.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getReplicationManagerLocalSite()">getReplicationManagerLocalSite</a></strong>()</code> +<div class="block">Return a handle for the local replication site.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getReplicationManagerSite(int)">getReplicationManagerSite</a></strong>(int eid)</code> +<div class="block">Return a site known to the replication manager by its eid.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getReplicationManagerSite(java.lang.String,%20long)">getReplicationManagerSite</a></strong>(java.lang.String host, + long port)</code> +<div class="block">Return a site in the replication manager by its host and port.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/ReplicationManagerSiteInfo.html" title="class in com.sleepycat.db">ReplicationManagerSiteInfo</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getReplicationManagerSiteList()">getReplicationManagerSiteList</a></strong>()</code> +<div class="block">Return an array of all the sites known to the replication manager.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/ReplicationManagerStats.html" title="class in com.sleepycat.db">ReplicationManagerStats</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getReplicationManagerStats(com.sleepycat.db.StatsConfig)">getReplicationManagerStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Return the database environment's replication manager statistics.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getReplicationNumSites()">getReplicationNumSites</a></strong>()</code> +<div class="block">Get the number of sites in a replication group.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/ReplicationStats.html" title="class in com.sleepycat.db">ReplicationStats</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getReplicationStats(com.sleepycat.db.StatsConfig)">getReplicationStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Return the database environment's replication statistics.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType)">getReplicationTimeout</a></strong>(<a href="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</a> type)</code> +<div class="block">Gets the timeout applied to the specified timeout type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/TransactionStats.html" title="class in com.sleepycat.db">TransactionStats</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getTransactionStats(com.sleepycat.db.StatsConfig)">getTransactionStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Return the database environment's transactional statistics.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getVersionFamily()">getVersionFamily</a></strong>()</code> +<div class="block">Return the release's Oracle family number.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getVersionFullString()">getVersionFullString</a></strong>()</code> +<div class="block">Return the full release version information, suitable for display.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getVersionMajor()">getVersionMajor</a></strong>()</code> +<div class="block">Return the release major number.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getVersionMinor()">getVersionMinor</a></strong>()</code> +<div class="block">Return the release minor number.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getVersionPatch()">getVersionPatch</a></strong>()</code> +<div class="block">Return the release patch number.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getVersionRelease()">getVersionRelease</a></strong>()</code> +<div class="block">Return the release's Oracle release number.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#getVersionString()">getVersionString</a></strong>()</code> +<div class="block">Return the release version information, suitable for display.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/TransactionStatus.html" title="class in com.sleepycat.db">TransactionStatus</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#isTransactionApplied(byte[],%20int)">isTransactionApplied</a></strong>(byte[] token, + int maxwait)</code> +<div class="block">Return whether the transaction referred to by the commit token "token" has +been applied at the local replication environment.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#lockVector(int,%20boolean,%20com.sleepycat.db.LockRequest[])">lockVector</a></strong>(int locker, + boolean noWait, + <a href="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db">LockRequest</a>[] list)</code> +<div class="block">Atomically obtain and release one or more locks from the lock table.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#logFlush(com.sleepycat.db.LogSequenceNumber)">logFlush</a></strong>(<a href="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> lsn)</code> +<div class="block">Flush log records to stable storage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#logPrint(com.sleepycat.db.Transaction,%20java.lang.String)">logPrint</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + java.lang.String message)</code> +<div class="block">Append an informational message to the Berkeley DB database environment log files.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#logPut(com.sleepycat.db.DatabaseEntry,%20boolean)">logPut</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, + boolean flush)</code> +<div class="block">Append a record to the log.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#logVerify(com.sleepycat.db.LogVerifyConfig)">logVerify</a></strong>(<a href="../../../com/sleepycat/db/LogVerifyConfig.html" title="class in com.sleepycat.db">LogVerifyConfig</a> config)</code> +<div class="block">Verify integrity of the log records of an environment and write both error and + normal messages to the environment's error report destination.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/ReplicationChannel.html" title="class in com.sleepycat.db">ReplicationChannel</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#openChannel(int)">openChannel</a></strong>(int eid)</code> +<div class="block">Create a channel.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)">openDatabase</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + java.lang.String fileName, + java.lang.String databaseName, + <a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a> config)</code> +<div class="block">Open a database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/LogCursor.html" title="class in com.sleepycat.db">LogCursor</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#openLogCursor()">openLogCursor</a></strong>()</code> +<div class="block">Return a log cursor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#openSecondaryDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.Database,%20com.sleepycat.db.SecondaryConfig)">openSecondaryDatabase</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + java.lang.String fileName, + java.lang.String databaseName, + <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> primaryDatabase, + <a href="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a> config)</code> +<div class="block">Open a database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#panic(boolean)">panic</a></strong>(boolean onoff)</code> +<div class="block">Set the panic state for the database environment.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#printLockStats(com.sleepycat.db.StatsConfig)">printLockStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Print the locking subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#printLogStats(com.sleepycat.db.StatsConfig)">printLogStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Print the logging subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#printMempStats(com.sleepycat.db.StatsConfig)">printMempStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Print the cache subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#printMutexStats(com.sleepycat.db.StatsConfig)">printMutexStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Print the mutex subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#printReplicationManagerStats(com.sleepycat.db.StatsConfig)">printReplicationManagerStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Print the Replication Manager subsystem statistical information to a + specified output channel (see the setMsgfile() method for more + information), or passed to an application callback function (see the + setMsgcall() method for more information).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#printReplicationStats(com.sleepycat.db.StatsConfig)">printReplicationStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Print the replication subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#printStats(com.sleepycat.db.StatsConfig)">printStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Print environment statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#printTransactionStats(com.sleepycat.db.StatsConfig)">printTransactionStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code> +<div class="block">Print the transaction subsystem statistical information to a specified + output channel (see the setMsgfile() method for more information), or + passed to an application callback function (see the setMsgcall() method + for more information).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/ReplicationStatus.html" title="class in com.sleepycat.db">ReplicationStatus</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#processReplicationMessage(com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20int)">processReplicationMessage</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> control, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> rec, + int envid)</code> +<div class="block">Process an incoming replication message sent by a member of the + replication group to the local database environment.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#putLock(com.sleepycat.db.Lock)">putLock</a></strong>(<a href="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</a> lock)</code> +<div class="block">Release a lock.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/PreparedTransaction.html" title="class in com.sleepycat.db">PreparedTransaction</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#recover(int,%20boolean)">recover</a></strong>(int count, + boolean continued)</code> +<div class="block">Environment recovery restores transactions that were prepared, but not yet resolved at the time of the system shut down or crash, to their state prior - to the shut down or crash, including any locks previously held.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#remove(java.io.File, boolean, com.sleepycat.db.EnvironmentConfig)">remove</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> home, - boolean force, - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config)</CODE> - -<BR> - Destroy a database environment.</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="../../../com/sleepycat/db/Environment.html#removeDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String)">removeDatabase</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName)</CODE> - -<BR> - -Remove the database specified by the fileName and databaseName parameters.</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="../../../com/sleepycat/db/Environment.html#removeOldLogFiles()">removeOldLogFiles</A></B>()</CODE> - -<BR> - Remove log files that are no longer needed.</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="../../../com/sleepycat/db/Environment.html#renameDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, java.lang.String)">renameDatabase</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> newName)</CODE> - -<BR> - -Rename a database.</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="../../../com/sleepycat/db/Environment.html#replicationManagerStart(int, com.sleepycat.db.ReplicationManagerStartPolicy)">replicationManagerStart</A></B>(int nthreads, - <A HREF="../../../com/sleepycat/db/ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db">ReplicationManagerStartPolicy</A> policy)</CODE> - -<BR> - Starts the replication manager.</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="../../../com/sleepycat/db/Environment.html#resetFileID(java.lang.String, boolean)">resetFileID</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> filename, - boolean encrypted)</CODE> - -<BR> - Allows database files to be copied, and then the copy used in the same - database environment as the original.</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="../../../com/sleepycat/db/Environment.html#resetLogSequenceNumber(java.lang.String, boolean)">resetLogSequenceNumber</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> filename, - boolean encrypted)</CODE> - -<BR> - Allows database files to be moved from one transactional database - environment to another.</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="../../../com/sleepycat/db/Environment.html#setConfig(com.sleepycat.db.EnvironmentConfig)">setConfig</A></B>(<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config)</CODE> - -<BR> - Change the settings in an existing environment handle.</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="../../../com/sleepycat/db/Environment.html#setLockerPriority(int, int)">setLockerPriority</A></B>(int id, - int priority)</CODE> - -<BR> - Assign a deadlock priority to a locker.</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="../../../com/sleepycat/db/Environment.html#setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)">setReplicationConfig</A></B>(<A HREF="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</A> config, - boolean onoff)</CODE> - -<BR> - Configure the replication subsystem.</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="../../../com/sleepycat/db/Environment.html#setReplicationManagerMessageDispatch(com.sleepycat.db.ReplicationManagerMessageDispatch, int)">setReplicationManagerMessageDispatch</A></B>(<A HREF="../../../com/sleepycat/db/ReplicationManagerMessageDispatch.html" title="interface in com.sleepycat.db">ReplicationManagerMessageDispatch</A> dispatch, - int flags)</CODE> - -<BR> - Set the message dispatch function.</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="../../../com/sleepycat/db/Environment.html#setReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType, int)">setReplicationTimeout</A></B>(<A HREF="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</A> type, - int replicationTimeout)</CODE> - -<BR> - Sets the timeout applied to the specified timeout type.</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="../../../com/sleepycat/db/Environment.html#startReplication(com.sleepycat.db.DatabaseEntry, boolean)">startReplication</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> cdata, - boolean master)</CODE> - -<BR> - Configure the database environment as a client or master in a group - of replicated database environments.</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="../../../com/sleepycat/db/Environment.html#syncCache(com.sleepycat.db.LogSequenceNumber)">syncCache</A></B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> logSequenceNumber)</CODE> - -<BR> - Ensure that all modified pages in the cache are flushed to their backing files.</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="../../../com/sleepycat/db/Environment.html#syncReplication()">syncReplication</A></B>()</CODE> - -<BR> - Forces master synchronization to begin for this client.</TD> -</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="../../../com/sleepycat/db/Environment.html#trickleCacheWrite(int)">trickleCacheWrite</A></B>(int percent)</CODE> - -<BR> - Ensure that a specified percent of the pages in the shared memory - pool are clean, by writing dirty pages to their backing files.</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://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/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://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - -<P> - + to the shut down or crash, including any locks previously held.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#remove(java.io.File,%20boolean,%20com.sleepycat.db.EnvironmentConfig)">remove</a></strong>(java.io.File home, + boolean force, + <a href="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> config)</code> +<div class="block">Destroy a database environment.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#removeDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String)">removeDatabase</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + java.lang.String fileName, + java.lang.String databaseName)</code> +<div class="block"> +Remove the database specified by the fileName and databaseName parameters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#removeOldLogFiles()">removeOldLogFiles</a></strong>()</code> +<div class="block">Remove log files that are no longer needed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#renameDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20java.lang.String)">renameDatabase</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + java.lang.String fileName, + java.lang.String databaseName, + java.lang.String newName)</code> +<div class="block"> +Rename a database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#replicationManagerStart(int,%20com.sleepycat.db.ReplicationManagerStartPolicy)">replicationManagerStart</a></strong>(int nthreads, + <a href="../../../com/sleepycat/db/ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db">ReplicationManagerStartPolicy</a> policy)</code> +<div class="block">Starts the replication manager.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#resetFileID(java.lang.String,%20boolean)">resetFileID</a></strong>(java.lang.String filename, + boolean encrypted)</code> +<div class="block">Allows database files to be copied, and then the copy used in the same + database environment as the original.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#resetLogSequenceNumber(java.lang.String,%20boolean)">resetLogSequenceNumber</a></strong>(java.lang.String filename, + boolean encrypted)</code> +<div class="block">Allows database files to be moved from one transactional database + environment to another.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#setBlobThreshold(int)">setBlobThreshold</a></strong>(int value)</code> +<div class="block">Set the blob threshold size.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#setConfig(com.sleepycat.db.EnvironmentConfig)">setConfig</a></strong>(<a href="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> config)</code> +<div class="block">Change the settings in an existing environment handle.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#setLockerPriority(int,%20int)">setLockerPriority</a></strong>(int id, + int priority)</code> +<div class="block">Assign a deadlock priority to a locker.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#setMsgfile(java.io.File)">setMsgfile</a></strong>(java.io.File file)</code> +<div class="block">Sets the path of a file to store statistical information.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#setReplicationConfig(com.sleepycat.db.ReplicationConfig,%20boolean)">setReplicationConfig</a></strong>(<a href="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> config, + boolean onoff)</code> +<div class="block">Configure the replication subsystem.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#setReplicationManagerMessageDispatch(com.sleepycat.db.ReplicationManagerMessageDispatch,%20int)">setReplicationManagerMessageDispatch</a></strong>(<a href="../../../com/sleepycat/db/ReplicationManagerMessageDispatch.html" title="interface in com.sleepycat.db">ReplicationManagerMessageDispatch</a> dispatch, + int flags)</code> +<div class="block">Set the message dispatch function.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#setReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType,%20int)">setReplicationTimeout</a></strong>(<a href="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</a> type, + int replicationTimeout)</code> +<div class="block">Sets the timeout applied to the specified timeout type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#startReplication(com.sleepycat.db.DatabaseEntry,%20boolean)">startReplication</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> cdata, + boolean master)</code> +<div class="block">Configure the database environment as a client or master in a group + of replicated database environments.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#syncCache(com.sleepycat.db.LogSequenceNumber)">syncCache</a></strong>(<a href="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> logSequenceNumber)</code> +<div class="block">Ensure that all modified pages in the cache are flushed to their backing files.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#syncReplication()">syncReplication</a></strong>()</code> +<div class="block">Forces master synchronization to begin for this client.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Environment.html#trickleCacheWrite(int)">trickleCacheWrite</a></strong>(int percent)</code> +<div class="block">Ensure that a specified percent of the pages in the shared memory + pool are clean, by writing dirty pages to their backing files.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> <!-- ============ FIELD DETAIL =========== --> - -<A NAME="field_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>Field Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="EID_MASTER"><!-- --></A><H3> -EID_MASTER</H3> -<PRE> -public static final int <B>EID_MASTER</B></PRE> -<DL> -<DD>A special identifier for eid in - <A HREF="../../../com/sleepycat/db/Environment.html#openChannel(int)"><CODE>Environment.openChannel</CODE></A> - to create channel to send messages only to the master site. -<P> -<DL> -<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#com.sleepycat.db.Environment.EID_MASTER">Constant Field Values</A></DL> -</DL> - +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="EID_MASTER"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EID_MASTER</h4> +<pre>public static final int EID_MASTER</pre> +<div class="block">A special identifier for eid in + <a href="../../../com/sleepycat/db/Environment.html#openChannel(int)"><code>Environment.openChannel</code></a> + to create channel to send messages only to the master site.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#com.sleepycat.db.Environment.EID_MASTER">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> <!-- ========= 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="Environment(java.io.File, com.sleepycat.db.EnvironmentConfig)"><!-- --></A><H3> -Environment</H3> -<PRE> -public <B>Environment</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> home, - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> -<DL> -<DD>Create a database environment handle. - <p> -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>home</CODE> - The database environment's home directory. +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Environment(java.io.File, com.sleepycat.db.EnvironmentConfig)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Environment</h4> +<pre>public Environment(java.io.File home, + <a href="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>, + java.io.FileNotFoundException</pre> +<div class="block">Create a database environment handle. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>home</code> - The database environment's home directory. The environment variable <code>DB_HOME</code> may be used as the path of the database home. For more information on <code>envHome</code> and filename resolution in general, see <a href="../../../../programmer_reference/env_naming.html" target="_top">File Naming</a>. - <p><DD><CODE>config</CODE> - The database environment attributes. If null, default attributes are used. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. - <p> - <p> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> -</DL> - + <p></dd><dd><code>config</code> - The database environment attributes. If null, default attributes are used. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. + <p> + <p></dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd> +<dd><code>java.io.FileNotFoundException</code></dd></dl> +</li> +</ul> +</li> +</ul> <!-- ============ 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="close()"><!-- --></A><H3> -close</H3> -<PRE> -public void <B>close</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Close the database environment, freeing any allocated resources and +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Close the database environment, freeing any allocated resources and closing any underlying subsystems. <p> When you call this method, all open database and cursor handles are closed automatically, and should not be reused. <p> - The <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle should not be closed while any other + The <a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle should not be closed while any other handle that refers to it is not yet closed; for example, database environment handles must not be closed while transactions in the environment have not yet been committed or aborted. Specifically, this includes -<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A>, and <A HREF="../../../com/sleepycat/db/LogCursor.html" title="class in com.sleepycat.db"><CODE>LogCursor</CODE></A> +<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a>, and <a href="../../../com/sleepycat/db/LogCursor.html" title="class in com.sleepycat.db"><code>LogCursor</code></a> handles. <p> In multiple threads of control, each thread of control opens a database environment and the database handles within it. When you close each database handle using this method, by default, the database is not synchronized. To synchronize all open databases ensure that the last environment @@ -950,49 +911,77 @@ public void <B>close</B>() method. <p> After this method has been called, regardless of its return, the - <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle may not be accessed again. - <p> - <p> -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="closeForceSync()"><!-- --></A><H3> -closeForceSync</H3> -<PRE> -public void <B>closeForceSync</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Close the database environment, freeing any allocated resources and + <a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle may not be accessed again. + <p> + <p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="closeForceSync()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>closeForceSync</h4> +<pre>public void closeForceSync() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Close the database environment, freeing any allocated resources and + closing any underlying subsystems. + <p> + This function is similar to Environment.close(), except that + each open database is synchronized as it is closed.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="closeForceSyncEnv()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>closeForceSyncEnv</h4> +<pre>public void closeForceSyncEnv() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Close the database environment, freeing any allocated resources and + closing any underlying subsystems. + <p> + This function is similar to Environment.close(), except that + all memory mapped environment regions are synchronized as the + environment is closed.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="closeForceSyncAndForceSyncEnv()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>closeForceSyncAndForceSyncEnv</h4> +<pre>public void closeForceSyncAndForceSyncEnv() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Close the database environment, freeing any allocated resources and closing any underlying subsystems. <p> - This function has verify similar - behavior as Environment.close(), except the following: - When each open database handle is closed, the database is synchronized. -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="remove(java.io.File, boolean, com.sleepycat.db.EnvironmentConfig)"><!-- --></A><H3> -remove</H3> -<PRE> -public static void <B>remove</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> home, - boolean force, - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> -<DL> -<DD>Destroy a database environment. + This function is similar to Environment.close(), except that + it has the effect of both closeForceSync() and closeForceSyncEnv().</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="remove(java.io.File, boolean, com.sleepycat.db.EnvironmentConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre>public static void remove(java.io.File home, + boolean force, + <a href="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>, + java.io.FileNotFoundException</pre> +<div class="block">Destroy a database environment. <p> If the environment is not in use, the environment regions, including any backing files, are removed. Any log or database files and the @@ -1033,80 +1022,73 @@ public static void <B>remove</B>(<A HREF="http://download.oracle.com/javase/1.5. method. <p> After this method has been called, regardless of its return, the - <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle may not be + <a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle may not be accessed again. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>home</CODE> - The database environment to be removed. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>home</code> - The database environment to be removed. On Windows platforms, this argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters. - <p><DD><CODE>force</CODE> - The environment is removed, regardless of any processes that may + <p></dd><dd><code>force</code> - The environment is removed, regardless of any processes that may still using it, and no locks are acquired during this process. (Generally, the force argument is specified only when applications were unable to shut down cleanly, and there is a risk that an application may have died holding a Berkeley DB mutex or lock. <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="setConfig(com.sleepycat.db.EnvironmentConfig)"><!-- --></A><H3> -setConfig</H3> -<PRE> -public void <B>setConfig</B>(<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Change the settings in an existing environment handle. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>config</CODE> - The database environment attributes. If null, default attributes are used. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. -<p> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getConfig()"><!-- --></A><H3> -getConfig</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> <B>getConfig</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return this object's configuration. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>This object's configuration. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><!-- --></A><H3> -openDatabase</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> <B>openDatabase</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, - <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> -<DL> -<DD>Open a database. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd> +<dd><code>java.io.FileNotFoundException</code></dd></dl> +</li> +</ul> +<a name="setConfig(com.sleepycat.db.EnvironmentConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConfig</h4> +<pre>public void setConfig(<a href="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Change the settings in an existing environment handle. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The database environment attributes. If null, default attributes are used. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. +<p></dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfig</h4> +<pre>public <a href="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> getConfig() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return this object's configuration. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>This object's configuration. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openDatabase</h4> +<pre>public <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> openDatabase(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + java.lang.String fileName, + java.lang.String databaseName, + <a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>, + java.io.FileNotFoundException</pre> +<div class="block">Open a database. <p> The database is represented by the file and database parameters. <p> @@ -1119,7 +1101,7 @@ record number. The Recno format supports fixed- or variable-length records, accessed sequentially or by logical record number, and optionally backed by a flat text file. <p> -Storage and retrieval are based on key/data pairs; see <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> +Storage and retrieval are based on key/data pairs; see <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> for more information. <p> Opening a database is a relatively expensive operation, and maintaining @@ -1132,45 +1114,43 @@ null. Note that in-memory databases can only ever be shared by sharing the single database handle that created them, in circumstances where doing so is safe. The environment variable <code>TMPDIR</code> may be used as a directory in which to create temporary backing files. -<p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified, or null +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - For a transactional database, an explicit transaction may be specified, or null may be specified to use auto-commit. For a non-transactional database, null must be specified. Note that transactionally protected operations on a Database handle require that the Database handle itself be transactionally protected during its open, either with a non-null transaction handle, or by calling -<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setTransactional(boolean)"><CODE>DatabaseConfig.setTransactional</CODE></A> on the configuration object. -<p><DD><CODE>fileName</CODE> - The name of an underlying file that will be used to back the database. +<a href="../../../com/sleepycat/db/DatabaseConfig.html#setTransactional(boolean)"><code>DatabaseConfig.setTransactional</code></a> on the configuration object. +<p></dd><dd><code>fileName</code> - The name of an underlying file that will be used to back the database. On Windows platforms, this argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters. -<p><DD><CODE>databaseName</CODE> - An optional parameter that allows applications to have multiple +<p></dd><dd><code>databaseName</code> - An optional parameter that allows applications to have multiple databases in a single file. Although no databaseName parameter needs to be specified, it is an error to attempt to open a second database in a physical file that was not initially created using a databaseName parameter. Further, the databaseName parameter is not supported by the Queue format. -<p><DD><CODE>config</CODE> - The database open attributes. If null, default attributes are used. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="openSecondaryDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.Database, com.sleepycat.db.SecondaryConfig)"><!-- --></A><H3> -openSecondaryDatabase</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A> <B>openSecondaryDatabase</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, - <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> primaryDatabase, - <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> -<DL> -<DD>Open a database. +<p></dd><dd><code>config</code> - The database open attributes. If null, default attributes are used.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd> +<dd><code>java.io.FileNotFoundException</code></dd></dl> +</li> +</ul> +<a name="openSecondaryDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.Database, com.sleepycat.db.SecondaryConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openSecondaryDatabase</h4> +<pre>public <a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a> openSecondaryDatabase(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + java.lang.String fileName, + java.lang.String databaseName, + <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> primaryDatabase, + <a href="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>, + java.io.FileNotFoundException</pre> +<div class="block">Open a database. <p> The database is represented by the file and database parameters. <p> @@ -1183,7 +1163,7 @@ record number. The Recno format supports fixed- or variable-length records, accessed sequentially or by logical record number, and optionally backed by a flat text file. <p> -Storage and retrieval are based on key/data pairs; see <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> +Storage and retrieval are based on key/data pairs; see <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> for more information. <p> Opening a database is a relatively expensive operation, and maintaining @@ -1196,49 +1176,47 @@ null. Note that in-memory databases can only ever be shared by sharing the single database handle that created them, in circumstances where doing so is safe. The environment variable <code>TMPDIR</code> may be used as a directory in which to create temporary backing files. -<p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified, or null +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - For a transactional database, an explicit transaction may be specified, or null may be specified to use auto-commit. For a non-transactional database, null must be specified. Note that transactionally protected operations on a Database handle require that the Database handle itself be transactionally protected during its open, either with a non-null transaction handle, or by calling -<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setTransactional(boolean)"><CODE>DatabaseConfig.setTransactional</CODE></A> on the configuration object. -<p><DD><CODE>fileName</CODE> - The name of an underlying file that will be used to back the database. +<a href="../../../com/sleepycat/db/DatabaseConfig.html#setTransactional(boolean)"><code>DatabaseConfig.setTransactional</code></a> on the configuration object. +<p></dd><dd><code>fileName</code> - The name of an underlying file that will be used to back the database. On Windows platforms, this argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters. -<p><DD><CODE>databaseName</CODE> - An optional parameter that allows applications to have multiple +<p></dd><dd><code>databaseName</code> - An optional parameter that allows applications to have multiple databases in a single file. Although no databaseName parameter needs to be specified, it is an error to attempt to open a second database in a physical file that was not initially created using a databaseName parameter. Further, the databaseName parameter is not supported by the Queue format. -<p><DD><CODE>primaryDatabase</CODE> - a database handle for the primary database that is to be indexed. -<p><DD><CODE>config</CODE> - The secondary database open attributes. If null, default attributes are used. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="removeDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String)"><!-- --></A><H3> -removeDatabase</H3> -<PRE> -public void <B>removeDatabase</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> -<DL> -<DD><p> +<p></dd><dd><code>primaryDatabase</code> - a database handle for the primary database that is to be indexed. +<p></dd><dd><code>config</code> - The secondary database open attributes. If null, default attributes are used.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd> +<dd><code>java.io.FileNotFoundException</code></dd></dl> +</li> +</ul> +<a name="removeDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeDatabase</h4> +<pre>public void removeDatabase(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + java.lang.String fileName, + java.lang.String databaseName) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>, + java.io.FileNotFoundException</pre> +<div class="block"><p> Remove the database specified by the fileName and databaseName parameters. <p> If no database is specified, the underlying file specified is removed, incidentally removing all of the databases it contained. <p> -Applications should never remove databases with open <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> +Applications should never remove databases with open <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles, or in the case of removing a file, when any database in the file has an open handle. For example, some architectures do not permit the removal of files with open system handles. On these architectures, @@ -1250,50 +1228,48 @@ environment variable DB_HOME may be used as the path of the database environment home. <p> This method is affected by any database directory specified with -<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#addDataDir(java.io.File)"><CODE>EnvironmentConfig.addDataDir</CODE></A>, or by setting the "set_data_dir" +<a href="../../../com/sleepycat/db/EnvironmentConfig.html#addDataDir(java.io.File)"><code>EnvironmentConfig.addDataDir</code></a>, or by setting the "set_data_dir" string in the database environment's DB_CONFIG file. <p> -The <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle may not be accessed +The <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle may not be accessed again after this method is called, regardless of this method's success or failure. -<p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - If the operation is part of an application-specified transaction, the txn +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - If the operation is part of an application-specified transaction, the txn parameter is a Transaction object returned from the -<A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><CODE>Environment.beginTransaction</CODE></A> method; if the operation is part of a Berkeley DB +<a href="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction,%20com.sleepycat.db.TransactionConfig)"><code>Environment.beginTransaction</code></a> method; if the operation is part of a Berkeley DB Concurrent Data Store group, the txn parameter is a Transaction object returned -from the <A HREF="../../../com/sleepycat/db/Environment.html#beginCDSGroup()"><CODE>Environment.beginCDSGroup</CODE></A> method; otherwise null. +from the <a href="../../../com/sleepycat/db/Environment.html#beginCDSGroup()"><code>Environment.beginCDSGroup</code></a> method; otherwise null. For a transactional database, an explicit transaction may be specified, or null may be specified to use auto-commit. For a non-transactional database, null must be specified. -<p><DD><CODE>fileName</CODE> - The physical file which contains the database to be removed. +<p></dd><dd><code>fileName</code> - The physical file which contains the database to be removed. On Windows platforms, this argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters. -<p><DD><CODE>databaseName</CODE> - The database to be removed. -<p> +<p></dd><dd><code>databaseName</code> - The database to be removed. <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a +<p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. -<p> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="renameDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> -renameDatabase</H3> -<PRE> -public void <B>renameDatabase</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> newName) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> -<DL> -<DD><p> +<p></dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd> +<dd><code>java.io.FileNotFoundException</code></dd></dl> +</li> +</ul> +<a name="renameDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>renameDatabase</h4> +<pre>public void renameDatabase(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + java.lang.String fileName, + java.lang.String databaseName, + java.lang.String newName) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>, + java.io.FileNotFoundException</pre> +<div class="block"><p> Rename a database. <p> If no database name is specified, the underlying file specified is @@ -1312,252 +1288,230 @@ environment variable DB_HOME may be used as the path of the database environment home. <p> This method is affected by any database directory specified with -<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#addDataDir(java.io.File)"><CODE>EnvironmentConfig.addDataDir</CODE></A>, or by setting the "set_data_dir" +<a href="../../../com/sleepycat/db/EnvironmentConfig.html#addDataDir(java.io.File)"><code>EnvironmentConfig.addDataDir</code></a>, or by setting the "set_data_dir" string in the database environment's DB_CONFIG file. <p> -The <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle may not be accessed +The <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle may not be accessed again after this method is called, regardless of this method's success or failure. -<p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - If the operation is part of an application-specified transaction, the txn +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - If the operation is part of an application-specified transaction, the txn parameter is a Transaction object returned from the -<A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><CODE>Environment.beginTransaction</CODE></A> method; if the operation is part of a Berkeley DB +<a href="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction,%20com.sleepycat.db.TransactionConfig)"><code>Environment.beginTransaction</code></a> method; if the operation is part of a Berkeley DB Concurrent Data Store group, the txn parameter is a Transaction object returned -from the <A HREF="../../../com/sleepycat/db/Environment.html#beginCDSGroup()"><CODE>Environment.beginCDSGroup</CODE></A> method; otherwise null. +from the <a href="../../../com/sleepycat/db/Environment.html#beginCDSGroup()"><code>Environment.beginCDSGroup</code></a> method; otherwise null. For a transactional database, an explicit transaction may be specified, or null may be specified to use auto-commit. For a non-transactional database, null must be specified. -<p><DD><CODE>fileName</CODE> - The physical file which contains the database to be renamed. +<p></dd><dd><code>fileName</code> - The physical file which contains the database to be renamed. On Windows platforms, this argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters. -<p><DD><CODE>databaseName</CODE> - The database to be renamed. -<p><DD><CODE>newName</CODE> - The new name of the database or file. -<p> +<p></dd><dd><code>databaseName</code> - The database to be renamed. +<p></dd><dd><code>newName</code> - The new name of the database or file. <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a +<p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. -<p> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getHome()"><!-- --></A><H3> -getHome</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> <B>getHome</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return the database environment home directory. This directory is normally - identified in the <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> constructor. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The database environment home directory. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="trickleCacheWrite(int)"><!-- --></A><H3> -trickleCacheWrite</H3> -<PRE> -public int <B>trickleCacheWrite</B>(int percent) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Ensure that a specified percent of the pages in the shared memory +<p></dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd> +<dd><code>java.io.FileNotFoundException</code></dd></dl> +</li> +</ul> +<a name="getHome()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHome</h4> +<pre>public java.io.File getHome() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return the database environment home directory. This directory is normally + identified in the <a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> constructor. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The database environment home directory.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="trickleCacheWrite(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>trickleCacheWrite</h4> +<pre>public int trickleCacheWrite(int percent) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Ensure that a specified percent of the pages in the shared memory pool are clean, by writing dirty pages to their backing files. <p> The purpose of this method is to enable a memory pool manager to ensure that a page is always available for reading in new information without having to wait for a write. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>percent</CODE> - The percent of the pages in the cache that should be clean. - <p> -<DT><B>Returns:</B><DD>The number of pages that were written to reach the specified + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>percent</code> - The percent of the pages in the cache that should be clean. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>The number of pages that were written to reach the specified percentage. <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="detectDeadlocks(com.sleepycat.db.LockDetectMode)"><!-- --></A><H3> -detectDeadlocks</H3> -<PRE> -public int <B>detectDeadlocks</B>(<A HREF="../../../com/sleepycat/db/LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</A> mode) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Run one iteration of the deadlock detector. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="detectDeadlocks(com.sleepycat.db.LockDetectMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>detectDeadlocks</h4> +<pre>public int detectDeadlocks(<a href="../../../com/sleepycat/db/LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</a> mode) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Run one iteration of the deadlock detector. <p> The deadlock detector traverses the lock table and marks one of the participating lock requesters for rejection in each deadlock it finds. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>mode</CODE> - Which lock request(s) to reject. - <p> -<DT><B>Returns:</B><DD>The number of lock requests that were rejected. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getLock(int, boolean, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockRequestMode)"><!-- --></A><H3> -getLock</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</A> <B>getLock</B>(int locker, - boolean noWait, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> object, - <A HREF="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</A> mode) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Acquire a lock from the lock table returning information about it in the Lock parameter. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>locker</CODE> - An unsigned 32-bit integer quantity representing the entity + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mode</code> - Which lock request(s) to reject. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>The number of lock requests that were rejected. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getLock(int, boolean, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockRequestMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLock</h4> +<pre>public <a href="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</a> getLock(int locker, + boolean noWait, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> object, + <a href="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> mode) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Acquire a lock from the lock table returning information about it in the Lock parameter. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locker</code> - An unsigned 32-bit integer quantity representing the entity requesting the lock. - <p><DD><CODE>mode</CODE> - The lock mode. - <p><DD><CODE>noWait</CODE> - If a lock cannot be granted because the requested lock conflicts - with an existing lock, throw a <A HREF="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><CODE>LockNotGrantedException</CODE></A> + <p></dd><dd><code>mode</code> - The lock mode. + <p></dd><dd><code>noWait</code> - If a lock cannot be granted because the requested lock conflicts + with an existing lock, throw a <a href="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><code>LockNotGrantedException</code></a> immediately instead of waiting for the lock to become available. - <p><DD><CODE>object</CODE> - An untyped byte string that specifies the object to be locked. + <p></dd><dd><code>object</code> - An untyped byte string that specifies the object to be locked. Applications using the locking subsystem directly while also doing locking via the Berkeley DB access methods must take care not to inadvertently lock objects that happen to be equal to the unique file IDs used to lock files. <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="putLock(com.sleepycat.db.Lock)"><!-- --></A><H3> -putLock</H3> -<PRE> -public void <B>putLock</B>(<A HREF="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</A> lock) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Release a lock. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>lock</CODE> - The lock to be released. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="createLockerID()"><!-- --></A><H3> -createLockerID</H3> -<PRE> -public int <B>createLockerID</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Allocate a locker ID. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="putLock(com.sleepycat.db.Lock)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putLock</h4> +<pre>public void putLock(<a href="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</a> lock) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Release a lock. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lock</code> - The lock to be released. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="createLockerID()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLockerID</h4> +<pre>public int createLockerID() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Allocate a locker ID. <p> The locker ID is guaranteed to be unique for the database environment. <p> - Call <A HREF="../../../com/sleepycat/db/Environment.html#freeLockerID(int)"><CODE>Environment.freeLockerID</CODE></A> to return the locker ID to + Call <a href="../../../com/sleepycat/db/Environment.html#freeLockerID(int)"><code>Environment.freeLockerID</code></a> to return the locker ID to the environment when it is no longer needed. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>A locker ID. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="freeLockerID(int)"><!-- --></A><H3> -freeLockerID</H3> -<PRE> -public void <B>freeLockerID</B>(int id) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Free a locker ID. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>id</CODE> - The locker id to be freed. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getLockerPriority(int)"><!-- --></A><H3> -getLockerPriority</H3> -<PRE> -public int <B>getLockerPriority</B>(int id) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return the deadlock priority for the given locker. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>id</CODE> - The locker id - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="setLockerPriority(int, int)"><!-- --></A><H3> -setLockerPriority</H3> -<PRE> -public void <B>setLockerPriority</B>(int id, - int priority) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Assign a deadlock priority to a locker. This value is used when resolving deadlocks. The deadlock resolution algorithm will reject a + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>A locker ID.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="freeLockerID(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>freeLockerID</h4> +<pre>public void freeLockerID(int id) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Free a locker ID. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The locker id to be freed. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getLockerPriority(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockerPriority</h4> +<pre>public int getLockerPriority(int id) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return the deadlock priority for the given locker. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The locker id + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="setLockerPriority(int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLockerPriority</h4> +<pre>public void setLockerPriority(int id, + int priority) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Assign a deadlock priority to a locker. This value is used when resolving deadlocks. The deadlock resolution algorithm will reject a lock request from a locker with a lower priority before a request from a locker with a higher priority. By default, all lockers are created with a priority of 100. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>id</CODE> - The locker id to configure<DD><CODE>priority</CODE> - The priority to assign to the locker. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs</DL> -</DD> -</DL> -<HR> - -<A NAME="lockVector(int, boolean, com.sleepycat.db.LockRequest[])"><!-- --></A><H3> -lockVector</H3> -<PRE> -public void <B>lockVector</B>(int locker, - boolean noWait, - <A HREF="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db">LockRequest</A>[] list) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Atomically obtain and release one or more locks from the lock table. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The locker id to configure</dd><dd><code>priority</code> - The priority to assign to the locker. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs</dd></dl> +</li> +</ul> +<a name="lockVector(int, boolean, com.sleepycat.db.LockRequest[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>lockVector</h4> +<pre>public void lockVector(int locker, + boolean noWait, + <a href="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db">LockRequest</a>[] list) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Atomically obtain and release one or more locks from the lock table. This method is intended to support acquisition or trading of multiple locks under one lock table semaphore, as is needed for lock coupling or in multigranularity locking for lock escalation. @@ -1566,53 +1520,48 @@ public void <B>lockVector</B>(int locker, be released cannot be released, the operations before the failing operation are guaranteed to have completed successfully, and the method throws an exception. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>noWait</CODE> - If a lock cannot be granted because the requested lock conflicts - with an existing lock, throw a <A HREF="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><CODE>LockNotGrantedException</CODE></A> + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>noWait</code> - If a lock cannot be granted because the requested lock conflicts + with an existing lock, throw a <a href="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><code>LockNotGrantedException</code></a> immediately instead of waiting for the lock to become available. The index of the request that was not granted will be returned by - <A HREF="../../../com/sleepycat/db/LockNotGrantedException.html#getIndex()"><CODE>LockNotGrantedException.getIndex</CODE></A>. - <p><DD><CODE>locker</CODE> - An unsigned 32-bit integer quantity representing the entity + <a href="../../../com/sleepycat/db/LockNotGrantedException.html#getIndex()"><code>LockNotGrantedException.getIndex</code></a>. + <p></dd><dd><code>locker</code> - An unsigned 32-bit integer quantity representing the entity requesting the lock. - <p><DD><CODE>list</CODE> - An array of <A HREF="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db"><CODE>LockRequest</CODE></A> objects, listing the requested lock + <p></dd><dd><code>list</code> - An array of <a href="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db"><code>LockRequest</code></a> objects, listing the requested lock operations. <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="openLogCursor()"><!-- --></A><H3> -openLogCursor</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/LogCursor.html" title="class in com.sleepycat.db">LogCursor</A> <B>openLogCursor</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return a log cursor. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>A log cursor. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getLogFileName(com.sleepycat.db.LogSequenceNumber)"><!-- --></A><H3> -getLogFileName</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getLogFileName</B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> lsn) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return the name of the log file that contains the log record + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="openLogCursor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openLogCursor</h4> +<pre>public <a href="../../../com/sleepycat/db/LogCursor.html" title="class in com.sleepycat.db">LogCursor</a> openLogCursor() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return a log cursor. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>A log cursor. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getLogFileName(com.sleepycat.db.LogSequenceNumber)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogFileName</h4> +<pre>public java.lang.String getLogFileName(<a href="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> lsn) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return the name of the log file that contains the log record specified by a LogSequenceNumber object. <p> This mapping of LogSequenceNumber objects to files is needed for @@ -1621,55 +1570,51 @@ public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Strin restart, and the database administrator may want to archive log files to tape when they contain only log records before the earliest one needed for restart. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>lsn</CODE> - The LogSequenceNumber object for which a filename is wanted. - <p> -<DT><B>Returns:</B><DD>The name of the log file that contains the log record specified by a + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lsn</code> - The LogSequenceNumber object for which a filename is wanted. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>The name of the log file that contains the log record specified by a LogSequenceNumber object. <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. -<p> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="logVerify(com.sleepycat.db.LogVerifyConfig)"><!-- --></A><H3> -logVerify</H3> -<PRE> -public int <B>logVerify</B>(<A HREF="../../../com/sleepycat/db/LogVerifyConfig.html" title="class in com.sleepycat.db">LogVerifyConfig</A> config)</PRE> -<DL> -<DD>Verify integrity of the log records of an environment and write both error and + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. +<p></dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="logVerify(com.sleepycat.db.LogVerifyConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logVerify</h4> +<pre>public int logVerify(<a href="../../../com/sleepycat/db/LogVerifyConfig.html" title="class in com.sleepycat.db">LogVerifyConfig</a> config)</pre> +<div class="block">Verify integrity of the log records of an environment and write both error and normal messages to the environment's error report destination. This method does not perform the locking function, even in Berkeley DB environments that are configured with a locking subsystem. Because this function does not access any database files, you can call it even when the environment has other threads of control attached and running - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>config</CODE> - The LogVerifyConfig object which contains configurations for the log + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The LogVerifyConfig object which contains configurations for the log verification. - <p> -<DT><B>Returns:</B><DD>If the verification succeeds, return 0; otherwise non-zero. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>If the verification succeeds, return 0; otherwise non-zero. Error, warning and report messages are written to the environment's - error report destination.</DL> -</DD> -</DL> -<HR> - -<A NAME="startReplication(com.sleepycat.db.DatabaseEntry, boolean)"><!-- --></A><H3> -startReplication</H3> -<PRE> -public void <B>startReplication</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> cdata, - boolean master) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Configure the database environment as a client or master in a group + error report destination.</dd></dl> +</li> +</ul> +<a name="startReplication(com.sleepycat.db.DatabaseEntry, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startReplication</h4> +<pre>public void startReplication(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> cdata, + boolean master) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Configure the database environment as a client or master in a group of replicated database environments. This method is not called by most replication applications. It should only be called by Base API applications implementing their own network transport layer, explicitly holding replication group elections and @@ -1687,31 +1632,29 @@ public void <B>startReplication</B>(<A HREF="../../../com/sleepycat/db/DatabaseE <p> The enclosing database environment must already have been configured to send replication messages by calling - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setReplicationTransport(int, com.sleepycat.db.ReplicationTransport)"><CODE>EnvironmentConfig.setReplicationTransport</CODE></A>. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>cdata</CODE> - An opaque data item that is sent over the communication infrastructure + <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setReplicationTransport(int,%20com.sleepycat.db.ReplicationTransport)"><code>EnvironmentConfig.setReplicationTransport</code></a>. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cdata</code> - An opaque data item that is sent over the communication infrastructure when the client or master comes online. If no such information is useful, cdata should be null. - <p><DD><CODE>master</CODE> - Configure the environment as a replication master. If false, the + <p></dd><dd><code>master</code> - Configure the environment as a replication master. If false, the environment will be configured as as a replication client. <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="electReplicationMaster(int, int)"><!-- --></A><H3> -electReplicationMaster</H3> -<PRE> -public void <B>electReplicationMaster</B>(int nsites, - int nvotes) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Hold an election for the master of a replication group. This method is not called + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="electReplicationMaster(int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>electReplicationMaster</h4> +<pre>public void electReplicationMaster(int nsites, + int nvotes) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Hold an election for the master of a replication group. This method is not called by most replication applications. It should only be called by Base API applications implementing their own network transport layer, explicitly holding replication group elections and handling replication messages outside of the Replication Manager framework. @@ -1758,10 +1701,8 @@ when choosing a new master after a current master fails. This allows the group t When choosing a master from among a group of client sites all restarting at the same time, it makes more sense to set nsites to the total number of sites in the group, since there is no known missing site. Furthermore, in order to ensure the best choice from among sites that may take longer to boot than the local site, setting nvotes also to this same total number of sites will guarantee that every site in the group is considered. Alternatively, using the special timeout for full elections allows full participation on restart but allows election of a master if one site does not reboot and rejoin the group in a reasonable amount of time. (See the Elections section in the Berkeley DB Programmer's Reference Guide for more information.) <p> Setting nsites to lower values can increase the speed of an election, but can also result in election failure, and is usually not recommended. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>nsites</CODE> - The number of environments that the application believes are in the + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nsites</code> - The number of environments that the application believes are in the replication group. This number is used by Berkeley DB to avoid having two masters active simultaneously, even in the case of a network partition. During an election, a new master cannot be @@ -1770,87 +1711,82 @@ Setting nsites to lower values can increase the speed of an election, but can al with more than half the environments will elect a new master and continue, while the environments communicating with fewer than half the other environments will fail to find a new master. - <p><DD><CODE>nvotes</CODE> - The number of votes required by the application to successfully + <p></dd><dd><code>nvotes</code> - The number of votes required by the application to successfully elect a new master. It must be a positive integer, no greater than nsites, or 0 if the election should use a simple majority of the nsites value as the requirement. A warning is given if half or fewer votes are required to win an election as that can potentially lead to multiple masters in the face of a network partition. <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="flushReplication()"><!-- --></A><H3> -flushReplication</H3> -<PRE> -public void <B>flushReplication</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Internal method: re-push the last log record to all clients, in case they've + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="flushReplication()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flushReplication</h4> +<pre>public void flushReplication() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Internal method: re-push the last log record to all clients, in case they've lost messages and don't know it. <p> This method may not be called before the database environment is opened. <p> - <p> -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)"><!-- --></A><H3> -processReplicationMessage</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/ReplicationStatus.html" title="class in com.sleepycat.db">ReplicationStatus</A> <B>processReplicationMessage</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> control, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> rec, - int envid) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Process an incoming replication message sent by a member of the + <p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processReplicationMessage</h4> +<pre>public <a href="../../../com/sleepycat/db/ReplicationStatus.html" title="class in com.sleepycat.db">ReplicationStatus</a> processReplicationMessage(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> control, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> rec, + int envid) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Process an incoming replication message sent by a member of the replication group to the local database environment. This method is not called by most replication applications. It should only be called by Base API applications implementing their own network transport layer, explicitly holding replication group elections and handling replication messages outside of the Replication Manager framework. <p> For implementation reasons, all incoming replication messages must - be processed using the same <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle. It is not + be processed using the same <a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle. It is not required that a single thread of control process all messages, only that all threads of control processing messages use the same handle. <p> Before calling this method, the enclosing database environment must already have been opened and must already have been configured to send replication messages. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>control</CODE> - A copy of the control parameter specified by Berkeley DB on the + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>control</code> - A copy of the control parameter specified by Berkeley DB on the sending environment. - <p><DD><CODE>envid</CODE> - The local identifier that corresponds to the environment that sent + <p></dd><dd><code>envid</code> - The local identifier that corresponds to the environment that sent the message to be processed. - <p><DD><CODE>rec</CODE> - A copy of the rec parameter specified by Berkeley DB on the sending + <p></dd><dd><code>rec</code> - A copy of the rec parameter specified by Berkeley DB on the sending environment. - <p> -<DT><B>Returns:</B><DD>A <A HREF="../../../com/sleepycat/db/ReplicationStatus.html" title="class in com.sleepycat.db"><CODE>ReplicationStatus</CODE></A> object. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)"><!-- --></A><H3> -setReplicationConfig</H3> -<PRE> -public void <B>setReplicationConfig</B>(<A HREF="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</A> config, - boolean onoff) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Configure the replication subsystem. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../com/sleepycat/db/ReplicationStatus.html" title="class in com.sleepycat.db"><code>ReplicationStatus</code></a> object.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReplicationConfig</h4> +<pre>public void setReplicationConfig(<a href="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> config, + boolean onoff) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Configure the replication subsystem. <p> The database environment's replication subsystem may also be set using the environment's DB_CONFIG file. The syntax of the entry in that file is a single line @@ -1861,64 +1797,56 @@ opened, it will silently overrule configuration done before that time. <p> This method configures a database environment, including all threads of control accessing the database environment, not only the operations -performed using a specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle. +performed using a specified <a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle. <p> This method may be called at any time during the life of the application. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>config</CODE> - A replication feature to be configured.<DD><CODE>onoff</CODE> - If true, the feature is enabled, otherwise it is disabled. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getReplicationConfig(com.sleepycat.db.ReplicationConfig)"><!-- --></A><H3> -getReplicationConfig</H3> -<PRE> -public boolean <B>getReplicationConfig</B>(<A HREF="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Get the configuration of the replication subsystem. - This method may be called at any time during the life of the application. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>Whether the specified feature is enabled or disabled. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getReplicationNumSites()"><!-- --></A><H3> -getReplicationNumSites</H3> -<PRE> -public int <B>getReplicationNumSites</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Get the number of sites in a replication group. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - A replication feature to be configured.</dd><dd><code>onoff</code> - If true, the feature is enabled, otherwise it is disabled.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getReplicationConfig(com.sleepycat.db.ReplicationConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicationConfig</h4> +<pre>public boolean getReplicationConfig(<a href="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Get the configuration of the replication subsystem. + This method may be called at any time during the life of the application.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Whether the specified feature is enabled or disabled.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getReplicationNumSites()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicationNumSites</h4> +<pre>public int getReplicationNumSites() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Get the number of sites in a replication group. Applications using the replication manager API may only call this method - after replication has been started. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The number of sites in the replication group -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs</DL> -</DD> -</DL> -<HR> - -<A NAME="setReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType, int)"><!-- --></A><H3> -setReplicationTimeout</H3> -<PRE> -public void <B>setReplicationTimeout</B>(<A HREF="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</A> type, - int replicationTimeout) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Sets the timeout applied to the specified timeout type. + after replication has been started.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The number of sites in the replication group</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs</dd></dl> +</li> +</ul> +<a name="setReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReplicationTimeout</h4> +<pre>public void setReplicationTimeout(<a href="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</a> type, + int replicationTimeout) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Sets the timeout applied to the specified timeout type. This method may be called at any time during the life of the application. <p> The database environment's replication subsystem may also be configured @@ -1926,46 +1854,42 @@ public void <B>setReplicationTimeout</B>(<A HREF="../../../com/sleepycat/db/Repl file is a single line with the string "rep_set_timeout", one or more whitespace characters, and the which parameter specified as a string and the timeout specified as two parts. Because the DB_CONFIG file is read when the database environment is opened, - it will silently overrule configuration done before that time. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of timeout to set. - <p><DD><CODE>replicationTimeout</CODE> - The time in microseconds of the desired timeout. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType)"><!-- --></A><H3> -getReplicationTimeout</H3> -<PRE> -public int <B>getReplicationTimeout</B>(<A HREF="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</A> type) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Gets the timeout applied to the specified timeout type. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of timeout to retrieve. - <p> -<DT><B>Returns:</B><DD>The timeout applied to the specified timout type, in microseconds. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="syncReplication()"><!-- --></A><H3> -syncReplication</H3> -<PRE> -public void <B>syncReplication</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Forces master synchronization to begin for this client. This method is the other - half of setting <A HREF="../../../com/sleepycat/db/ReplicationConfig.html#DELAYCLIENT"><CODE>ReplicationConfig.DELAYCLIENT</CODE></A> with - <A HREF="../../../com/sleepycat/db/Environment.html#setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)"><CODE>setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)</CODE></A>. + it will silently overrule configuration done before that time.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - The type of timeout to set. + <p></dd><dd><code>replicationTimeout</code> - The time in microseconds of the desired timeout.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicationTimeout</h4> +<pre>public int getReplicationTimeout(<a href="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</a> type) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Gets the timeout applied to the specified timeout type.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - The type of timeout to retrieve. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>The timeout applied to the specified timout type, in microseconds. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="syncReplication()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>syncReplication</h4> +<pre>public void syncReplication() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Forces master synchronization to begin for this client. This method is the other + half of setting <a href="../../../com/sleepycat/db/ReplicationConfig.html#DELAYCLIENT"><code>ReplicationConfig.DELAYCLIENT</code></a> with + <a href="../../../com/sleepycat/db/Environment.html#setReplicationConfig(com.sleepycat.db.ReplicationConfig,%20boolean)"><code>setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)</code></a>. <p> When a new master is elected and the application has configured delayed synchronization, the application must choose when to perform @@ -1977,24 +1901,21 @@ public void <B>syncReplication</B>() Before calling this method, the enclosing database environment must already have been opened and must already have been configured to send replication messages. <p> - <p> -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="replicationManagerStart(int, com.sleepycat.db.ReplicationManagerStartPolicy)"><!-- --></A><H3> -replicationManagerStart</H3> -<PRE> -public void <B>replicationManagerStart</B>(int nthreads, - <A HREF="../../../com/sleepycat/db/ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db">ReplicationManagerStartPolicy</A> policy) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Starts the replication manager. + <p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="replicationManagerStart(int, com.sleepycat.db.ReplicationManagerStartPolicy)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replicationManagerStart</h4> +<pre>public void replicationManagerStart(int nthreads, + <a href="../../../com/sleepycat/db/ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db">ReplicationManagerStartPolicy</a> policy) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Starts the replication manager. <p> The replication manager is implemented inside the Berkeley DB library, it is designed to manage a replication group. This includes network @@ -2005,322 +1926,461 @@ public void <B>replicationManagerStart</B>(int nthreads, please see the "Replication Manager Getting Started Guide" included in the Berkeley DB documentation. <p> - This method may not be called before the database environment is opened. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>nthreads</CODE> - Specify the number of threads of control created and dedicated to + This method may not be called before the database environment is opened.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nthreads</code> - Specify the number of threads of control created and dedicated to processing replication messages. In addition to these message processing threads, the replication manager creates and manages a few of its own threads of control. - <p><DD><CODE>policy</CODE> - The policy defines the startup characteristics of a replication group. - See <A HREF="../../../com/sleepycat/db/ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db"><CODE>ReplicationManagerStartPolicy</CODE></A> for more information. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getReplicationManagerLocalSite()"><!-- --></A><H3> -getReplicationManagerLocalSite</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</A> <B>getReplicationManagerLocalSite</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return a handle for the local replication site. -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getReplicationManagerSiteList()"><!-- --></A><H3> -getReplicationManagerSiteList</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/ReplicationManagerSiteInfo.html" title="class in com.sleepycat.db">ReplicationManagerSiteInfo</A>[] <B>getReplicationManagerSiteList</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return an array of all the sites known to the replication manager. + <p></dd><dd><code>policy</code> - The policy defines the startup characteristics of a replication group. + See <a href="../../../com/sleepycat/db/ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db"><code>ReplicationManagerStartPolicy</code></a> for more information.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getReplicationManagerLocalSite()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicationManagerLocalSite</h4> +<pre>public <a href="../../../com/sleepycat/db/ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</a> getReplicationManagerLocalSite() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return a handle for the local replication site.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getReplicationManagerSiteList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicationManagerSiteList</h4> +<pre>public <a href="../../../com/sleepycat/db/ReplicationManagerSiteInfo.html" title="class in com.sleepycat.db">ReplicationManagerSiteInfo</a>[] getReplicationManagerSiteList() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return an array of all the sites known to the replication manager. This method may only be called after replication has been started - using the <A HREF="../../../com/sleepycat/db/Environment.html#replicationManagerStart(int, com.sleepycat.db.ReplicationManagerStartPolicy)"><CODE>replicationManagerStart</CODE></A> method. -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getReplicationManagerSite(int)"><!-- --></A><H3> -getReplicationManagerSite</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</A> <B>getReplicationManagerSite</B>(int eid) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return a site known to the replication manager by its eid. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>eid</CODE> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getReplicationManagerSite(java.lang.String, long)"><!-- --></A><H3> -getReplicationManagerSite</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</A> <B>getReplicationManagerSite</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> host, - long port) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return a site in the replication manager by its host and port. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>host</CODE> - <DD><CODE>port</CODE> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="openChannel(int)"><!-- --></A><H3> -openChannel</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/ReplicationChannel.html" title="class in com.sleepycat.db">ReplicationChannel</A> <B>openChannel</B>(int eid) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Create a channel. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>eid</CODE> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="setReplicationManagerMessageDispatch(com.sleepycat.db.ReplicationManagerMessageDispatch, int)"><!-- --></A><H3> -setReplicationManagerMessageDispatch</H3> -<PRE> -public void <B>setReplicationManagerMessageDispatch</B>(<A HREF="../../../com/sleepycat/db/ReplicationManagerMessageDispatch.html" title="interface in com.sleepycat.db">ReplicationManagerMessageDispatch</A> dispatch, - int flags) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Set the message dispatch function. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>dispatch</CODE> - Application-specific function used to handle messages sent over Replication - Manager message channels.<DD><CODE>flags</CODE> - This flag is DB_REPMGR_NEED_RESPONSE if the message requires a response. - Otherwise, it is 0. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getCacheStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> -getCacheStats</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/CacheStats.html" title="class in com.sleepycat.db">CacheStats</A> <B>getCacheStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Returns the memory pool (that is, the buffer cache) subsystem statistics. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the memory pool (that is, the buffer cache) subsystem statistics. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getCacheFileStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> -getCacheFileStats</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/CacheFileStats.html" title="class in com.sleepycat.db">CacheFileStats</A>[] <B>getCacheFileStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return statistics for individual files in the cache. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>statistics for individual files in the cache. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getLogStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> -getLogStats</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/LogStats.html" title="class in com.sleepycat.db">LogStats</A> <B>getLogStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return the database environment's logging statistics. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics attributes. If null, default attributes are used. - <p> -<DT><B>Returns:</B><DD>The database environment's logging statistics. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getReplicationStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> -getReplicationStats</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/ReplicationStats.html" title="class in com.sleepycat.db">ReplicationStats</A> <B>getReplicationStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return the database environment's replication statistics. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics attributes. If null, default attributes are used. - <p> -<DT><B>Returns:</B><DD>The database environment's replication statistics. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getReplicationManagerStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> -getReplicationManagerStats</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/ReplicationManagerStats.html" title="class in com.sleepycat.db">ReplicationManagerStats</A> <B>getReplicationManagerStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return the database environment's replication manager statistics. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics attributes. If null, default attributes are used. - <p> -<DT><B>Returns:</B><DD>The database environment's replication manager statistics. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getLockStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> -getLockStats</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/LockStats.html" title="class in com.sleepycat.db">LockStats</A> <B>getLockStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return the database environment's locking statistics. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>config</CODE> - The locking statistics attributes. If null, default attributes are used. - <p> -<DT><B>Returns:</B><DD>The database environment's locking statistics. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getMutexStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> -getMutexStats</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/MutexStats.html" title="class in com.sleepycat.db">MutexStats</A> <B>getMutexStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return the database environment's mutex statistics. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics attributes. If null, default attributes are used. - <p> -<DT><B>Returns:</B><DD>The database environment's mutex statistics. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getTransactionStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> -getTransactionStats</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/TransactionStats.html" title="class in com.sleepycat.db">TransactionStats</A> <B>getTransactionStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return the database environment's transactional statistics. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>config</CODE> - The transactional statistics attributes. If null, default attributes are used. - <p> -<DT><B>Returns:</B><DD>The database environment's transactional statistics. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="beginCDSGroup()"><!-- --></A><H3> -beginCDSGroup</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> <B>beginCDSGroup</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Allocate a locker ID in an environment configured for Berkeley DB - Concurrent Data Store applications. Returns a <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> object - that uniquely identifies the locker ID. Calling the <A HREF="../../../com/sleepycat/db/Transaction.html#commit()"><CODE>Transaction.commit()</CODE></A> method will discard the allocated locker ID. + using the <a href="../../../com/sleepycat/db/Environment.html#replicationManagerStart(int,%20com.sleepycat.db.ReplicationManagerStartPolicy)"><code>replicationManagerStart</code></a> method.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getReplicationManagerSite(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicationManagerSite</h4> +<pre>public <a href="../../../com/sleepycat/db/ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</a> getReplicationManagerSite(int eid) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return a site known to the replication manager by its eid. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>eid</code> - </dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getReplicationManagerSite(java.lang.String, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicationManagerSite</h4> +<pre>public <a href="../../../com/sleepycat/db/ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</a> getReplicationManagerSite(java.lang.String host, + long port) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return a site in the replication manager by its host and port. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>host</code> - </dd><dd><code>port</code> - </dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="openChannel(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openChannel</h4> +<pre>public <a href="../../../com/sleepycat/db/ReplicationChannel.html" title="class in com.sleepycat.db">ReplicationChannel</a> openChannel(int eid) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Create a channel. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>eid</code> - </dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="setReplicationManagerMessageDispatch(com.sleepycat.db.ReplicationManagerMessageDispatch, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReplicationManagerMessageDispatch</h4> +<pre>public void setReplicationManagerMessageDispatch(<a href="../../../com/sleepycat/db/ReplicationManagerMessageDispatch.html" title="interface in com.sleepycat.db">ReplicationManagerMessageDispatch</a> dispatch, + int flags) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Set the message dispatch function. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dispatch</code> - Application-specific function used to handle messages sent over Replication + Manager message channels.</dd><dd><code>flags</code> - This flag is DB_REPMGR_NEED_RESPONSE if the message requires a response. + Otherwise, it is 0.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getCacheStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheStats</h4> +<pre>public <a href="../../../com/sleepycat/db/CacheStats.html" title="class in com.sleepycat.db">CacheStats</a> getCacheStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Returns the memory pool (that is, the buffer cache) subsystem statistics. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the memory pool (that is, the buffer cache) subsystem statistics.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getCacheFileStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheFileStats</h4> +<pre>public <a href="../../../com/sleepycat/db/CacheFileStats.html" title="class in com.sleepycat.db">CacheFileStats</a>[] getCacheFileStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return statistics for individual files in the cache. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>statistics for individual files in the cache.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getLogStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogStats</h4> +<pre>public <a href="../../../com/sleepycat/db/LogStats.html" title="class in com.sleepycat.db">LogStats</a> getLogStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return the database environment's logging statistics. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>The database environment's logging statistics. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getReplicationStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicationStats</h4> +<pre>public <a href="../../../com/sleepycat/db/ReplicationStats.html" title="class in com.sleepycat.db">ReplicationStats</a> getReplicationStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return the database environment's replication statistics. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>The database environment's replication statistics. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getReplicationManagerStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplicationManagerStats</h4> +<pre>public <a href="../../../com/sleepycat/db/ReplicationManagerStats.html" title="class in com.sleepycat.db">ReplicationManagerStats</a> getReplicationManagerStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return the database environment's replication manager statistics. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>The database environment's replication manager statistics. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getLockStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockStats</h4> +<pre>public <a href="../../../com/sleepycat/db/LockStats.html" title="class in com.sleepycat.db">LockStats</a> getLockStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return the database environment's locking statistics. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The locking statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>The database environment's locking statistics. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getMutexStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMutexStats</h4> +<pre>public <a href="../../../com/sleepycat/db/MutexStats.html" title="class in com.sleepycat.db">MutexStats</a> getMutexStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return the database environment's mutex statistics. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>The database environment's mutex statistics. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getTransactionStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionStats</h4> +<pre>public <a href="../../../com/sleepycat/db/TransactionStats.html" title="class in com.sleepycat.db">TransactionStats</a> getTransactionStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return the database environment's transactional statistics. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The transactional statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>The database environment's transactional statistics. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="printMempStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printMempStats</h4> +<pre>public int printMempStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Print the cache subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>A non-zero error value on failure and 0 on success. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="printLogStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printLogStats</h4> +<pre>public int printLogStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Print the logging subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>A non-zero error value on failure and 0 on success. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="printReplicationStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printReplicationStats</h4> +<pre>public int printReplicationStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Print the replication subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>A non-zero error value on failure and 0 on success. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="printReplicationManagerStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printReplicationManagerStats</h4> +<pre>public int printReplicationManagerStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Print the Replication Manager subsystem statistical information to a + specified output channel (see the setMsgfile() method for more + information), or passed to an application callback function (see the + setMsgcall() method for more information). + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>A non-zero error value on failure and 0 on success. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="printLockStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printLockStats</h4> +<pre>public int printLockStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Print the locking subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>A non-zero error value on failure and 0 on success. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="printMutexStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printMutexStats</h4> +<pre>public int printMutexStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Print the mutex subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>A non-zero error value on failure and 0 on success. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="printStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printStats</h4> +<pre>public int printStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Print environment statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>A non-zero error value on failure and 0 on success. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="printTransactionStats(com.sleepycat.db.StatsConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printTransactionStats</h4> +<pre>public int printTransactionStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Print the transaction subsystem statistical information to a specified + output channel (see the setMsgfile() method for more information), or + passed to an application callback function (see the setMsgcall() method + for more information). + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>A non-zero error value on failure and 0 on success. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="beginCDSGroup()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beginCDSGroup</h4> +<pre>public <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> beginCDSGroup() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Allocate a locker ID in an environment configured for Berkeley DB + Concurrent Data Store applications. Returns a <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> object + that uniquely identifies the locker ID. Calling the <a href="../../../com/sleepycat/db/Transaction.html#commit()"><code>Transaction.commit()</code></a> method will discard the allocated locker ID. <p> See <a href="../../../../programmer_reference/cam.html#cam_intro" target="_top">Berkeley DB Concurrent Data Store applications</a> for more information about when this is required. This method may be called at any time during the life of the application. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>A transaction handle that wraps a CDS locker ID. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><!-- --></A><H3> -beginTransaction</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> <B>beginTransaction</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> parent, - <A HREF="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Create a new transaction in the database environment. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>A transaction handle that wraps a CDS locker ID.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beginTransaction</h4> +<pre>public <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> beginTransaction(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> parent, + <a href="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Create a new transaction in the database environment. <p> Transactions may only span threads if they do so serially; that is, each transaction must be active in only a single thread of control @@ -2334,81 +2394,73 @@ public <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com. and closed within a single transaction. <p> A parent transaction may not issue any Berkeley DB operations -- - except for <A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><CODE>Environment.beginTransaction</CODE></A>, - <A HREF="../../../com/sleepycat/db/Transaction.html#abort()"><CODE>Transaction.abort</CODE></A> and <A HREF="../../../com/sleepycat/db/Transaction.html#commit()"><CODE>Transaction.commit</CODE></A> -- + except for <a href="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction,%20com.sleepycat.db.TransactionConfig)"><code>Environment.beginTransaction</code></a>, + <a href="../../../com/sleepycat/db/Transaction.html#abort()"><code>Transaction.abort</code></a> and <a href="../../../com/sleepycat/db/Transaction.html#commit()"><code>Transaction.commit</code></a> -- while it has active child transactions (child transactions that have not yet been committed or aborted). - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>parent</CODE> - If the parent parameter is non-null, the new transaction will be a + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - If the parent parameter is non-null, the new transaction will be a nested transaction, with the transaction indicated by parent as its parent. Transactions may be nested to any level. In the presence of distributed transactions and two-phase commit, only the parental transaction, that is a transaction without a parent specified, - should be passed as an parameter to <A HREF="../../../com/sleepycat/db/Transaction.html#prepare(byte[])"><CODE>Transaction.prepare</CODE></A>. - <p><DD><CODE>config</CODE> - The transaction attributes. If null, default attributes are used. - <p> -<DT><B>Returns:</B><DD>The newly created transaction's handle. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="checkpoint(com.sleepycat.db.CheckpointConfig)"><!-- --></A><H3> -checkpoint</H3> -<PRE> -public void <B>checkpoint</B>(<A HREF="../../../com/sleepycat/db/CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Synchronously checkpoint the database environment. - <p> - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>config</CODE> - The checkpoint attributes. If null, default attributes are used. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="logFlush(com.sleepycat.db.LogSequenceNumber)"><!-- --></A><H3> -logFlush</H3> -<PRE> -public void <B>logFlush</B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> lsn) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Flush log records to stable storage. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>lsn</CODE> - All log records with LogSequenceNumber values less than or equal to + should be passed as an parameter to <a href="../../../com/sleepycat/db/Transaction.html#prepare(byte[])"><code>Transaction.prepare</code></a>. + <p></dd><dd><code>config</code> - The transaction attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>The newly created transaction's handle. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="checkpoint(com.sleepycat.db.CheckpointConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkpoint</h4> +<pre>public void checkpoint(<a href="../../../com/sleepycat/db/CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Synchronously checkpoint the database environment. + <p> + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The checkpoint attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="logFlush(com.sleepycat.db.LogSequenceNumber)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logFlush</h4> +<pre>public void logFlush(<a href="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> lsn) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Flush log records to stable storage. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lsn</code> - All log records with LogSequenceNumber values less than or equal to the lsn parameter are written to stable storage. If lsn is null, all records in the log are flushed. <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="logPut(com.sleepycat.db.DatabaseEntry, boolean)"><!-- --></A><H3> -logPut</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> <B>logPut</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, - boolean flush) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Append a record to the log. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>data</CODE> - The record to append to the log. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="logPut(com.sleepycat.db.DatabaseEntry, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logPut</h4> +<pre>public <a href="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> logPut(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, + boolean flush) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Append a record to the log. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - The record to append to the log. <p> The caller is responsible for providing any necessary structure to data. (For example, in a write-ahead logging protocol, the @@ -2418,64 +2470,62 @@ public <A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class i LogSequenceNumber of the previous log record for the same transaction, to support chaining back through the transaction's log records during undo.) - <p><DD><CODE>flush</CODE> - The log is forced to disk after this record is written, guaranteeing + <p></dd><dd><code>flush</code> - The log is forced to disk after this record is written, guaranteeing that all records with LogSequenceNumber values less than or equal to the one being "put" are on disk before this method returns. - <p> -<DT><B>Returns:</B><DD>The LogSequenceNumber of the put record. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="logPrint(com.sleepycat.db.Transaction, java.lang.String)"><!-- --></A><H3> -logPrint</H3> -<PRE> -public void <B>logPrint</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Append an informational message to the Berkeley DB database environment log files. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>The LogSequenceNumber of the put record. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="logPrint(com.sleepycat.db.Transaction, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logPrint</h4> +<pre>public void logPrint(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + java.lang.String message) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Append an informational message to the Berkeley DB database environment log files. <p> This method allows applications to include information in the database environment log files, for later review using the <a href="../../../../api_reference/C/db_printlog.html" target="_top">db_printlog</a> utility. This method is intended for debugging and performance tuning. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - If the logged message refers to an application-specified transaction, + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - If the logged message refers to an application-specified transaction, the <code>txn</code> parameter is a transaction handle, otherwise <code>null</code>. <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getArchiveLogFiles(boolean)"><!-- --></A><H3> -getArchiveLogFiles</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[] <B>getArchiveLogFiles</B>(boolean includeInUse) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return an array of log files. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getArchiveLogFiles(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArchiveLogFiles</h4> +<pre>public java.io.File[] getArchiveLogFiles(boolean includeInUse) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return an array of log files. <p> When Replication Manager is in use, log archiving is performed in a replication group-aware manner such that the log file status of other sites in the group is considered to determine if a log file is in use. <p> Log cursor handles (returned by the - <A HREF="../../../com/sleepycat/db/Environment.html#openLogCursor()"><CODE>openLogCursor() method</CODE></A> may + <a href="../../../com/sleepycat/db/Environment.html#openLogCursor()"><code>openLogCursor() method</code></a> may have open file descriptors for log files in the database environment. Also, the Berkeley DB interfaces to the database environment logging subsystem (for - example, <A HREF="../../../com/sleepycat/db/Environment.html#logPut(com.sleepycat.db.DatabaseEntry, boolean)"><CODE>logPut</CODE></A> and - <A HREF="../../../com/sleepycat/db/Transaction.html#abort()"><CODE>Transaction.abort</CODE></A> may allocate log + example, <a href="../../../com/sleepycat/db/Environment.html#logPut(com.sleepycat.db.DatabaseEntry,%20boolean)"><code>logPut</code></a> and + <a href="../../../com/sleepycat/db/Transaction.html#abort()"><code>Transaction.abort</code></a> may allocate log cursors and have open file descriptors for log files as well. On operating systems where filesystem related system calls (for example, rename and unlink on Windows/NT) can fail if a process has an open file descriptor for the @@ -2490,29 +2540,27 @@ public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.ht See <a href="../../../../api_reference/C/db_archive.html" target="_top">db_archive</a> for more information on database archival procedures. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>includeInUse</CODE> - if true, all log files, regardless of whether or not they + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>includeInUse</code> - if true, all log files, regardless of whether or not they are in use, are returned. Otherwise, the log files that are no longer in use (for example, that are no longer involved in active transactions), and that may safely be archived for catastrophic recovery and then removed from the system. - <p> -<DT><B>Returns:</B><DD>An array of log files -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getArchiveDatabases()"><!-- --></A><H3> -getArchiveDatabases</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[] <B>getArchiveDatabases</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return the database files that need to be archived in order to recover the + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>An array of log files</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getArchiveDatabases()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArchiveDatabases</h4> +<pre>public java.io.File[] getArchiveDatabases() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return the database files that need to be archived in order to recover the database from catastrophic failure. If any of the database files have not been accessed during the lifetime of the current log files, they will not be returned. It is also possible that some of the files referred to by the log @@ -2525,24 +2573,21 @@ public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.ht See <a href="../../../../api_reference/C/db_archive.html" target="_top">db_archive</a> for more information on database archival procedures. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>An array of database files -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="removeOldLogFiles()"><!-- --></A><H3> -removeOldLogFiles</H3> -<PRE> -public void <B>removeOldLogFiles</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Remove log files that are no longer needed. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>An array of database files</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="removeOldLogFiles()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeOldLogFiles</h4> +<pre>public void removeOldLogFiles() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Remove log files that are no longer needed. <p> Automatic log file removal is likely to make catastrophic recovery impossible. @@ -2551,24 +2596,21 @@ public void <B>removeOldLogFiles</B>() replication group-aware manner such that the log file status of other sites in the group is considered to determine if a log file is in use. <p> - <p> -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="recover(int, boolean)"><!-- --></A><H3> -recover</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/PreparedTransaction.html" title="class in com.sleepycat.db">PreparedTransaction</A>[] <B>recover</B>(int count, - boolean continued) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Environment recovery restores transactions that were prepared, but not yet + <p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="recover(int, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>recover</h4> +<pre>public <a href="../../../com/sleepycat/db/PreparedTransaction.html" title="class in com.sleepycat.db">PreparedTransaction</a>[] recover(int count, + boolean continued) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Environment recovery restores transactions that were prepared, but not yet resolved at the time of the system shut down or crash, to their state prior to the shut down or crash, including any locks previously held. This method returns a list of those prepared transactions. @@ -2578,31 +2620,28 @@ public <A HREF="../../../com/sleepycat/db/PreparedTransaction.html" title="class Multiple threads of control may call this method, but only one thread of control may resolve each returned transaction, that is, only one thread of control may call - <A HREF="../../../com/sleepycat/db/Transaction.html#commit()"><CODE>Transaction.commit()</CODE></A> or - <A HREF="../../../com/sleepycat/db/Transaction.html#abort()"><CODE>Transaction.abort()</CODE></A> each returned + <a href="../../../com/sleepycat/db/Transaction.html#commit()"><code>Transaction.commit()</code></a> or + <a href="../../../com/sleepycat/db/Transaction.html#abort()"><code>Transaction.abort()</code></a> each returned transaction. Callers must call - <A HREF="../../../com/sleepycat/db/Transaction.html#discard()"><CODE>Transaction.discard()</CODE></A> to discard + <a href="../../../com/sleepycat/db/Transaction.html#discard()"><code>Transaction.discard()</code></a> to discard each transaction they do not resolve. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>a list of <A HREF="../../../com/sleepycat/db/PreparedTransaction.html" title="class in com.sleepycat.db"><CODE>transactions</CODE></A> - that must be resolved by the application (committed, aborted or discarded). -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="resetFileID(java.lang.String, boolean)"><!-- --></A><H3> -resetFileID</H3> -<PRE> -public void <B>resetFileID</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> filename, - boolean encrypted) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Allows database files to be copied, and then the copy used in the same + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a list of <a href="../../../com/sleepycat/db/PreparedTransaction.html" title="class in com.sleepycat.db"><code>transactions</code></a> + that must be resolved by the application (committed, aborted or discarded).</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="resetFileID(java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resetFileID</h4> +<pre>public void resetFileID(java.lang.String filename, + boolean encrypted) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Allows database files to be copied, and then the copy used in the same database environment as the original. <p> All databases contain an ID string used to identify the database in the @@ -2615,25 +2654,23 @@ public void <B>resetFileID</B>(<A HREF="http://download.oracle.com/javase/1.5.0/ Applications should not reset IDs in files that are currently in use. <p> This method may be called at any time during the life of the application. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>filename</CODE> - The name of the physical file in which the LSNs are to be cleared.<DD><CODE>encrypted</CODE> - Whether the file contains encrypted databases. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="resetLogSequenceNumber(java.lang.String, boolean)"><!-- --></A><H3> -resetLogSequenceNumber</H3> -<PRE> -public void <B>resetLogSequenceNumber</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> filename, - boolean encrypted) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Allows database files to be moved from one transactional database + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - The name of the physical file in which the LSNs are to be cleared.</dd><dd><code>encrypted</code> - Whether the file contains encrypted databases. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="resetLogSequenceNumber(java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resetLogSequenceNumber</h4> +<pre>public void resetLogSequenceNumber(java.lang.String filename, + boolean encrypted) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Allows database files to be moved from one transactional database environment to another. <p> Database pages in transactional database environments contain references @@ -2653,52 +2690,48 @@ public void <B>resetLogSequenceNumber</B>(<A HREF="http://download.oracle.com/ja Applications should not reset LSNs in files that are currently in use. <p> This method may be called at any time during the life of the application. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>filename</CODE> - The name of the physical file in which the LSNs are to be cleared.<DD><CODE>encrypted</CODE> - Whether the file contains encrypted databases. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="panic(boolean)"><!-- --></A><H3> -panic</H3> -<PRE> -public void <B>panic</B>(boolean onoff) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Set the panic state for the database environment. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - The name of the physical file in which the LSNs are to be cleared.</dd><dd><code>encrypted</code> - Whether the file contains encrypted databases. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="panic(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>panic</h4> +<pre>public void panic(boolean onoff) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Set the panic state for the database environment. Database environments in a panic state normally refuse all attempts to call library functions, throwing a - <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><CODE>RunRecoveryException</CODE></A>. + <a href="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><code>RunRecoveryException</code></a>. <p> This method configures a database environment, including all threads of control accessing the database environment, not only the operations performed using a specified - <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle. + <a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle. <p> This method may be called at any time during the life of the application. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>onoff</CODE> - If true, set the panic state for the database environment. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="backup(java.lang.String, com.sleepycat.db.BackupOptions)"><!-- --></A><H3> -backup</H3> -<PRE> -public void <B>backup</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> target, - <A HREF="../../../com/sleepycat/db/BackupOptions.html" title="class in com.sleepycat.db">BackupOptions</A> opt) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Perform a hot back up of the open environment. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>onoff</code> - If true, set the panic state for the database environment.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="backup(java.lang.String, com.sleepycat.db.BackupOptions)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>backup</h4> +<pre>public void backup(java.lang.String target, + <a href="../../../com/sleepycat/db/BackupOptions.html" title="class in com.sleepycat.db">BackupOptions</a> opt) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Perform a hot back up of the open environment. <p> All files used by the environment are backed up, so long as the normal rules for file placement are followed. For information on how files @@ -2710,7 +2743,7 @@ public void <B>backup</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/ By default, data directories and the log directory specified relative to the home directory will be recreated relative to the target directory. If absolute path names are used, then - use the <A HREF="../../../com/sleepycat/db/BackupOptions.html#setSingleDir(boolean)"><CODE>BackupOptions.setSingleDir</CODE></A> + use the <a href="../../../com/sleepycat/db/BackupOptions.html#setSingleDir(boolean)"><code>BackupOptions.setSingleDir</code></a> method. <p> This method provides the same functionality as the @@ -2719,336 +2752,349 @@ public void <B>backup</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/ actions performed by that utility. In particular, you may want to run a checkpoint before calling this method. To run a checkpoint, use the - <A HREF="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)"><CODE>Environment.checkpoint</CODE></A> + <a href="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)"><code>Environment.checkpoint</code></a> method. For more information on checkpoints, see the <a href="../../../../programmer_reference/transapp_checkpoint.html" target="_top">Checkpoint</a> section in the Berkeley DB Reference Guide. <p> To back up a single database file within the environment, use the - <A HREF="../../../com/sleepycat/db/Environment.html#backupDatabase(java.lang.String, java.lang.String, boolean)"><CODE>Environment.backupDatabase</CODE></A> + <a href="../../../com/sleepycat/db/Environment.html#backupDatabase(java.lang.String,%20java.lang.String,%20boolean)"><code>Environment.backupDatabase</code></a> method. <p> In addition to the configuration options available using the - <A HREF="../../../com/sleepycat/db/BackupOptions.html" title="class in com.sleepycat.db"><CODE>BackupOptions</CODE></A> + <a href="../../../com/sleepycat/db/BackupOptions.html" title="class in com.sleepycat.db"><code>BackupOptions</code></a> class, additional tuning modifications can be made using the - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupReadCount(int)"><CODE>EnvironmentConfig.setBackupReadCount</CODE></A>, - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupReadSleep(int)"><CODE>EnvironmentConfig.setBackupReadSleep</CODE></A>, - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupSize(int)"><CODE>EnvironmentConfig.setBackupSize</CODE></A>, and - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupWriteDirect(boolean)"><CODE>EnvironmentConfig.setBackupWriteDirect</CODE></A> + <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupReadCount(int)"><code>EnvironmentConfig.setBackupReadCount</code></a>, + <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupReadSleep(int)"><code>EnvironmentConfig.setBackupReadSleep</code></a>, + <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupSize(int)"><code>EnvironmentConfig.setBackupSize</code></a>, and + <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupWriteDirect(boolean)"><code>EnvironmentConfig.setBackupWriteDirect</code></a> methods. Alternatively, you can write your own custom hot back up facility using the - <A HREF="../../../com/sleepycat/db/BackupHandler.html" title="interface in com.sleepycat.db"><CODE>BackupHandler</CODE></A> interface. + <a href="../../../com/sleepycat/db/BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a> interface. <p> This method may only be called after the environment has been opened. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>target</CODE> - Identifies the directory in which the back up will be placed. Any + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - Identifies the directory in which the back up will be placed. Any subdirectories required to contain the back up must be placed relative to this directory. Note that if a - <A HREF="../../../com/sleepycat/db/BackupHandler.html" title="interface in com.sleepycat.db"><CODE>BackupHandler</CODE></A> is configured for the + <a href="../../../com/sleepycat/db/BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a> is configured for the environment, then the value specified to this parameter is passed on to the - <A HREF="../../../com/sleepycat/db/BackupHandler.html#open(java.lang.String, java.lang.String)"><CODE>BackupHandler.open</CODE></A> + <a href="../../../com/sleepycat/db/BackupHandler.html#open(java.lang.String,%20java.lang.String)"><code>BackupHandler.open</code></a> method. If this parameter is null, then the target must be specified to the - <A HREF="../../../com/sleepycat/db/BackupHandler.html#open(java.lang.String, java.lang.String)"><CODE>BackupHandler.open</CODE></A> + <a href="../../../com/sleepycat/db/BackupHandler.html#open(java.lang.String,%20java.lang.String)"><code>BackupHandler.open</code></a> method. <p> This directory, and any required subdirectories, will be created for you if you specify true for the - <A HREF="../../../com/sleepycat/db/BackupOptions.html#setAllowCreate(boolean)"><CODE>BackupOptions.setAllowCreate</CODE></A> + <a href="../../../com/sleepycat/db/BackupOptions.html#setAllowCreate(boolean)"><code>BackupOptions.setAllowCreate</code></a> method. Otherwise, if the target does not exist, this method throws a - <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> exception. - <p><DD><CODE>opt</CODE> - The <A HREF="../../../com/sleepycat/db/BackupOptions.html" title="class in com.sleepycat.db"><CODE>BackupOptions</CODE></A> instance used to + <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> exception. + <p></dd><dd><code>opt</code> - The <a href="../../../com/sleepycat/db/BackupOptions.html" title="class in com.sleepycat.db"><code>BackupOptions</code></a> instance used to configure the hot back up. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs at any point during the back up.</DL> -</DD> -</DL> -<HR> - -<A NAME="backupDatabase(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3> -backupDatabase</H3> -<PRE> -public void <B>backupDatabase</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> dbfile, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> target, - boolean exclusiveCreate) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Perform a hot back up of a single database file contained within the environment. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs at any point during the back up.</dd></dl> +</li> +</ul> +<a name="backupDatabase(java.lang.String, java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>backupDatabase</h4> +<pre>public void backupDatabase(java.lang.String dbfile, + java.lang.String target, + boolean exclusiveCreate) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Perform a hot back up of a single database file contained within the environment. <p> To back up the entire environment, use the - <A HREF="../../../com/sleepycat/db/Environment.html#backup(java.lang.String, com.sleepycat.db.BackupOptions)"><CODE>Environment.backup</CODE></A> + <a href="../../../com/sleepycat/db/Environment.html#backup(java.lang.String,%20com.sleepycat.db.BackupOptions)"><code>Environment.backup</code></a> method. <p> You can make some tuning modifications to the backup process using the - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupReadCount(int)"><CODE>EnvironmentConfig.setBackupReadCount</CODE></A>, - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupReadSleep(int)"><CODE>EnvironmentConfig.setBackupReadSleep</CODE></A>, - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupSize(int)"><CODE>EnvironmentConfig.setBackupSize</CODE></A>, and - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupWriteDirect(boolean)"><CODE>EnvironmentConfig.setBackupWriteDirect</CODE></A> + <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupReadCount(int)"><code>EnvironmentConfig.setBackupReadCount</code></a>, + <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupReadSleep(int)"><code>EnvironmentConfig.setBackupReadSleep</code></a>, + <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupSize(int)"><code>EnvironmentConfig.setBackupSize</code></a>, and + <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setBackupWriteDirect(boolean)"><code>EnvironmentConfig.setBackupWriteDirect</code></a> methods. Alternatively, you can write your own custom hot back up facility using the - <A HREF="../../../com/sleepycat/db/BackupHandler.html" title="interface in com.sleepycat.db"><CODE>BackupHandler</CODE></A> interface. + <a href="../../../com/sleepycat/db/BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a> interface. <p> This method may only be called after the environment has been opened. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>dbfile</CODE> - The database file that you want to back up. - <p><DD><CODE>target</CODE> - Identifies the directory in which the back up will be placed. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dbfile</code> - The database file that you want to back up. + <p></dd><dd><code>target</code> - Identifies the directory in which the back up will be placed. The target must exist; otherwise this method throws a - <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> exception. + <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> exception. Note that if a - <A HREF="../../../com/sleepycat/db/BackupHandler.html" title="interface in com.sleepycat.db"><CODE>BackupHandler</CODE></A> is configured for the + <a href="../../../com/sleepycat/db/BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a> is configured for the environment, then the value specified to this parameter is passed on to the - <A HREF="../../../com/sleepycat/db/BackupHandler.html#open(java.lang.String, java.lang.String)"><CODE>BackupHandler.open</CODE></A> + <a href="../../../com/sleepycat/db/BackupHandler.html#open(java.lang.String,%20java.lang.String)"><code>BackupHandler.open</code></a> method. If this parameter is null, then the target must be specified to the - <A HREF="../../../com/sleepycat/db/BackupHandler.html#open(java.lang.String, java.lang.String)"><CODE>BackupHandler.open</CODE></A> + <a href="../../../com/sleepycat/db/BackupHandler.html#open(java.lang.String,%20java.lang.String)"><code>BackupHandler.open</code></a> method. - <p><DD><CODE>exclusiveCreate</CODE> - If true, then if the target file exists, this method throws a - <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> exception. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs at any point during the back up.</DL> -</DD> -</DL> -<HR> - -<A NAME="getVersionString()"><!-- --></A><H3> -getVersionString</H3> -<PRE> -public static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getVersionString</B>()</PRE> -<DL> -<DD>Return the release version information, suitable for display. + <p></dd><dd><code>exclusiveCreate</code> - If true, then if the target file exists, this method throws a + <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> exception. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs at any point during the back up.</dd></dl> +</li> +</ul> +<a name="getVersionString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionString</h4> +<pre>public static java.lang.String getVersionString()</pre> +<div class="block">Return the release version information, suitable for display. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The release version information, suitable for display.</DL> -</DD> -</DL> -<HR> - -<A NAME="getVersionFullString()"><!-- --></A><H3> -getVersionFullString</H3> -<PRE> -public static <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getVersionFullString</B>()</PRE> -<DL> -<DD>Return the full release version information, suitable for display. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The release version information, suitable for display.</dd></dl> +</li> +</ul> +<a name="getVersionFullString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionFullString</h4> +<pre>public static java.lang.String getVersionFullString()</pre> +<div class="block">Return the full release version information, suitable for display. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The full release version information, suitable for display.</DL> -</DD> -</DL> -<HR> - -<A NAME="getVersionFamily()"><!-- --></A><H3> -getVersionFamily</H3> -<PRE> -public static int <B>getVersionFamily</B>()</PRE> -<DL> -<DD>Return the release's Oracle family number. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The full release version information, suitable for display.</dd></dl> +</li> +</ul> +<a name="getVersionFamily()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionFamily</h4> +<pre>public static int getVersionFamily()</pre> +<div class="block">Return the release's Oracle family number. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The release's Oracle family number.</DL> -</DD> -</DL> -<HR> - -<A NAME="getVersionRelease()"><!-- --></A><H3> -getVersionRelease</H3> -<PRE> -public static int <B>getVersionRelease</B>()</PRE> -<DL> -<DD>Return the release's Oracle release number. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The release's Oracle family number.</dd></dl> +</li> +</ul> +<a name="getVersionRelease()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionRelease</h4> +<pre>public static int getVersionRelease()</pre> +<div class="block">Return the release's Oracle release number. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The release's Oracle release number.</DL> -</DD> -</DL> -<HR> - -<A NAME="getVersionMajor()"><!-- --></A><H3> -getVersionMajor</H3> -<PRE> -public static int <B>getVersionMajor</B>()</PRE> -<DL> -<DD>Return the release major number. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The release's Oracle release number.</dd></dl> +</li> +</ul> +<a name="getVersionMajor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionMajor</h4> +<pre>public static int getVersionMajor()</pre> +<div class="block">Return the release major number. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The release major number.</DL> -</DD> -</DL> -<HR> - -<A NAME="syncCache(com.sleepycat.db.LogSequenceNumber)"><!-- --></A><H3> -syncCache</H3> -<PRE> -public void <B>syncCache</B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> logSequenceNumber) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Ensure that all modified pages in the cache are flushed to their backing files. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The release major number.</dd></dl> +</li> +</ul> +<a name="syncCache(com.sleepycat.db.LogSequenceNumber)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>syncCache</h4> +<pre>public void syncCache(<a href="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> logSequenceNumber) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Ensure that all modified pages in the cache are flushed to their backing files. <p> Pages in the cache that cannot be immediately written back to disk (for example pages that are currently in use by another thread of control) are waited for and written to disk as soon as it is possible to do so. -<p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>logSequenceNumber</CODE> - The purpose of the logSequenceNumber parameter is to enable a transaction +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>logSequenceNumber</code> - The purpose of the logSequenceNumber parameter is to enable a transaction manager to ensure, as part of a checkpoint, that all pages modified by a certain time have been written to disk. <p> All modified pages with a log sequence number less than the logSequenceNumber parameter are written to disk. If logSequenceNumber is null, all modified -pages in the cache are written to disk. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="isTransactionApplied(byte[], int)"><!-- --></A><H3> -isTransactionApplied</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/TransactionStatus.html" title="class in com.sleepycat.db">TransactionStatus</A> <B>isTransactionApplied</B>(byte[] token, - int maxwait) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return whether the transaction referred to by the commit token "token" has +pages in the cache are written to disk.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="isTransactionApplied(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isTransactionApplied</h4> +<pre>public <a href="../../../com/sleepycat/db/TransactionStatus.html" title="class in com.sleepycat.db">TransactionStatus</a> isTransactionApplied(byte[] token, + int maxwait) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return whether the transaction referred to by the commit token "token" has been applied at the local replication environment. <p> This method may not be called before the database environment is opened. -<p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>maxwait</CODE> - The maximum time to wait for the transaction to arrive by replication, +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxwait</code> - The maximum time to wait for the transaction to arrive by replication, expressed in microseconds. To check the status of the transaction without waiting, the timeout may be specified as 0. -<p> -<DT><B>Returns:</B><DD>TransactionStatus indicating the status of the applicaton of the transaction. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getVersionMinor()"><!-- --></A><H3> -getVersionMinor</H3> -<PRE> -public static int <B>getVersionMinor</B>()</PRE> -<DL> -<DD>Return the release minor number. +<p></dd> +<dt><span class="strong">Returns:</span></dt><dd>TransactionStatus indicating the status of the applicaton of the transaction.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getVersionMinor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionMinor</h4> +<pre>public static int getVersionMinor()</pre> +<div class="block">Return the release minor number. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The release minor number.</DL> -</DD> -</DL> -<HR> - -<A NAME="getVersionPatch()"><!-- --></A><H3> -getVersionPatch</H3> -<PRE> -public static int <B>getVersionPatch</B>()</PRE> -<DL> -<DD>Return the release patch number. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The release minor number.</dd></dl> +</li> +</ul> +<a name="getVersionPatch()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionPatch</h4> +<pre>public static int getVersionPatch()</pre> +<div class="block">Return the release patch number. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The release patch number.</DL> -</DD> -</DL> +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The release patch number.</dd></dl> +</li> +</ul> +<a name="setBlobThreshold(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlobThreshold</h4> +<pre>public void setBlobThreshold(int value) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Set the blob threshold size. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The blob threshold size. + <p> + Any data item that is equal to or larger in size than the + threshold value will automatically be stored as a blob file. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="setMsgfile(java.io.File)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setMsgfile</h4> +<pre>public void setMsgfile(java.io.File file) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Sets the path of a file to store statistical information. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - The path of a file to store statistical information. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> <!-- ========= 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/Environment.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> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/db/Environment.html" target="_top"><B>FRAMES</B></A> - <A HREF="Environment.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<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/Environment.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 class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/db/Environment.html" target="_top">Frames</a></li> +<li><a href="Environment.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) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</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="#field_summary">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: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> -<font size=1>Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved.</font> -</BODY> -</HTML> +<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.</font></small></p> +</body> +</html> |