summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html
diff options
context:
space:
mode:
Diffstat (limited to 'apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html')
-rw-r--r--apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html333
1 files changed, 333 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html
new file mode 100644
index 0000000..a3632c0
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html
@@ -0,0 +1,333 @@
+<!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>HotBackupCapability (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="HotBackupCapability (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/HotBackupCapability.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/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.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/HotBackupCapability.html" target="_top">Frames</a></li>
+<li><a href="HotBackupCapability.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:&nbsp;</li>
+<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</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="Interface HotBackupCapability" class="title">Interface HotBackupCapability</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Superinterfaces:</dt>
+<dd><a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="strong">HotBackupCapability</span>
+extends <a href="../../../../../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability">Capability</a></pre>
+<div class="block">Capability for performing a backup of an active BDB environment. If <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogInMemory(boolean)"><code>in-memory logging</code></a> is enabled,
+ backups cannot be performed. To restore from a hot backup, it is
+ <b>critical</b> that a full recovery be performed. Pass true to <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setRunFullRecovery(boolean)"><code>setRunFullRecovery</code></a> to
+ enable. <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#JE"><code>BDB-JE</code></a> does not require this, however.
+
+ <p>To support incremental backups against the <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#DB"><code>native
+ BDB product</code></a>, old log files must be kept. Pass true to <a href="../../../../../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setKeepOldLogFiles(boolean)"><code>setKeepOldLogFiles</code></a>.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>1.2.1</dd>
+<dt><span class="strong">Author:</span></dt>
+ <dd>Brian S O'Neill, Olga Kuznetsova</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">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Interface and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static interface&nbsp;</code></td>
+<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></strong></code>&nbsp;</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">&nbsp;</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/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startBackup()">startBackup</a></strong>()</code>
+<div class="block">Starts the backup by disabling log file deletion.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startBackup(boolean)">startBackup</a></strong>(boolean&nbsp;deleteOldLogFiles)</code>
+<div class="block">Starts the backup by disabling log file deletion.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startIncrementalBackup(long)">startIncrementalBackup</a></strong>(long&nbsp;lastLogNumber)</code>
+<div class="block">Starts an incremental backup.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startIncrementalBackup(long, boolean)">startIncrementalBackup</a></strong>(long&nbsp;lastLogNumber,
+ boolean&nbsp;deleteOldLogFiles)</code>
+<div class="block">Starts an incremental backup.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="startBackup()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>startBackup</h4>
+<pre><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a>&nbsp;startBackup()
+ throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre>
+<div class="block">Starts the backup by disabling log file deletion. Be sure to call
+ endBackup when done to resume log file cleanup. Concurrent backups are
+ supported.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if configuration doesn't support backups</dd>
+<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl>
+</li>
+</ul>
+<a name="startBackup(boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>startBackup</h4>
+<pre><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a>&nbsp;startBackup(boolean&nbsp;deleteOldLogFiles)
+ throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre>
+<div class="block">Starts the backup by disabling log file deletion. Be sure to call
+ endBackup when done to resume log file cleanup. Concurrent backups are supported.
+
+ <p>Caution should be observed when deleting old log files by force, if
+ an external process is also performing backups. If a concurrent backup
+ is issued by this repository instance, log file deletion is suppressed.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>deleteOldLogFiles</code> - deletes log files that are no longer in use and
+ have been backed up. False by default.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if configuration doesn't support backups</dd>
+<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl>
+</li>
+</ul>
+<a name="startIncrementalBackup(long)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>startIncrementalBackup</h4>
+<pre><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a>&nbsp;startIncrementalBackup(long&nbsp;lastLogNumber)
+ throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre>
+<div class="block">Starts an incremental backup. Log files that are newer than the
+ lastLogNumber will be copied during the backup. Should only be run after
+ performing a full backup.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lastLogNumber</code> - number of the last log file that was copied in a previous backup</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if lastLogNumber is negative</dd>
+<dd><code>java.lang.IllegalStateException</code> - if configuration doesn't support backups</dd>
+<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl>
+</li>
+</ul>
+<a name="startIncrementalBackup(long, boolean)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>startIncrementalBackup</h4>
+<pre><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a>&nbsp;startIncrementalBackup(long&nbsp;lastLogNumber,
+ boolean&nbsp;deleteOldLogFiles)
+ throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre>
+<div class="block">Starts an incremental backup. Log files that are newer than the lastLogNumber will be copied
+ during the backup. Can only be run after performing a full backup.
+
+ <p>Caution should be observed when deleting old log files by force, if
+ an external process is also performing backups. If a concurrent backup
+ is issued by this repository instance, log file deletion is suppressed.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lastLogNumber</code> - number of the last log file that was copied in a previous backup.</dd><dd><code>deleteOldLogFiles</code> - deletes log files that are no longer in use and
+ have been backed up. False by default.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if lastLogNumber is negative</dd>
+<dd><code>java.lang.IllegalStateException</code> - if configuration doesn't support backups</dd>
+<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!-- -->
+</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/HotBackupCapability.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/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.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/HotBackupCapability.html" target="_top">Frames</a></li>
+<li><a href="HotBackupCapability.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:&nbsp;</li>
+<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</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 &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>