diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html | 2121 |
1 files changed, 2121 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html new file mode 100644 index 0000000..425a599 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html @@ -0,0 +1,2121 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:41 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>BDBRepositoryBuilder (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="BDBRepositoryBuilder (Carbonado 1.2.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/BDBRepositoryBuilder.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-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="BDBRepositoryBuilder.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </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>Field | </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 ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.repo.sleepycat</div> +<h2 title="Class BDBRepositoryBuilder" class="title">Class BDBRepositoryBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">com.amazon.carbonado.spi.AbstractRepositoryBuilder</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="strong">BDBRepositoryBuilder</span> +extends <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></pre> +<div class="block">Builder and configuration options for BDBRepository. + + <pre> + BDBRepositoryBuilder builder = new BDBRepositoryBuilder(); + + builder.setProduct("JE"); + builder.setName("test"); + builder.setEnvironmentHome("/tmp/testRepo"); + builder.setTransactionWriteNoSync(true); + + Repository repo = builder.build(); + </pre> + + <p> + The following extra capabilities are supported: + <ul> + <li><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>StorableInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><code>ShutdownCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><code>LayoutCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><code>SequenceCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><code>CheckpointCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><code>EnvironmentCapability</code></a> + </ul></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Vidya Iyer, Nicole Deflaux</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<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/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#BDBRepositoryBuilder()">BDBRepositoryBuilder</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getBDBProduct()">getBDBProduct</a></strong>()</code> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCachePercent()">getCachePercent</a></strong>()</code> +<div class="block">Returns the percent of JVM heap used by the repository cache, or + null if default should be selected.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Long</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCacheSize()">getCacheSize</a></strong>()</code> +<div class="block">Returns the repository cache size, or null if default should be + selected.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCheckpointInterval()">getCheckpointInterval</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCheckpointThresholdKB()">getCheckpointThresholdKB</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCheckpointThresholdMinutes()">getCheckpointThresholdMinutes</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getChecksumEnabled()">getChecksumEnabled</a></strong>()</code> +<div class="block">Returns true if checksum verification is enabled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCompressor(java.lang.String)">getCompressor</a></strong>(java.lang.String type)</code> +<div class="block">Return the compressor used for the given storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDatabaseHook()">getDatabaseHook</a></strong>()</code> +<div class="block">Returns the custom open database hook, or null if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDatabasesTransactional()">getDatabasesTransactional</a></strong>()</code> +<div class="block">Returns true if the databases are configured to be transactional, + false if configured to not be transactional, null if this override was never set</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDataHome()">getDataHome</a></strong>()</code> +<div class="block">Returns the directory to store data files.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDataHomeFile()">getDataHomeFile</a></strong>()</code> +<div class="block">Returns the optional directory to store data files.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getEnvironmentHome()">getEnvironmentHome</a></strong>()</code> +<div class="block">Returns the repository environment home directory.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getEnvironmentHomeFile()">getEnvironmentHomeFile</a></strong>()</code> +<div class="block">Returns the repository environment home directory.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getIndexRepairThrottle()">getIndexRepairThrottle</a></strong>()</code> +<div class="block">Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getIndexSupport()">getIndexSupport</a></strong>()</code> +<div class="block">Returns true if indexes are supported, which is true by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getInitialDatabaseConfig()">getInitialDatabaseConfig</a></strong>()</code> +<div class="block">Returns the optional BDB specific database configuration to use + for all databases created.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getInitialEnvironmentConfig()">getInitialEnvironmentConfig</a></strong>()</code> +<div class="block">Returns the optional BDB specific environment configuration to use.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getInitializeLogging()">getInitializeLogging</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getKeepOldLogFiles()">getKeepOldLogFiles</a></strong>()</code> +<div class="block">Returns false by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLockConflictDeadlockDetectMode()">getLockConflictDeadlockDetectMode</a></strong>()</code> +<div class="block">Returns true if deadlock detection is run whenever a lock conflict occurs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLockTimeout()">getLockTimeout</a></strong>()</code> +<div class="block">Returns the lock timeout, in seconds.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLockTimeoutInMicroseconds()">getLockTimeoutInMicroseconds</a></strong>()</code> +<div class="block">Returns the lock timeout, in microseconds, limited to max long value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLogFileMaxSize()">getLogFileMaxSize</a></strong>()</code> +<div class="block">Returns null if default size will be used.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLogInMemory()">getLogInMemory</a></strong>()</code> +<div class="block">Returns false by default, indicating that transaction logs are persisted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLogRegionSize()">getLogRegionSize</a></strong>()</code> +<div class="block">Returns the repository log region size, or null if the default + should be selected.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getMaxLocks()">getMaxLocks</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of the repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getPanicHandler()">getPanicHandler</a></strong>()</code> +<div class="block">Return the panic handler to call if the database panics.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Runnable</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getPreShutdownHook()">getPreShutdownHook</a></strong>()</code> +<div class="block">Returns the custom shutdown hook that runs before the repository has + finished running its own shutdown hooks, or null if none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getProduct()">getProduct</a></strong>()</code> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getReadOnly()">getReadOnly</a></strong>()</code> +<div class="block">Returns true if repository should be opened read-only.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getRunCheckpointer()">getRunCheckpointer</a></strong>()</code> +<div class="block">Returns true if checkpointer is run automatically.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getRunDeadlockDetector()">getRunDeadlockDetector</a></strong>()</code> +<div class="block">Returns true if deadlock detector is configured to run.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getRunFullRecovery()">getRunFullRecovery</a></strong>()</code> +<div class="block">Returns true if a full (catastrophic) recovery should be performed when + environment is opened.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Runnable</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getShutdownHook()">getShutdownHook</a></strong>()</code> +<div class="block">Returns the custom shutdown hook that runs after the repository has + finished running its own shutdown hooks, or null if none.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getSingleFileName()">getSingleFileName</a></strong>()</code> +<div class="block">Returns the single file that all BDB databases should reside in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getStorableCodecFactory()">getStorableCodecFactory</a></strong>()</code> +<div class="block">Returns the storable codec factory used.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionMaxActive()">getTransactionMaxActive</a></strong>()</code> +<div class="block">Returns the maximum number of concurrent transactions, or null if the + default is used.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionNoSync()">getTransactionNoSync</a></strong>()</code> +<div class="block">Returns true if transactions are not written or flushed to disk.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionTimeout()">getTransactionTimeout</a></strong>()</code> +<div class="block">Returns the repository transaction timeout, in seconds.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionTimeoutInMicroseconds()">getTransactionTimeoutInMicroseconds</a></strong>()</code> +<div class="block">Returns the repository transaction timeout, in microseconds, limited to + max long value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionWriteNoSync()">getTransactionWriteNoSync</a></strong>()</code> +<div class="block">Returns true if transactions are not flushed to disk.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isIndexRepairEnabled()">isIndexRepairEnabled</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isMaster()">isMaster</a></strong>()</code> +<div class="block">Returns true if repository should assume the role of master, which is + true by default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isMultiversion()">isMultiversion</a></strong>()</code> +<div class="block">Returns false by default because multiversion concurrency control (MVCC) + is not enabled.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isPrivate()">isPrivate</a></strong>()</code> +<div class="block">Returns true if BDB environment is private.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isReverseSplitOff()">isReverseSplitOff</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setBDBProduct(com.amazon.carbonado.repo.sleepycat.BDBProduct)">setBDBProduct</a></strong>(<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> product)</code> +<div class="block">Sets the BDB product to use, which defaults to JE.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCachePercent(int)">setCachePercent</a></strong>(int cachePercent)</code> +<div class="block">Set the percent of JVM heap used by the repository cache.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCachePercent(java.lang.Integer)">setCachePercent</a></strong>(java.lang.Integer cachePercent)</code> +<div class="block">Set the percent of JVM heap used by the repository cache.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCacheSize(long)">setCacheSize</a></strong>(long cacheSize)</code> +<div class="block">Set the repository cache size, in bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCacheSize(java.lang.Long)">setCacheSize</a></strong>(java.lang.Long cacheSize)</code> +<div class="block">Set the repository cache size, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCheckpointInterval(int)">setCheckpointInterval</a></strong>(int intervalMillis)</code> +<div class="block">Set the interval to run checkpoints.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCheckpointThresholdKB(int)">setCheckpointThresholdKB</a></strong>(int thresholdKB)</code> +<div class="block">Set the size threshold to run checkpoints.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCheckpointThresholdMinutes(int)">setCheckpointThresholdMinutes</a></strong>(int thresholdMinutes)</code> +<div class="block">Set the time threshold to run checkpoints.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setChecksumEnabled(java.lang.Boolean)">setChecksumEnabled</a></strong>(java.lang.Boolean checksumEnabled)</code> +<div class="block">When true, enable checksum verification of pages read into the cache + from the backing filestore.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCompressor(java.lang.String, java.lang.String)">setCompressor</a></strong>(java.lang.String type, + java.lang.String compressionType)</code> +<div class="block">Set the compressor for the given class, overriding a custom StorableCodecFactory.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDatabaseHook(com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook)">setDatabaseHook</a></strong>(<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a> hook)</code> +<div class="block">Sets a hook to be called whenever a database is opened.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDatabasePageSize(java.lang.Integer, java.lang.Class)">setDatabasePageSize</a></strong>(java.lang.Integer bytes, + java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</code> +<div class="block">Sets the desired page size for a given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDatabasesTransactional(java.lang.Boolean)">setDatabasesTransactional</a></strong>(java.lang.Boolean transactional)</code> +<div class="block">When true, allows databases to be transactional.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDataHome(java.lang.String)">setDataHome</a></strong>(java.lang.String dir)</code> +<div class="block">By default, data files are stored relative to the environment home.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDataHomeFile(java.io.File)">setDataHomeFile</a></strong>(java.io.File dir)</code> +<div class="block">By default, data files are stored relative to the environment home.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setEnvironmentHome(java.lang.String)">setEnvironmentHome</a></strong>(java.lang.String envHome)</code> +<div class="block">Sets the repository environment home directory, which is required.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setEnvironmentHomeFile(java.io.File)">setEnvironmentHomeFile</a></strong>(java.io.File envHome)</code> +<div class="block">Sets the repository environment home directory, which is required.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setFileName(java.lang.String, java.lang.String)">setFileName</a></strong>(java.lang.String filename, + java.lang.String typeName)</code> +<div class="block">Specify the file that a BDB database should reside in, except for log + files and caches.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setIndexRepairEnabled(boolean)">setIndexRepairEnabled</a></strong>(boolean enabled)</code> +<div class="block">By default, index repair is enabled.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setIndexRepairThrottle(double)">setIndexRepairThrottle</a></strong>(double desiredSpeed)</code> +<div class="block">Sets the throttle parameter used when indexes are added, dropped or bulk + repaired.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setIndexSupport(boolean)">setIndexSupport</a></strong>(boolean indexSupport)</code> +<div class="block">By default, user specified indexes are supported.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setInitialDatabaseConfig(java.lang.Object)">setInitialDatabaseConfig</a></strong>(java.lang.Object dbConfig)</code> +<div class="block">Optionally set the BDB specific database configuration to use + for all databases created.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setInitialEnvironmentConfig(java.lang.Object)">setInitialEnvironmentConfig</a></strong>(java.lang.Object envConfig)</code> +<div class="block">Optionally set the BDB specific environment configuration to + use.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setInitializeLogging(boolean)">setInitializeLogging</a></strong>(boolean b)</code> +<div class="block">Ensure the transaction logging sub-system is initialized, which is + usually implied.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setKeepOldLogFiles(boolean)">setKeepOldLogFiles</a></strong>(boolean keep)</code> +<div class="block">By default, transaction log files are deleted when no longer needed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLockConflictDeadlockDetectMode(boolean)">setLockConflictDeadlockDetectMode</a></strong>(boolean b)</code> +<div class="block">Enable deadlock detection whenever a lock conflict occurs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLockTimeout(double)">setLockTimeout</a></strong>(double lockTimeout)</code> +<div class="block">Set the lock timeout, in seconds.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogFileMaxSize(java.lang.Integer)">setLogFileMaxSize</a></strong>(java.lang.Integer sizeInBytes)</code> +<div class="block">Set the maximum transaction log file size for the BDB environment.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogInMemory(boolean)">setLogInMemory</a></strong>(boolean logInMemory)</code> +<div class="block">Set true to store transaction logs in memory only instead of persistent + storage.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogRegionSize(int)">setLogRegionSize</a></strong>(int logRegionSize)</code> +<div class="block">Set the repository log region size, in bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogRegionSize(java.lang.Integer)">setLogRegionSize</a></strong>(java.lang.Integer logRegionSize)</code> +<div class="block">Set the repository log region size, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setMaster(boolean)">setMaster</a></strong>(boolean b)</code> +<div class="block">Set to false if repository should not assume the role of master.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setMaxLocks(java.lang.Integer)">setMaxLocks</a></strong>(java.lang.Integer max)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setMultiversion(boolean)">setMultiversion</a></strong>(boolean multiversion)</code> +<div class="block">Set true to enable multiversion concurrency control (MVCC) on BDB + environment.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Set name for the repository, which is required.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setPanicHandler(com.amazon.carbonado.repo.sleepycat.BDBPanicHandler)">setPanicHandler</a></strong>(<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a> handler)</code> +<div class="block">Set the handler to call if the database panics.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setPreShutdownHook(java.lang.Runnable)">setPreShutdownHook</a></strong>(java.lang.Runnable hook)</code> +<div class="block">Sets a callback to be invoked before the repository has finished running + its own shutdown hooks.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setPrivate(boolean)">setPrivate</a></strong>(boolean b)</code> +<div class="block">When true, BDB environment cannot be shared by other processes, and + region files are not created.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setProduct(java.lang.String)">setProduct</a></strong>(java.lang.String product)</code> +<div class="block">Sets the BDB product to use, which defaults to JE.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setReadOnly(boolean)">setReadOnly</a></strong>(boolean readOnly)</code> +<div class="block">Sets the repository to read-only mode.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setReverseSplitOff(boolean)">setReverseSplitOff</a></strong>(boolean off)</code> +<div class="block">Pass true to disable reverse split of B-tree nodes to reduce deadlocks.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setRunCheckpointer(boolean)">setRunCheckpointer</a></strong>(boolean runCheckpointer)</code> +<div class="block">Disable automatic checkpointing of database if another process is + responsible for that.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setRunDeadlockDetector(boolean)">setRunDeadlockDetector</a></strong>(boolean runDeadlockDetector)</code> +<div class="block">Disable automatic deadlock detection of database if another thread is + responsible for that.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setRunFullRecovery(boolean)">setRunFullRecovery</a></strong>(boolean runRecovery)</code> +<div class="block">Pass true to override the default and run a full (catastrophic) recovery + when environment is opened.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setShutdownHook(java.lang.Runnable)">setShutdownHook</a></strong>(java.lang.Runnable hook)</code> +<div class="block">Sets a callback to be invoked after repository has finished running its + own shutdown hooks.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setSingleFileName(java.lang.String)">setSingleFileName</a></strong>(java.lang.String filename)</code> +<div class="block">Specify that all BDB databases should reside in one file, except for log + files and caches.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setStorableCodecFactory(com.amazon.carbonado.raw.StorableCodecFactory)">setStorableCodecFactory</a></strong>(<a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a> factory)</code> +<div class="block">Override the default storable codec factory.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setTransactionMaxActive(java.lang.Integer)">setTransactionMaxActive</a></strong>(java.lang.Integer max)</code> +<div class="block">Set the maximum number of concurrent transactions, or pass null to use + the default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setTransactionNoSync(boolean)">setTransactionNoSync</a></strong>(boolean noSync)</code> +<div class="block">When true, commits are not immediately written or flushed to disk.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setTransactionTimeout(double)">setTransactionTimeout</a></strong>(double txnTimeout)</code> +<div class="block">Set the transaction timeout, in seconds.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setTransactionWriteNoSync(boolean)">setTransactionWriteNoSync</a></strong>(boolean noSync)</code> +<div class="block">When true, commits are written, but they are not flushed to disk.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#verify(java.io.PrintStream)">verify</a></strong>(java.io.PrintStream out)</code> +<div class="block">Opens the BDB environment, checks if it is corrupt, and then closes it.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.spi.AbstractRepositoryBuilder"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></h3> +<code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class 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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BDBRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BDBRepositoryBuilder</h4> +<pre>public BDBRepositoryBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build(java.util.concurrent.atomic.AtomicReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">RepositoryBuilder</a></code></strong></div> +<div class="block">Builds a repository instance. + + <p>If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootRef</code> - reference to root parent repository, to be set by + parent repository upon being built</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="verify(java.io.PrintStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>verify</h4> +<pre>public boolean verify(java.io.PrintStream out) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block">Opens the BDB environment, checks if it is corrupt, and then closes it. + Only one process should open the environment for verification. Expect it + to take a long time.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - optional stream to capture any verfication errors</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if environment passes verification</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#getName()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns the name of the repository.</div> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(java.lang.String name)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set name for the repository, which is required.</div> +</li> +</ul> +<a name="isMaster()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMaster</h4> +<pre>public boolean isMaster()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setMaster(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaster</h4> +<pre>public void setMaster(boolean b)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setProduct(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setProduct</h4> +<pre>public void setProduct(java.lang.String product)</pre> +<div class="block">Sets the BDB product to use, which defaults to JE. Also supported is DB + and DB_HA. If not supported, an IllegalArgumentException is thrown.</div> +</li> +</ul> +<a name="getProduct()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProduct</h4> +<pre>public java.lang.String getProduct()</pre> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</li> +</ul> +<a name="setBDBProduct(com.amazon.carbonado.repo.sleepycat.BDBProduct)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBDBProduct</h4> +<pre>public void setBDBProduct(<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> product)</pre> +<div class="block">Sets the BDB product to use, which defaults to JE.</div> +</li> +</ul> +<a name="getBDBProduct()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBDBProduct</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a> getBDBProduct()</pre> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</li> +</ul> +<a name="setEnvironmentHomeFile(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEnvironmentHomeFile</h4> +<pre>public void setEnvironmentHomeFile(java.io.File envHome)</pre> +<div class="block">Sets the repository environment home directory, which is required.</div> +</li> +</ul> +<a name="getEnvironmentHomeFile()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnvironmentHomeFile</h4> +<pre>public java.io.File getEnvironmentHomeFile()</pre> +<div class="block">Returns the repository environment home directory.</div> +</li> +</ul> +<a name="setEnvironmentHome(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEnvironmentHome</h4> +<pre>public void setEnvironmentHome(java.lang.String envHome)</pre> +<div class="block">Sets the repository environment home directory, which is required.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if environment home is not valid</dd></dl> +</li> +</ul> +<a name="getEnvironmentHome()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnvironmentHome</h4> +<pre>public java.lang.String getEnvironmentHome()</pre> +<div class="block">Returns the repository environment home directory.</div> +</li> +</ul> +<a name="setDataHomeFile(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataHomeFile</h4> +<pre>public void setDataHomeFile(java.io.File dir)</pre> +<div class="block">By default, data files are stored relative to the environment home. Call + this method to override. For BDBRepositories that are log files only, + this configuration is ignored.</div> +</li> +</ul> +<a name="getDataHomeFile()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataHomeFile</h4> +<pre>public java.io.File getDataHomeFile()</pre> +<div class="block">Returns the optional directory to store data files. Returns null if data + files are expected to be relative to the environment home.</div> +</li> +</ul> +<a name="setDataHome(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataHome</h4> +<pre>public void setDataHome(java.lang.String dir)</pre> +<div class="block">By default, data files are stored relative to the environment home. Call + this method to override. For BDBRepositories that are log files only, + this configuration is ignored.</div> +</li> +</ul> +<a name="getDataHome()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataHome</h4> +<pre>public java.lang.String getDataHome()</pre> +<div class="block">Returns the directory to store data files.</div> +</li> +</ul> +<a name="setSingleFileName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSingleFileName</h4> +<pre>public void setSingleFileName(java.lang.String filename)</pre> +<div class="block">Specify that all BDB databases should reside in one file, except for log + files and caches. The filename is relative to the environment home, + unless data directories have been specified. For BDBRepositories that + are log files only, this configuration is ignored. + + <p>Note: When setting this option, the storable codec factory must also + be changed, since the default storable codec factory is unable to + distinguish storable types that reside in a single database file. Call + setFileName instead to use built-in BDB feature for supporting multiple + databases in one file.</div> +</li> +</ul> +<a name="getSingleFileName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSingleFileName</h4> +<pre>public java.lang.String getSingleFileName()</pre> +<div class="block">Returns the single file that all BDB databases should reside in.</div> +</li> +</ul> +<a name="setFileName(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFileName</h4> +<pre>public void setFileName(java.lang.String filename, + java.lang.String typeName)</pre> +<div class="block">Specify the file that a BDB database should reside in, except for log + files and caches. The filename is relative to the environment home, + unless data directories have been specified. For BDBRepositories that + are log files only, this configuration is ignored.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - BDB database filename</dd><dd><code>typeName</code> - type to store in file; if null, the file is used by default + for all types</dd></dl> +</li> +</ul> +<a name="setIndexSupport(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexSupport</h4> +<pre>public void setIndexSupport(boolean indexSupport)</pre> +<div class="block">By default, user specified indexes are supported. Pass false to disable + this, and no indexes will be built. Another consequence of this option + is that no unique constraint checks will be applied to alternate keys.</div> +</li> +</ul> +<a name="getIndexSupport()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexSupport</h4> +<pre>public boolean getIndexSupport()</pre> +<div class="block">Returns true if indexes are supported, which is true by default.</div> +</li> +</ul> +<a name="isIndexRepairEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndexRepairEnabled</h4> +<pre>public boolean isIndexRepairEnabled()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true by default</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setIndexRepairEnabled(boolean)"><code>setIndexRepairEnabled(boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setIndexRepairEnabled(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexRepairEnabled</h4> +<pre>public void setIndexRepairEnabled(boolean enabled)</pre> +<div class="block">By default, index repair is enabled. In this mode, the first time a + Storable type is used, new indexes are populated and old indexes are + removed. Until finished, access to the Storable is blocked. + + <p>When index repair is disabled, the Storable is immediately + available. This does have consequences, however. The set of indexes + available for queries is defined by the <i>intersection</i> of the old + and new index sets. The set of indexes that are kept up-to-date is + defined by the <i>union</i> of the old and new index sets. + + <p>While index repair is disabled, another process can safely repair the + indexes in the background. When it is complete, index repair can be + enabled for this repository too.</div> +</li> +</ul> +<a name="getIndexRepairThrottle()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexRepairThrottle</h4> +<pre>public double getIndexRepairThrottle()</pre> +<div class="block">Returns the throttle parameter used when indexes are added, dropped or + bulk repaired. By default this value is 1.0, or maximum speed.</div> +</li> +</ul> +<a name="setIndexRepairThrottle(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIndexRepairThrottle</h4> +<pre>public void setIndexRepairThrottle(double desiredSpeed)</pre> +<div class="block">Sets the throttle parameter used when indexes are added, dropped or bulk + repaired. By default this value is 1.0, or maximum speed.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desiredSpeed</code> - 1.0 = perform work at full speed, + 0.5 = perform work at half speed, 0.0 = fully suspend work</dd></dl> +</li> +</ul> +<a name="setReadOnly(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReadOnly</h4> +<pre>public void setReadOnly(boolean readOnly)</pre> +<div class="block">Sets the repository to read-only mode. By default, repository is opened + for reads and writes.</div> +</li> +</ul> +<a name="getReadOnly()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadOnly</h4> +<pre>public boolean getReadOnly()</pre> +<div class="block">Returns true if repository should be opened read-only.</div> +</li> +</ul> +<a name="setCacheSize(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCacheSize</h4> +<pre>public void setCacheSize(long cacheSize)</pre> +<div class="block">Set the repository cache size, in bytes. Actual BDB implementation will + select a suitable default if this is not set.</div> +</li> +</ul> +<a name="setCacheSize(java.lang.Long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCacheSize</h4> +<pre>public void setCacheSize(java.lang.Long cacheSize)</pre> +<div class="block">Set the repository cache size, in bytes. Actual BDB implementation will + select a suitable default if this is not set.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cacheSize</code> - cache size to use, or null for default</dd></dl> +</li> +</ul> +<a name="getCacheSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheSize</h4> +<pre>public java.lang.Long getCacheSize()</pre> +<div class="block">Returns the repository cache size, or null if default should be + selected.</div> +</li> +</ul> +<a name="setLogRegionSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogRegionSize</h4> +<pre>public void setLogRegionSize(int logRegionSize)</pre> +<div class="block">Set the repository log region size, in bytes.</div> +</li> +</ul> +<a name="setLogRegionSize(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogRegionSize</h4> +<pre>public void setLogRegionSize(java.lang.Integer logRegionSize)</pre> +<div class="block">Set the repository log region size, in bytes.</div> +</li> +</ul> +<a name="getLogRegionSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogRegionSize</h4> +<pre>public java.lang.Integer getLogRegionSize()</pre> +<div class="block">Returns the repository log region size, or null if the default + should be selected.</div> +</li> +</ul> +<a name="setCachePercent(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCachePercent</h4> +<pre>public void setCachePercent(int cachePercent)</pre> +<div class="block">Set the percent of JVM heap used by the repository cache. Actual + BDB implementation will select a suitable default if this is not + set. This is overridden by setting an explicit cacheSize.</div> +</li> +</ul> +<a name="setCachePercent(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCachePercent</h4> +<pre>public void setCachePercent(java.lang.Integer cachePercent)</pre> +<div class="block">Set the percent of JVM heap used by the repository cache. Actual + BDB implementation will select a suitable default if this is not + set. This is overridden by setting an explicit cacheSize.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cachePercent</code> - percent of JVM heap to use, or null for default</dd></dl> +</li> +</ul> +<a name="getCachePercent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCachePercent</h4> +<pre>public java.lang.Integer getCachePercent()</pre> +<div class="block">Returns the percent of JVM heap used by the repository cache, or + null if default should be selected.</div> +</li> +</ul> +<a name="setLockTimeout(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLockTimeout</h4> +<pre>public void setLockTimeout(double lockTimeout)</pre> +<div class="block">Set the lock timeout, in seconds. Default value is 0.5 seconds.</div> +</li> +</ul> +<a name="getLockTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockTimeout</h4> +<pre>public double getLockTimeout()</pre> +<div class="block">Returns the lock timeout, in seconds.</div> +</li> +</ul> +<a name="getLockTimeoutInMicroseconds()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockTimeoutInMicroseconds</h4> +<pre>public long getLockTimeoutInMicroseconds()</pre> +<div class="block">Returns the lock timeout, in microseconds, limited to max long value.</div> +</li> +</ul> +<a name="setMaxLocks(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxLocks</h4> +<pre>public void setMaxLocks(java.lang.Integer max)</pre> +</li> +</ul> +<a name="getMaxLocks()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxLocks</h4> +<pre>public java.lang.Integer getMaxLocks()</pre> +</li> +</ul> +<a name="setTransactionTimeout(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTransactionTimeout</h4> +<pre>public void setTransactionTimeout(double txnTimeout)</pre> +<div class="block">Set the transaction timeout, in seconds. Default value is 300 seconds.</div> +</li> +</ul> +<a name="getTransactionTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionTimeout</h4> +<pre>public double getTransactionTimeout()</pre> +<div class="block">Returns the repository transaction timeout, in seconds.</div> +</li> +</ul> +<a name="getTransactionTimeoutInMicroseconds()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionTimeoutInMicroseconds</h4> +<pre>public long getTransactionTimeoutInMicroseconds()</pre> +<div class="block">Returns the repository transaction timeout, in microseconds, limited to + max long value.</div> +</li> +</ul> +<a name="setTransactionNoSync(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTransactionNoSync</h4> +<pre>public void setTransactionNoSync(boolean noSync)</pre> +<div class="block">When true, commits are not immediately written or flushed to disk. This + improves performance, but there is a chance of losing the most recent + commits if the process is killed or if the machine crashes.</div> +</li> +</ul> +<a name="getTransactionNoSync()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionNoSync</h4> +<pre>public boolean getTransactionNoSync()</pre> +<div class="block">Returns true if transactions are not written or flushed to disk.</div> +</li> +</ul> +<a name="setTransactionWriteNoSync(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTransactionWriteNoSync</h4> +<pre>public void setTransactionWriteNoSync(boolean noSync)</pre> +<div class="block">When true, commits are written, but they are not flushed to disk. This + improves performance, but there is a chance of losing the most recent + commits if the machine crashes.</div> +</li> +</ul> +<a name="getTransactionWriteNoSync()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionWriteNoSync</h4> +<pre>public boolean getTransactionWriteNoSync()</pre> +<div class="block">Returns true if transactions are not flushed to disk.</div> +</li> +</ul> +<a name="setTransactionMaxActive(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTransactionMaxActive</h4> +<pre>public void setTransactionMaxActive(java.lang.Integer max)</pre> +<div class="block">Set the maximum number of concurrent transactions, or pass null to use + the default. This setting has no effect for BDB-JE.</div> +</li> +</ul> +<a name="getTransactionMaxActive()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionMaxActive</h4> +<pre>public java.lang.Integer getTransactionMaxActive()</pre> +<div class="block">Returns the maximum number of concurrent transactions, or null if the + default is used.</div> +</li> +</ul> +<a name="setDatabasesTransactional(java.lang.Boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDatabasesTransactional</h4> +<pre>public void setDatabasesTransactional(java.lang.Boolean transactional)</pre> +<div class="block">When true, allows databases to be transactional. This setting affects + the databases, not the environment. If this is not explicitly set, the + environment getTransactional is used.</div> +</li> +</ul> +<a name="getDatabasesTransactional()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDatabasesTransactional</h4> +<pre>public java.lang.Boolean getDatabasesTransactional()</pre> +<div class="block">Returns true if the databases are configured to be transactional, + false if configured to not be transactional, null if this override was never set</div> +</li> +</ul> +<a name="setReverseSplitOff(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReverseSplitOff</h4> +<pre>public void setReverseSplitOff(boolean off)</pre> +<div class="block">Pass true to disable reverse split of B-tree nodes to reduce deadlocks. + This setting has no effect for BDB-JE.</div> +</li> +</ul> +<a name="isReverseSplitOff()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isReverseSplitOff</h4> +<pre>public boolean isReverseSplitOff()</pre> +</li> +</ul> +<a name="setDatabasePageSize(java.lang.Integer, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDatabasePageSize</h4> +<pre>public void setDatabasePageSize(java.lang.Integer bytes, + java.lang.Class<? extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> type)</pre> +<div class="block">Sets the desired page size for a given type. If not specified, the page + size applies to all types.</div> +</li> +</ul> +<a name="setPrivate(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPrivate</h4> +<pre>public void setPrivate(boolean b)</pre> +<div class="block">When true, BDB environment cannot be shared by other processes, and + region files are not created. By default, environment is shared, if + supported.</div> +</li> +</ul> +<a name="isPrivate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPrivate</h4> +<pre>public boolean isPrivate()</pre> +<div class="block">Returns true if BDB environment is private. By default, environment is + shared, if supported.</div> +</li> +</ul> +<a name="setMultiversion(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMultiversion</h4> +<pre>public void setMultiversion(boolean multiversion)</pre> +<div class="block">Set true to enable multiversion concurrency control (MVCC) on BDB + environment. This enables snapshot isolation, and is it is not supported + by all BDB products and versions.</div> +</li> +</ul> +<a name="isMultiversion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMultiversion</h4> +<pre>public boolean isMultiversion()</pre> +<div class="block">Returns false by default because multiversion concurrency control (MVCC) + is not enabled.</div> +</li> +</ul> +<a name="setLogInMemory(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogInMemory</h4> +<pre>public void setLogInMemory(boolean logInMemory)</pre> +<div class="block">Set true to store transaction logs in memory only instead of persistent + storage. For BDB products which are entirely log based, no records are + ever persisted.</div> +</li> +</ul> +<a name="getLogInMemory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogInMemory</h4> +<pre>public boolean getLogInMemory()</pre> +<div class="block">Returns false by default, indicating that transaction logs are persisted.</div> +</li> +</ul> +<a name="setLogFileMaxSize(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogFileMaxSize</h4> +<pre>public void setLogFileMaxSize(java.lang.Integer sizeInBytes)</pre> +<div class="block">Set the maximum transaction log file size for the BDB environment.</div> +</li> +</ul> +<a name="getLogFileMaxSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogFileMaxSize</h4> +<pre>public java.lang.Integer getLogFileMaxSize()</pre> +<div class="block">Returns null if default size will be used.</div> +</li> +</ul> +<a name="setInitializeLogging(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInitializeLogging</h4> +<pre>public void setInitializeLogging(boolean b)</pre> +<div class="block">Ensure the transaction logging sub-system is initialized, which is + usually implied.</div> +</li> +</ul> +<a name="getInitializeLogging()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitializeLogging</h4> +<pre>public boolean getInitializeLogging()</pre> +</li> +</ul> +<a name="setRunFullRecovery(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRunFullRecovery</h4> +<pre>public void setRunFullRecovery(boolean runRecovery)</pre> +<div class="block">Pass true to override the default and run a full (catastrophic) recovery + when environment is opened. This setting has no effect for BDB-JE.</div> +</li> +</ul> +<a name="getRunFullRecovery()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRunFullRecovery</h4> +<pre>public boolean getRunFullRecovery()</pre> +<div class="block">Returns true if a full (catastrophic) recovery should be performed when + environment is opened.</div> +</li> +</ul> +<a name="setRunCheckpointer(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRunCheckpointer</h4> +<pre>public void setRunCheckpointer(boolean runCheckpointer)</pre> +<div class="block">Disable automatic checkpointing of database if another process is + responsible for that. The false setting is implied for read-only + databases.</div> +</li> +</ul> +<a name="getRunCheckpointer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRunCheckpointer</h4> +<pre>public boolean getRunCheckpointer()</pre> +<div class="block">Returns true if checkpointer is run automatically.</div> +</li> +</ul> +<a name="setCheckpointInterval(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCheckpointInterval</h4> +<pre>public void setCheckpointInterval(int intervalMillis)</pre> +<div class="block">Set the interval to run checkpoints. This setting is ignored if the + checkpointer is not configured to run.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>intervalMillis</code> - interval between checkpoints, in milliseconds</dd></dl> +</li> +</ul> +<a name="getCheckpointInterval()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCheckpointInterval</h4> +<pre>public int getCheckpointInterval()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>interval between checkpoints, in milliseconds</dd></dl> +</li> +</ul> +<a name="setCheckpointThresholdKB(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCheckpointThresholdKB</h4> +<pre>public void setCheckpointThresholdKB(int thresholdKB)</pre> +<div class="block">Set the size threshold to run checkpoints. This setting is ignored if + the checkpointer is not configured to run. Default value is 1024 KB. + + <p>Checkpoint threshold is only used by Carbonado's built-in + checkpointer, and is ignored when using BDB-JE.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>thresholdKB</code> - run checkpoint if at least this many kilobytes in log</dd></dl> +</li> +</ul> +<a name="getCheckpointThresholdKB()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCheckpointThresholdKB</h4> +<pre>public int getCheckpointThresholdKB()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>run checkpoint if at least this many kilobytes in log</dd></dl> +</li> +</ul> +<a name="setCheckpointThresholdMinutes(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCheckpointThresholdMinutes</h4> +<pre>public void setCheckpointThresholdMinutes(int thresholdMinutes)</pre> +<div class="block">Set the time threshold to run checkpoints. This setting is ignored if + the checkpointer is not configured to run. Default value is 1 minute. + + <p>Checkpoint threshold is only used by Carbonado's built-in + checkpointer, and is ignored when using BDB-JE.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>thresholdMinutes</code> - run checkpoint if at least this many minutes + passed since last checkpoint</dd></dl> +</li> +</ul> +<a name="getCheckpointThresholdMinutes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCheckpointThresholdMinutes</h4> +<pre>public int getCheckpointThresholdMinutes()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>run checkpoint if at least this many minutes passed since last + checkpoint</dd></dl> +</li> +</ul> +<a name="setKeepOldLogFiles(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setKeepOldLogFiles</h4> +<pre>public void setKeepOldLogFiles(boolean keep)</pre> +<div class="block">By default, transaction log files are deleted when no longer needed. + Keeping log files can be used for incremental backups or for diagnosing + problems. If using BDB-JE, old log files are renamed with a ".del" + extension. If using BDB-core, the db_archive utility is required for + identifying old log files.</div> +</li> +</ul> +<a name="getKeepOldLogFiles()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeepOldLogFiles</h4> +<pre>public boolean getKeepOldLogFiles()</pre> +<div class="block">Returns false by default.</div> +</li> +</ul> +<a name="setRunDeadlockDetector(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRunDeadlockDetector</h4> +<pre>public void setRunDeadlockDetector(boolean runDeadlockDetector)</pre> +<div class="block">Disable automatic deadlock detection of database if another thread is + responsible for that.</div> +</li> +</ul> +<a name="getRunDeadlockDetector()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRunDeadlockDetector</h4> +<pre>public boolean getRunDeadlockDetector()</pre> +<div class="block">Returns true if deadlock detector is configured to run.</div> +</li> +</ul> +<a name="setLockConflictDeadlockDetectMode(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLockConflictDeadlockDetectMode</h4> +<pre>public void setLockConflictDeadlockDetectMode(boolean b)</pre> +<div class="block">Enable deadlock detection whenever a lock conflict occurs. Default is + off, and it has no effect for BDB-JE.</div> +</li> +</ul> +<a name="getLockConflictDeadlockDetectMode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLockConflictDeadlockDetectMode</h4> +<pre>public boolean getLockConflictDeadlockDetectMode()</pre> +<div class="block">Returns true if deadlock detection is run whenever a lock conflict occurs.</div> +</li> +</ul> +<a name="setChecksumEnabled(java.lang.Boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setChecksumEnabled</h4> +<pre>public void setChecksumEnabled(java.lang.Boolean checksumEnabled)</pre> +<div class="block">When true, enable checksum verification of pages read into the cache + from the backing filestore. By default checksum is enabled for BDB-JE, + and disabled for BDB-C.</div> +</li> +</ul> +<a name="getChecksumEnabled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChecksumEnabled</h4> +<pre>public java.lang.Boolean getChecksumEnabled()</pre> +<div class="block">Returns true if checksum verification is enabled. Returns null if the + BDB default is used.</div> +</li> +</ul> +<a name="setInitialEnvironmentConfig(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInitialEnvironmentConfig</h4> +<pre>public void setInitialEnvironmentConfig(java.lang.Object envConfig)</pre> +<div class="block">Optionally set the BDB specific environment configuration to + use. The builder will verify that needed configuration values are set.</div> +</li> +</ul> +<a name="getInitialEnvironmentConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitialEnvironmentConfig</h4> +<pre>public java.lang.Object getInitialEnvironmentConfig()</pre> +<div class="block">Returns the optional BDB specific environment configuration to use.</div> +</li> +</ul> +<a name="setInitialDatabaseConfig(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInitialDatabaseConfig</h4> +<pre>public void setInitialDatabaseConfig(java.lang.Object dbConfig)</pre> +<div class="block">Optionally set the BDB specific database configuration to use + for all databases created. The storage will verify that needed + configuration values are set.</div> +</li> +</ul> +<a name="getInitialDatabaseConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInitialDatabaseConfig</h4> +<pre>public java.lang.Object getInitialDatabaseConfig()</pre> +<div class="block">Returns the optional BDB specific database configuration to use + for all databases created.</div> +</li> +</ul> +<a name="setStorableCodecFactory(com.amazon.carbonado.raw.StorableCodecFactory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStorableCodecFactory</h4> +<pre>public void setStorableCodecFactory(<a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a> factory)</pre> +<div class="block">Override the default storable codec factory.</div> +</li> +</ul> +<a name="getStorableCodecFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableCodecFactory</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a> getStorableCodecFactory()</pre> +<div class="block">Returns the storable codec factory used.</div> +</li> +</ul> +<a name="setPreShutdownHook(java.lang.Runnable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPreShutdownHook</h4> +<pre>public void setPreShutdownHook(java.lang.Runnable hook)</pre> +<div class="block">Sets a callback to be invoked before the repository has finished running + its own shutdown hooks. This method is also invoked when repository is + manually closed.</div> +</li> +</ul> +<a name="getPreShutdownHook()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPreShutdownHook</h4> +<pre>public java.lang.Runnable getPreShutdownHook()</pre> +<div class="block">Returns the custom shutdown hook that runs before the repository has + finished running its own shutdown hooks, or null if none.</div> +</li> +</ul> +<a name="setShutdownHook(java.lang.Runnable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setShutdownHook</h4> +<pre>public void setShutdownHook(java.lang.Runnable hook)</pre> +<div class="block">Sets a callback to be invoked after repository has finished running its + own shutdown hooks. This method is also invoked when repository is + manually closed.</div> +</li> +</ul> +<a name="getShutdownHook()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getShutdownHook</h4> +<pre>public java.lang.Runnable getShutdownHook()</pre> +<div class="block">Returns the custom shutdown hook that runs after the repository has + finished running its own shutdown hooks, or null if none.</div> +</li> +</ul> +<a name="setDatabaseHook(com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDatabaseHook</h4> +<pre>public void setDatabaseHook(<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a> hook)</pre> +<div class="block">Sets a hook to be called whenever a database is opened.</div> +</li> +</ul> +<a name="getDatabaseHook()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDatabaseHook</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a> getDatabaseHook()</pre> +<div class="block">Returns the custom open database hook, or null if none.</div> +</li> +</ul> +<a name="setCompressor(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCompressor</h4> +<pre>public void setCompressor(java.lang.String type, + java.lang.String compressionType)</pre> +<div class="block">Set the compressor for the given class, overriding a custom StorableCodecFactory.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Storable to compress.</dd><dd><code>compressionType</code> - String representation of type of + compression. Available options are "NONE" for no compression or "GZIP" + for gzip compression</dd></dl> +</li> +</ul> +<a name="getCompressor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCompressor</h4> +<pre>public java.lang.String getCompressor(java.lang.String type)</pre> +<div class="block">Return the compressor used for the given storable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Storable to compress</dd> +<dt><span class="strong">Returns:</span></dt><dd>String representation of the type of compression used. Available options are "NONE" + for no compression and "GZIP" for gzip compression.</dd></dl> +</li> +</ul> +<a name="setPanicHandler(com.amazon.carbonado.repo.sleepycat.BDBPanicHandler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPanicHandler</h4> +<pre>public void setPanicHandler(<a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a> handler)</pre> +<div class="block">Set the handler to call if the database panics.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - </dd></dl> +</li> +</ul> +<a name="getPanicHandler()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPanicHandler</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a> getPanicHandler()</pre> +<div class="block">Return the panic handler to call if the database panics.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The BDBPanicHandler or null if unset.</dd></dl> +</li> +</ul> +<a name="errorCheck(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>errorCheck</h4> +<pre>public void errorCheck(java.util.Collection<java.lang.String> messages) + throws <a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">AbstractRepositoryBuilder</a></code></strong></div> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call <code>super.errorCheck</code> as well.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></code> in class <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>messages</code> - add any error messages to this list</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if error checking indirectly caused + another exception</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/BDBRepositoryBuilder.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-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="BDBRepositoryBuilder.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li>Field | </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>Field | </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 ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |