Added: bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html URL: http://svn.apache.org/viewvc/bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html?rev=1743979&view=auto ============================================================================== --- bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html (added) +++ bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html Sun May 15 21:38:37 2016 @@ -0,0 +1,378 @@ +<!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_80) on Sun May 15 21:18:06 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DefaultEnsemblePlacementPolicy (bookkeeper 4.4.0 API)</title> +<meta name="date" content="2016-05-15"> +<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="DefaultEnsemblePlacementPolicy (bookkeeper 4.4.0 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/DefaultEnsemblePlacementPolicy.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/bookkeeper/client/BookKeeperClientStats.html" title="interface in org.apache.bookkeeper.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html" target="_top">Frames</a></li> +<li><a href="DefaultEnsemblePlacementPolicy.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><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">org.apache.bookkeeper.client</div> +<h2 title="Class DefaultEnsemblePlacementPolicy" class="title">Class DefaultEnsemblePlacementPolicy</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.bookkeeper.client.DefaultEnsemblePlacementPolicy</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client">EnsemblePlacementPolicy</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DefaultEnsemblePlacementPolicy</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client">EnsemblePlacementPolicy</a></pre> +<div class="block">Default Ensemble Placement Policy, which picks bookies randomly</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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="../../../../org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html#DefaultEnsemblePlacementPolicy()">DefaultEnsemblePlacementPolicy</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="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client">EnsemblePlacementPolicy</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html#initialize(org.apache.commons.configuration.Configuration)">initialize</a></strong>(org.apache.commons.configuration.Configuration conf)</code> +<div class="block">Initialize the policy.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true"; title="class or interface in java.util">ArrayList</a><org.apache.bookkeeper.net.BookieSocketAddress></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html#newEnsemble(int,%20int,%20java.util.Set)">newEnsemble</a></strong>(int ensembleSize, + int quorumSize, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> excludeBookies)</code> +<div class="block">Choose <i>numBookies</i> bookies for ensemble.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html#onClusterChanged(java.util.Set,%20java.util.Set)">onClusterChanged</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> writableBookies, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> readOnlyBookies)</code> +<div class="block">A consistent view of the cluster (what bookies are available as writable, what bookies are available as + readonly) is updated when any changes happen in the cluster.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.apache.bookkeeper.net.BookieSocketAddress</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html#replaceBookie(org.apache.bookkeeper.net.BookieSocketAddress,%20java.util.Set)">replaceBookie</a></strong>(org.apache.bookkeeper.net.BookieSocketAddress bookieToReplace, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> excludeBookies)</code> +<div class="block">Choose a new bookie to replace <i>bookieToReplace</i>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html#uninitalize()">uninitalize</a></strong>()</code> +<div class="block">Uninitialize the policy</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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="DefaultEnsemblePlacementPolicy()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DefaultEnsemblePlacementPolicy</h4> +<pre>public DefaultEnsemblePlacementPolicy()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="newEnsemble(int, int, java.util.Set)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newEnsemble</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true"; title="class or interface in java.util">ArrayList</a><org.apache.bookkeeper.net.BookieSocketAddress> newEnsemble(int ensembleSize, + int quorumSize, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> excludeBookies) + throws <a href="../../../../org/apache/bookkeeper/client/BKException.BKNotEnoughBookiesException.html" title="class in org.apache.bookkeeper.client">BKException.BKNotEnoughBookiesException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#newEnsemble(int,%20int,%20java.util.Set)">EnsemblePlacementPolicy</a></code></strong></div> +<div class="block">Choose <i>numBookies</i> bookies for ensemble. If the count is more than the number of available + nodes, <a href="../../../../org/apache/bookkeeper/client/BKException.BKNotEnoughBookiesException.html" title="class in org.apache.bookkeeper.client"><code>BKException.BKNotEnoughBookiesException</code></a> is thrown.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#newEnsemble(int,%20int,%20java.util.Set)">newEnsemble</a></code> in interface <code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client">EnsemblePlacementPolicy</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>ensembleSize</code> - Ensemble Size</dd><dd><code>quorumSize</code> - Write Quorum Size</dd><dd><code>excludeBookies</code> - Bookies that should not be considered as targets.</dd> +<dt><span class="strong">Returns:</span></dt><dd>list of bookies chosen as targets.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/bookkeeper/client/BKException.BKNotEnoughBookiesException.html" title="class in org.apache.bookkeeper.client">BKException.BKNotEnoughBookiesException</a></code> - if not enough bookies available.</dd></dl> +</li> +</ul> +<a name="replaceBookie(org.apache.bookkeeper.net.BookieSocketAddress, java.util.Set)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replaceBookie</h4> +<pre>public org.apache.bookkeeper.net.BookieSocketAddress replaceBookie(org.apache.bookkeeper.net.BookieSocketAddress bookieToReplace, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> excludeBookies) + throws <a href="../../../../org/apache/bookkeeper/client/BKException.BKNotEnoughBookiesException.html" title="class in org.apache.bookkeeper.client">BKException.BKNotEnoughBookiesException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#replaceBookie(org.apache.bookkeeper.net.BookieSocketAddress,%20java.util.Set)">EnsemblePlacementPolicy</a></code></strong></div> +<div class="block">Choose a new bookie to replace <i>bookieToReplace</i>. If no bookie available in the cluster, + <a href="../../../../org/apache/bookkeeper/client/BKException.BKNotEnoughBookiesException.html" title="class in org.apache.bookkeeper.client"><code>BKException.BKNotEnoughBookiesException</code></a> is thrown.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#replaceBookie(org.apache.bookkeeper.net.BookieSocketAddress,%20java.util.Set)">replaceBookie</a></code> in interface <code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client">EnsemblePlacementPolicy</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>bookieToReplace</code> - bookie to replace</dd><dd><code>excludeBookies</code> - bookies that should not be considered as candidate.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the bookie chosen as target.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/bookkeeper/client/BKException.BKNotEnoughBookiesException.html" title="class in org.apache.bookkeeper.client">BKException.BKNotEnoughBookiesException</a></code></dd></dl> +</li> +</ul> +<a name="onClusterChanged(java.util.Set, java.util.Set)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onClusterChanged</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> onClusterChanged(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> writableBookies, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> readOnlyBookies)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#onClusterChanged(java.util.Set,%20java.util.Set)">EnsemblePlacementPolicy</a></code></strong></div> +<div class="block">A consistent view of the cluster (what bookies are available as writable, what bookies are available as + readonly) is updated when any changes happen in the cluster.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#onClusterChanged(java.util.Set,%20java.util.Set)">onClusterChanged</a></code> in interface <code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client">EnsemblePlacementPolicy</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>writableBookies</code> - All the bookies in the cluster available for write/read.</dd><dd><code>readOnlyBookies</code> - All the bookies in the cluster available for readonly.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the dead bookies during this cluster change.</dd></dl> +</li> +</ul> +<a name="initialize(org.apache.commons.configuration.Configuration)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>public <a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client">EnsemblePlacementPolicy</a> initialize(org.apache.commons.configuration.Configuration conf)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#initialize(org.apache.commons.configuration.Configuration)">EnsemblePlacementPolicy</a></code></strong></div> +<div class="block">Initialize the policy.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#initialize(org.apache.commons.configuration.Configuration)">initialize</a></code> in interface <code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client">EnsemblePlacementPolicy</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> - client configuration.</dd> +<dt><span class="strong">Returns:</span></dt><dd>initialized ensemble placement policy</dd></dl> +</li> +</ul> +<a name="uninitalize()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>uninitalize</h4> +<pre>public void uninitalize()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#uninitalize()">EnsemblePlacementPolicy</a></code></strong></div> +<div class="block">Uninitialize the policy</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#uninitalize()">uninitalize</a></code> in interface <code><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client">EnsemblePlacementPolicy</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/DefaultEnsemblePlacementPolicy.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/bookkeeper/client/BookKeeperClientStats.html" title="interface in org.apache.bookkeeper.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html" target="_top">Frames</a></li> +<li><a href="DefaultEnsemblePlacementPolicy.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><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 © 2011-2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
Added: bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/EnsemblePlacementPolicy.html URL: http://svn.apache.org/viewvc/bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/EnsemblePlacementPolicy.html?rev=1743979&view=auto ============================================================================== --- bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/EnsemblePlacementPolicy.html (added) +++ bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/EnsemblePlacementPolicy.html Sun May 15 21:38:37 2016 @@ -0,0 +1,307 @@ +<!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_80) on Sun May 15 21:18:06 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>EnsemblePlacementPolicy (bookkeeper 4.4.0 API)</title> +<meta name="date" content="2016-05-15"> +<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="EnsemblePlacementPolicy (bookkeeper 4.4.0 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/EnsemblePlacementPolicy.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html" title="class in org.apache.bookkeeper.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/bookkeeper/client/LedgerChecker.html" title="class in org.apache.bookkeeper.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" target="_top">Frames</a></li> +<li><a href="EnsemblePlacementPolicy.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.bookkeeper.client</div> +<h2 title="Interface EnsemblePlacementPolicy" class="title">Interface EnsemblePlacementPolicy</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html" title="class in org.apache.bookkeeper.client">DefaultEnsemblePlacementPolicy</a>, <a href="../../../../org/apache/bookkeeper/client/RackawareEnsemblePlacementPolicy.html" title="class in org.apache.bookkeeper.client">RackawareEnsemblePlacementPolicy</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">EnsemblePlacementPolicy</span></pre> +<div class="block">Encapsulation of the algorithm that selects a number of bookies from the cluster as an ensemble for storing + data, based on the data input as well as the node properties.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client">EnsemblePlacementPolicy</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#initialize(org.apache.commons.configuration.Configuration)">initialize</a></strong>(org.apache.commons.configuration.Configuration conf)</code> +<div class="block">Initialize the policy.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true"; title="class or interface in java.util">ArrayList</a><org.apache.bookkeeper.net.BookieSocketAddress></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#newEnsemble(int,%20int,%20java.util.Set)">newEnsemble</a></strong>(int ensembleSize, + int writeQuorumSize, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> excludeBookies)</code> +<div class="block">Choose <i>numBookies</i> bookies for ensemble.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#onClusterChanged(java.util.Set,%20java.util.Set)">onClusterChanged</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> writableBookies, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> readOnlyBookies)</code> +<div class="block">A consistent view of the cluster (what bookies are available as writable, what bookies are available as + readonly) is updated when any changes happen in the cluster.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.apache.bookkeeper.net.BookieSocketAddress</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#replaceBookie(org.apache.bookkeeper.net.BookieSocketAddress,%20java.util.Set)">replaceBookie</a></strong>(org.apache.bookkeeper.net.BookieSocketAddress bookieToReplace, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> excludeBookies)</code> +<div class="block">Choose a new bookie to replace <i>bookieToReplace</i>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html#uninitalize()">uninitalize</a></strong>()</code> +<div class="block">Uninitialize the policy</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="initialize(org.apache.commons.configuration.Configuration)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client">EnsemblePlacementPolicy</a> initialize(org.apache.commons.configuration.Configuration conf)</pre> +<div class="block">Initialize the policy.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> - client configuration.</dd> +<dt><span class="strong">Returns:</span></dt><dd>initialized ensemble placement policy</dd></dl> +</li> +</ul> +<a name="uninitalize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>uninitalize</h4> +<pre>void uninitalize()</pre> +<div class="block">Uninitialize the policy</div> +</li> +</ul> +<a name="onClusterChanged(java.util.Set, java.util.Set)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onClusterChanged</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> onClusterChanged(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> writableBookies, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> readOnlyBookies)</pre> +<div class="block">A consistent view of the cluster (what bookies are available as writable, what bookies are available as + readonly) is updated when any changes happen in the cluster.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>writableBookies</code> - All the bookies in the cluster available for write/read.</dd><dd><code>readOnlyBookies</code> - All the bookies in the cluster available for readonly.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the dead bookies during this cluster change.</dd></dl> +</li> +</ul> +<a name="newEnsemble(int, int, java.util.Set)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newEnsemble</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true"; title="class or interface in java.util">ArrayList</a><org.apache.bookkeeper.net.BookieSocketAddress> newEnsemble(int ensembleSize, + int writeQuorumSize, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> excludeBookies) + throws <a href="../../../../org/apache/bookkeeper/client/BKException.BKNotEnoughBookiesException.html" title="class in org.apache.bookkeeper.client">BKException.BKNotEnoughBookiesException</a></pre> +<div class="block">Choose <i>numBookies</i> bookies for ensemble. If the count is more than the number of available + nodes, <a href="../../../../org/apache/bookkeeper/client/BKException.BKNotEnoughBookiesException.html" title="class in org.apache.bookkeeper.client"><code>BKException.BKNotEnoughBookiesException</code></a> is thrown.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ensembleSize</code> - Ensemble Size</dd><dd><code>writeQuorumSize</code> - Write Quorum Size</dd><dd><code>excludeBookies</code> - Bookies that should not be considered as targets.</dd> +<dt><span class="strong">Returns:</span></dt><dd>list of bookies chosen as targets.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/bookkeeper/client/BKException.BKNotEnoughBookiesException.html" title="class in org.apache.bookkeeper.client">BKException.BKNotEnoughBookiesException</a></code> - if not enough bookies available.</dd></dl> +</li> +</ul> +<a name="replaceBookie(org.apache.bookkeeper.net.BookieSocketAddress, java.util.Set)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>replaceBookie</h4> +<pre>org.apache.bookkeeper.net.BookieSocketAddress replaceBookie(org.apache.bookkeeper.net.BookieSocketAddress bookieToReplace, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><org.apache.bookkeeper.net.BookieSocketAddress> excludeBookies) + throws <a href="../../../../org/apache/bookkeeper/client/BKException.BKNotEnoughBookiesException.html" title="class in org.apache.bookkeeper.client">BKException.BKNotEnoughBookiesException</a></pre> +<div class="block">Choose a new bookie to replace <i>bookieToReplace</i>. If no bookie available in the cluster, + <a href="../../../../org/apache/bookkeeper/client/BKException.BKNotEnoughBookiesException.html" title="class in org.apache.bookkeeper.client"><code>BKException.BKNotEnoughBookiesException</code></a> is thrown.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bookieToReplace</code> - bookie to replace</dd><dd><code>excludeBookies</code> - bookies that should not be considered as candidate.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the bookie chosen as target.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/bookkeeper/client/BKException.BKNotEnoughBookiesException.html" title="class in org.apache.bookkeeper.client">BKException.BKNotEnoughBookiesException</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/EnsemblePlacementPolicy.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/bookkeeper/client/DefaultEnsemblePlacementPolicy.html" title="class in org.apache.bookkeeper.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/bookkeeper/client/LedgerChecker.html" title="class in org.apache.bookkeeper.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" target="_top">Frames</a></li> +<li><a href="EnsemblePlacementPolicy.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2011-2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html> Added: bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/LedgerChecker.html URL: http://svn.apache.org/viewvc/bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/LedgerChecker.html?rev=1743979&view=auto ============================================================================== --- bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/LedgerChecker.html (added) +++ bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/LedgerChecker.html Sun May 15 21:38:37 2016 @@ -0,0 +1,302 @@ +<!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_80) on Sun May 15 21:18:06 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>LedgerChecker (bookkeeper 4.4.0 API)</title> +<meta name="date" content="2016-05-15"> +<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="LedgerChecker (bookkeeper 4.4.0 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/LedgerChecker.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/bookkeeper/client/LedgerEntry.html" title="class in org.apache.bookkeeper.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/bookkeeper/client/LedgerChecker.html" target="_top">Frames</a></li> +<li><a href="LedgerChecker.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.bookkeeper.client</div> +<h2 title="Class LedgerChecker" class="title">Class LedgerChecker</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.bookkeeper.client.LedgerChecker</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LedgerChecker</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Checks the complete ledger and finds the UnderReplicated fragments if any</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.apache.bookkeeper.proto.BookieClient</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerChecker.html#bookieClient">bookieClient</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="../../../../org/apache/bookkeeper/client/LedgerChecker.html#LedgerChecker(org.apache.bookkeeper.client.BookKeeper)">LedgerChecker</a></strong>(<a href="../../../../org/apache/bookkeeper/client/BookKeeper.html" title="class in org.apache.bookkeeper.client">BookKeeper</a> bkc)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerChecker.html#checkLedger(org.apache.bookkeeper.client.LedgerHandle,%20org.apache.bookkeeper.proto.BookkeeperInternalCallbacks.GenericCallback)">checkLedger</a></strong>(<a href="../../../../org/apache/bookkeeper/client/LedgerHandle.html" title="class in org.apache.bookkeeper.client">LedgerHandle</a> lh, + org.apache.bookkeeper.proto.BookkeeperInternalCallbacks.GenericCallback<<a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="../../../../org/apache/bookkeeper/client/LedgerFragment.html" title="class in org.apache.bookkeeper.client">LedgerFragment</a>>> cb)</code> +<div class="block">Check that all the fragments in the passed in ledger, and report those + which are missing.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="bookieClient"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>bookieClient</h4> +<pre>public final org.apache.bookkeeper.proto.BookieClient bookieClient</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LedgerChecker(org.apache.bookkeeper.client.BookKeeper)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LedgerChecker</h4> +<pre>public LedgerChecker(<a href="../../../../org/apache/bookkeeper/client/BookKeeper.html" title="class in org.apache.bookkeeper.client">BookKeeper</a> bkc)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="checkLedger(org.apache.bookkeeper.client.LedgerHandle, org.apache.bookkeeper.proto.BookkeeperInternalCallbacks.GenericCallback)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>checkLedger</h4> +<pre>public void checkLedger(<a href="../../../../org/apache/bookkeeper/client/LedgerHandle.html" title="class in org.apache.bookkeeper.client">LedgerHandle</a> lh, + org.apache.bookkeeper.proto.BookkeeperInternalCallbacks.GenericCallback<<a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="../../../../org/apache/bookkeeper/client/LedgerFragment.html" title="class in org.apache.bookkeeper.client">LedgerFragment</a>>> cb)</pre> +<div class="block">Check that all the fragments in the passed in ledger, and report those + which are missing.</div> +</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/LedgerChecker.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/bookkeeper/client/EnsemblePlacementPolicy.html" title="interface in org.apache.bookkeeper.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/bookkeeper/client/LedgerEntry.html" title="class in org.apache.bookkeeper.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/bookkeeper/client/LedgerChecker.html" target="_top">Frames</a></li> +<li><a href="LedgerChecker.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2011-2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html> Added: bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/LedgerEntry.html URL: http://svn.apache.org/viewvc/bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/LedgerEntry.html?rev=1743979&view=auto ============================================================================== --- bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/LedgerEntry.html (added) +++ bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/LedgerEntry.html Sun May 15 21:38:37 2016 @@ -0,0 +1,278 @@ +<!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_80) on Sun May 15 21:18:06 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>LedgerEntry (bookkeeper 4.4.0 API)</title> +<meta name="date" content="2016-05-15"> +<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="LedgerEntry (bookkeeper 4.4.0 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/LedgerEntry.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/bookkeeper/client/LedgerChecker.html" title="class in org.apache.bookkeeper.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/bookkeeper/client/LedgerFragment.html" title="class in org.apache.bookkeeper.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/bookkeeper/client/LedgerEntry.html" target="_top">Frames</a></li> +<li><a href="LedgerEntry.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.bookkeeper.client</div> +<h2 title="Class LedgerEntry" class="title">Class LedgerEntry</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.bookkeeper.client.LedgerEntry</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LedgerEntry</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Ledger entry. Its a simple tuple containing the ledger id, the entry-id, and + the entry content.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerEntry.html#getEntry()">getEntry</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerEntry.html#getEntryId()">getEntryId</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerEntry.html#getEntryInputStream()">getEntryInputStream</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerEntry.html#getLedgerId()">getLedgerId</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerEntry.html#getLength()">getLength</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</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="getLedgerId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLedgerId</h4> +<pre>public long getLedgerId()</pre> +</li> +</ul> +<a name="getEntryId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEntryId</h4> +<pre>public long getEntryId()</pre> +</li> +</ul> +<a name="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public long getLength()</pre> +</li> +</ul> +<a name="getEntry()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEntry</h4> +<pre>public byte[] getEntry()</pre> +</li> +</ul> +<a name="getEntryInputStream()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getEntryInputStream</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> getEntryInputStream()</pre> +</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/LedgerEntry.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/bookkeeper/client/LedgerChecker.html" title="class in org.apache.bookkeeper.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/bookkeeper/client/LedgerFragment.html" title="class in org.apache.bookkeeper.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/bookkeeper/client/LedgerEntry.html" target="_top">Frames</a></li> +<li><a href="LedgerEntry.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2011-2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html> Added: bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/LedgerFragment.html URL: http://svn.apache.org/viewvc/bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/LedgerFragment.html?rev=1743979&view=auto ============================================================================== --- bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/LedgerFragment.html (added) +++ bookkeeper/site/trunk/content/docs/r4.4.0/apidocs/org/apache/bookkeeper/client/LedgerFragment.html Sun May 15 21:38:37 2016 @@ -0,0 +1,339 @@ +<!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_80) on Sun May 15 21:18:06 UTC 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>LedgerFragment (bookkeeper 4.4.0 API)</title> +<meta name="date" content="2016-05-15"> +<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="LedgerFragment (bookkeeper 4.4.0 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/LedgerFragment.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/bookkeeper/client/LedgerEntry.html" title="class in org.apache.bookkeeper.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/bookkeeper/client/LedgerFragmentReplicator.html" title="class in org.apache.bookkeeper.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/bookkeeper/client/LedgerFragment.html" target="_top">Frames</a></li> +<li><a href="LedgerFragment.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.bookkeeper.client</div> +<h2 title="Class LedgerFragment" class="title">Class LedgerFragment</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.bookkeeper.client.LedgerFragment</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LedgerFragment</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Represents the entries of a segment of a ledger which are stored on a single + bookie in the segments bookie ensemble. + + Used for checking and recovery</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>org.apache.bookkeeper.net.BookieSocketAddress</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerFragment.html#getAddress()">getAddress</a></strong>()</code> +<div class="block">Gets the failedBookie address</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerFragment.html#getBookiesIndex()">getBookiesIndex</a></strong>()</code> +<div class="block">Gets the failedBookie index</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.bookkeeper.net.BookieSocketAddress></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerFragment.html#getEnsemble()">getEnsemble</a></strong>()</code> +<div class="block">Gets the ensemble of fragment</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerFragment.html#getFirstStoredEntryId()">getFirstStoredEntryId</a></strong>()</code> +<div class="block">Gets the first stored entry id of the fragment in failed bookie.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerFragment.html#getLastStoredEntryId()">getLastStoredEntryId</a></strong>()</code> +<div class="block">Gets the last stored entry id of the fragment in failed bookie.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerFragment.html#isClosed()">isClosed</a></strong>()</code> +<div class="block">Returns true, if and only if the ledger fragment will never be modified + by any of the clients in future, otherwise false.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/bookkeeper/client/LedgerFragment.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com /javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</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="isClosed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClosed</h4> +<pre>public boolean isClosed()</pre> +<div class="block">Returns true, if and only if the ledger fragment will never be modified + by any of the clients in future, otherwise false. i.e, + <ol> + <li>If ledger is in closed state, then no other clients can modify this + fragment.</li> + <li>If ledger is not in closed state and the current fragment is not a + last fragment, then no one will modify this fragment.</li> + </ol></div> +</li> +</ul> +<a name="getAddress()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAddress</h4> +<pre>public org.apache.bookkeeper.net.BookieSocketAddress getAddress()</pre> +<div class="block">Gets the failedBookie address</div> +</li> +</ul> +<a name="getBookiesIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBookiesIndex</h4> +<pre>public int getBookiesIndex()</pre> +<div class="block">Gets the failedBookie index</div> +</li> +</ul> +<a name="getFirstStoredEntryId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFirstStoredEntryId</h4> +<pre>public long getFirstStoredEntryId()</pre> +<div class="block">Gets the first stored entry id of the fragment in failed bookie.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>entryId</dd></dl> +</li> +</ul> +<a name="getLastStoredEntryId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastStoredEntryId</h4> +<pre>public long getLastStoredEntryId()</pre> +<div class="block">Gets the last stored entry id of the fragment in failed bookie.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>entryId</dd></dl> +</li> +</ul> +<a name="getEnsemble()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnsemble</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.bookkeeper.net.BookieSocketAddress> getEnsemble()</pre> +<div class="block">Gets the ensemble of fragment</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the ensemble for the segment which this fragment is a part of</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></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/LedgerFragment.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/bookkeeper/client/LedgerEntry.html" title="class in org.apache.bookkeeper.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/bookkeeper/client/LedgerFragmentReplicator.html" title="class in org.apache.bookkeeper.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/bookkeeper/client/LedgerFragment.html" target="_top">Frames</a></li> +<li><a href="LedgerFragment.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2011-2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
