http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/ef7245e8/content/docs/latest/api/java/org/apache/distributedlog/BKDistributedLogNamespace.html ---------------------------------------------------------------------- diff --git a/content/docs/latest/api/java/org/apache/distributedlog/BKDistributedLogNamespace.html b/content/docs/latest/api/java/org/apache/distributedlog/BKDistributedLogNamespace.html new file mode 100644 index 0000000..4d8888a --- /dev/null +++ b/content/docs/latest/api/java/org/apache/distributedlog/BKDistributedLogNamespace.html @@ -0,0 +1,668 @@ +<!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 (1.8.0_121) on Wed Apr 26 11:46:58 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>BKDistributedLogNamespace (Apache DistributedLog for Java, version latest)</title> +<meta name="date" content="2017-04-26"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="BKDistributedLogNamespace (Apache DistributedLog for Java, version latest)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/BKDistributedLogNamespace.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/distributedlog/AsyncNotification.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/BookKeeperClient.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/BKDistributedLogNamespace.html" target="_top">Frames</a></li> +<li><a href="BKDistributedLogNamespace.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.distributedlog</div> +<h2 title="Class BKDistributedLogNamespace" class="title">Class BKDistributedLogNamespace</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.distributedlog.BKDistributedLogNamespace</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace">DistributedLogNamespace</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">BKDistributedLogNamespace</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/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace">DistributedLogNamespace</a></pre> +<div class="block">BKDistributedLogNamespace is the default implementation of <a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace"><code>DistributedLogNamespace</code></a>. It uses + zookeeper for metadata storage and bookkeeper for data storage. + <h3>Metrics</h3> + + <h4>ZooKeeper Client</h4> + See <a href="../../../org/apache/distributedlog/ZooKeeperClient.html" title="class in org.apache.distributedlog"><code>ZooKeeperClient</code></a> for detail sub-stats. + <ul> + <li> `scope`/dlzk_factory_writer_shared/* : stats about the zookeeper client shared by all DL writers. + <li> `scope`/dlzk_factory_reader_shared/* : stats about the zookeeper client shared by all DL readers. + <li> `scope`/bkzk_factory_writer_shared/* : stats about the zookeeper client used by bookkeeper client + shared by all DL writers. + <li> `scope`/bkzk_factory_reader_shared/* : stats about the zookeeper client used by bookkeeper client + shared by all DL readers. + </ul> + + <h4>BookKeeper Client</h4> + BookKeeper client stats are exposed directly to current scope. See <a href="../../../org/apache/distributedlog/BookKeeperClient.html" title="class in org.apache.distributedlog"><code>BookKeeperClient</code></a> for detail stats. + + <h4>Utils</h4> + <ul> + <li> `scope`/factory/thread_pool/* : stats about the ordered scheduler used by this namespace. + See <code>OrderedScheduler</code>. + <li> `scope`/factory/readahead_thread_pool/* : stats about the readahead thread pool executor + used by this namespace. See <code>MonitoredScheduledThreadPoolExecutor</code>. + <li> `scope`/writeLimiter/* : stats about the global write limiter used by this namespace. + See <code>PermitLimiter</code>. + </ul> + + <h4>DistributedLogManager</h4> + + All the core stats about reader and writer are exposed under current scope via <code>BKDistributedLogManager</code>.</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="memberSummary" 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>protected <a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/atomic/AtomicBoolean.html?is-external=true"; title="class or interface in java.util.concurrent.atomic">AtomicBoolean</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#closed">closed</a></span></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="memberSummary" 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><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#BKDistributedLogNamespace-org.apache.distributedlog.DistributedLogConfiguration-java.net.URI-org.apache.distributedlog.namespace.NamespaceDriver-org.apache.distributedlog.util.OrderedScheduler-org.apache.bookkeeper.feature.FeatureProvider-org.apache.distributedlog.util.PermitLimiter-org.apache.distributedlog.injector.AsyncFailureInjector-org.apache.bookkeeper.stats.StatsLogger-org.apache.bookkeeper.stats.StatsLogger-java.lang.String-int-">BKDistributedLogNamespace</a></span>(<a href="../../../org/apache/distributedlog/DistributedLogConfiguration.html" title="class in org.apache.distributedlog">DistributedLogConfiguration</a> conf, + <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> uri, + <a href="../../../org/apache/distributedlog/namespace/NamespaceDriver.html" title="interface in org.apache.distributedlog.namespace">NamespaceDriver</a> driver, + org.apache.distributedlog.util.OrderedScheduler scheduler, + org.apache.bookkeeper.feature.FeatureProvider featureProvider, + org.apache.distributedlog.util.PermitLimiter writeLimiter, + org.apache.distributedlog.injector.AsyncFailureInjector failureInjector, + org.apache.bookkeeper.stats.StatsLogger statsLogger, + org.apache.bookkeeper.stats.StatsLogger perLogStatsLogger, + <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> clientId, + int regionId)</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#close--">close</a></span>()</code> +<div class="block">Close the distributed log manager factory, freeing any resources it may hold.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>org.apache.distributedlog.acl.AccessControlManager</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#createAccessControlManager--">createAccessControlManager</a></span>()</code> +<div class="block">Create an access control manager to manage/check acl for logs.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#createLog-java.lang.String-">createLog</a></span>(<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> logName)</code> +<div class="block">Create a log named <i>logName</i>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#deleteLog-java.lang.String-">deleteLog</a></span>(<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> logName)</code> +<div class="block">Delete a log named <i>logName</i>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<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><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#getLogs--">getLogs</a></span>()</code> +<div class="block">Retrieve the logs under the namespace.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/namespace/NamespaceDriver.html" title="interface in org.apache.distributedlog.namespace">NamespaceDriver</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#getNamespaceDriver--">getNamespaceDriver</a></span>()</code> +<div class="block">Get the namespace driver used by this namespace.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#logExists-java.lang.String-">logExists</a></span>(<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> logName)</code> +<div class="block">Check whether the log <i>logName</i> exist.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/DistributedLogManager.html" title="interface in org.apache.distributedlog">DistributedLogManager</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#openLog-java.lang.String-">openLog</a></span>(<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> logName)</code> +<div class="block">Open a log named <i>logName</i>.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/distributedlog/DistributedLogManager.html" title="interface in org.apache.distributedlog">DistributedLogManager</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#openLog-java.lang.String-com.google.common.base.Optional-com.google.common.base.Optional-com.google.common.base.Optional-">openLog</a></span>(<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> logName, + com.google.common.base.Optional<<a href="../../../org/apache/distributedlog/DistributedLogConfiguration.html" title="class in org.apache.distributedlog">DistributedLogConfiguration</a>> logConf, + com.google.common.base.Optional<org.apache.distributedlog.config.DynamicDistributedLogConfiguration> dynamicLogConf, + com.google.common.base.Optional<org.apache.bookkeeper.stats.StatsLogger> perStreamStatsLogger)</code> +<div class="block">Open a log named <i>logName</i> with specific log configurations.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../org/apache/distributedlog/DistributedLogManager.html" title="interface in org.apache.distributedlog">DistributedLogManager</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#openLogInternal-java.net.URI-java.lang.String-com.google.common.base.Optional-com.google.common.base.Optional-">openLogInternal</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> uri, + <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> nameOfLogStream, + com.google.common.base.Optional<<a href="../../../org/apache/distributedlog/DistributedLogConfiguration.html" title="class in org.apache.distributedlog">DistributedLogConfiguration</a>> logConfiguration, + com.google.common.base.Optional<org.apache.distributedlog.config.DynamicDistributedLogConfiguration> dynamicLogConfiguration)</code> +<div class="block">Open the log in location <i>uri</i>.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BKDistributedLogNamespace.html#registerNamespaceListener-org.apache.distributedlog.callback.NamespaceListener-">registerNamespaceListener</a></span>(<a href="../../../org/apache/distributedlog/callback/NamespaceListener.html" title="interface in org.apache.distributedlog.callback">NamespaceListener</a> listener)</code> +<div class="block">Register namespace listener on stream updates under the namespace.</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-int-"; 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="closed"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>closed</h4> +<pre>protected final <a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/atomic/AtomicBoolean.html?is-external=true"; title="class or interface in java.util.concurrent.atomic">AtomicBoolean</a> closed</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BKDistributedLogNamespace-org.apache.distributedlog.DistributedLogConfiguration-java.net.URI-org.apache.distributedlog.namespace.NamespaceDriver-org.apache.distributedlog.util.OrderedScheduler-org.apache.bookkeeper.feature.FeatureProvider-org.apache.distributedlog.util.PermitLimiter-org.apache.distributedlog.injector.AsyncFailureInjector-org.apache.bookkeeper.stats.StatsLogger-org.apache.bookkeeper.stats.StatsLogger-java.lang.String-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BKDistributedLogNamespace</h4> +<pre>public BKDistributedLogNamespace(<a href="../../../org/apache/distributedlog/DistributedLogConfiguration.html" title="class in org.apache.distributedlog">DistributedLogConfiguration</a> conf, + <a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> uri, + <a href="../../../org/apache/distributedlog/namespace/NamespaceDriver.html" title="interface in org.apache.distributedlog.namespace">NamespaceDriver</a> driver, + org.apache.distributedlog.util.OrderedScheduler scheduler, + org.apache.bookkeeper.feature.FeatureProvider featureProvider, + org.apache.distributedlog.util.PermitLimiter writeLimiter, + org.apache.distributedlog.injector.AsyncFailureInjector failureInjector, + org.apache.bookkeeper.stats.StatsLogger statsLogger, + org.apache.bookkeeper.stats.StatsLogger perLogStatsLogger, + <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> clientId, + int regionId)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getNamespaceDriver--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNamespaceDriver</h4> +<pre>public <a href="../../../org/apache/distributedlog/namespace/NamespaceDriver.html" title="interface in org.apache.distributedlog.namespace">NamespaceDriver</a> getNamespaceDriver()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#getNamespaceDriver--">DistributedLogNamespace</a></code></span></div> +<div class="block">Get the namespace driver used by this namespace.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#getNamespaceDriver--">getNamespaceDriver</a></code> in interface <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace">DistributedLogNamespace</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>namespace driver</dd> +</dl> +</li> +</ul> +<a name="createLog-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLog</h4> +<pre>public void createLog(<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> logName) + throws <a href="../../../org/apache/distributedlog/exceptions/InvalidStreamNameException.html" title="class in org.apache.distributedlog.exceptions">InvalidStreamNameException</a>, + <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#createLog-java.lang.String-">DistributedLogNamespace</a></code></span></div> +<div class="block">Create a log named <i>logName</i>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#createLog-java.lang.String-">createLog</a></code> in interface <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace">DistributedLogNamespace</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>logName</code> - name of the log</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/exceptions/InvalidStreamNameException.html" title="class in org.apache.distributedlog.exceptions">InvalidStreamNameException</a></code> - if log name is invalid.</dd> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - when encountered issues with backend.</dd> +</dl> +</li> +</ul> +<a name="deleteLog-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteLog</h4> +<pre>public void deleteLog(<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> logName) + throws <a href="../../../org/apache/distributedlog/exceptions/InvalidStreamNameException.html" title="class in org.apache.distributedlog.exceptions">InvalidStreamNameException</a>, + <a href="../../../org/apache/distributedlog/exceptions/LogNotFoundException.html" title="class in org.apache.distributedlog.exceptions">LogNotFoundException</a>, + <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#deleteLog-java.lang.String-">DistributedLogNamespace</a></code></span></div> +<div class="block">Delete a log named <i>logName</i>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#deleteLog-java.lang.String-">deleteLog</a></code> in interface <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace">DistributedLogNamespace</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>logName</code> - name of the log</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/exceptions/InvalidStreamNameException.html" title="class in org.apache.distributedlog.exceptions">InvalidStreamNameException</a></code> - if log name is invalid</dd> +<dd><code><a href="../../../org/apache/distributedlog/exceptions/LogNotFoundException.html" title="class in org.apache.distributedlog.exceptions">LogNotFoundException</a></code> - if log doesn't exist</dd> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - when encountered issues with backend</dd> +</dl> +</li> +</ul> +<a name="openLog-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openLog</h4> +<pre>public <a href="../../../org/apache/distributedlog/DistributedLogManager.html" title="interface in org.apache.distributedlog">DistributedLogManager</a> openLog(<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> logName) + throws <a href="../../../org/apache/distributedlog/exceptions/InvalidStreamNameException.html" title="class in org.apache.distributedlog.exceptions">InvalidStreamNameException</a>, + <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#openLog-java.lang.String-">DistributedLogNamespace</a></code></span></div> +<div class="block">Open a log named <i>logName</i>. + A distributedlog manager is returned to access log <i>logName</i>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#openLog-java.lang.String-">openLog</a></code> in interface <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace">DistributedLogNamespace</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>logName</code> - name of the log</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>distributedlog manager instance.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/exceptions/InvalidStreamNameException.html" title="class in org.apache.distributedlog.exceptions">InvalidStreamNameException</a></code> - if log name is invalid.</dd> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - when encountered issues with backend.</dd> +</dl> +</li> +</ul> +<a name="openLog-java.lang.String-com.google.common.base.Optional-com.google.common.base.Optional-com.google.common.base.Optional-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openLog</h4> +<pre>public <a href="../../../org/apache/distributedlog/DistributedLogManager.html" title="interface in org.apache.distributedlog">DistributedLogManager</a> openLog(<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> logName, + com.google.common.base.Optional<<a href="../../../org/apache/distributedlog/DistributedLogConfiguration.html" title="class in org.apache.distributedlog">DistributedLogConfiguration</a>> logConf, + com.google.common.base.Optional<org.apache.distributedlog.config.DynamicDistributedLogConfiguration> dynamicLogConf, + com.google.common.base.Optional<org.apache.bookkeeper.stats.StatsLogger> perStreamStatsLogger) + throws <a href="../../../org/apache/distributedlog/exceptions/InvalidStreamNameException.html" title="class in org.apache.distributedlog.exceptions">InvalidStreamNameException</a>, + <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#openLog-java.lang.String-com.google.common.base.Optional-com.google.common.base.Optional-com.google.common.base.Optional-">DistributedLogNamespace</a></code></span></div> +<div class="block">Open a log named <i>logName</i> with specific log configurations. + + <p>This method allows the caller to override global configuration settings by + supplying log configuration overrides. Log config overrides come in two flavors, + static and dynamic. Static config never changes in the lifecyle of <code>DistributedLogManager</code>, + dynamic config changes by reloading periodically and safe to access from any context.</p></div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#openLog-java.lang.String-com.google.common.base.Optional-com.google.common.base.Optional-com.google.common.base.Optional-">openLog</a></code> in interface <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace">DistributedLogNamespace</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>logName</code> - name of the log</dd> +<dd><code>logConf</code> - static log configuration</dd> +<dd><code>dynamicLogConf</code> - dynamic log configuration</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>distributedlog manager instance.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/exceptions/InvalidStreamNameException.html" title="class in org.apache.distributedlog.exceptions">InvalidStreamNameException</a></code> - if log name is invalid.</dd> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - when encountered issues with backend.</dd> +</dl> +</li> +</ul> +<a name="logExists-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logExists</h4> +<pre>public boolean logExists(<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> logName) + throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a>, + <a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#logExists-java.lang.String-">DistributedLogNamespace</a></code></span></div> +<div class="block">Check whether the log <i>logName</i> exist.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#logExists-java.lang.String-">logExists</a></code> in interface <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace">DistributedLogNamespace</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>logName</code> - name of the log</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if the log exists, otherwise <code>false</code>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - when encountered exceptions on checking</dd> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code></dd> +</dl> +</li> +</ul> +<a name="getLogs--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLogs</h4> +<pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<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>> getLogs() + throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#getLogs--">DistributedLogNamespace</a></code></span></div> +<div class="block">Retrieve the logs under the namespace.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#getLogs--">getLogs</a></code> in interface <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace">DistributedLogNamespace</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>iterator of the logs under the namespace.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - when encountered issues with backend.</dd> +</dl> +</li> +</ul> +<a name="registerNamespaceListener-org.apache.distributedlog.callback.NamespaceListener-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerNamespaceListener</h4> +<pre>public void registerNamespaceListener(<a href="../../../org/apache/distributedlog/callback/NamespaceListener.html" title="interface in org.apache.distributedlog.callback">NamespaceListener</a> listener)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#registerNamespaceListener-org.apache.distributedlog.callback.NamespaceListener-">DistributedLogNamespace</a></code></span></div> +<div class="block">Register namespace listener on stream updates under the namespace.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#registerNamespaceListener-org.apache.distributedlog.callback.NamespaceListener-">registerNamespaceListener</a></code> in interface <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace">DistributedLogNamespace</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>listener</code> - listener to receive stream updates under the namespace</dd> +</dl> +</li> +</ul> +<a name="createAccessControlManager--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createAccessControlManager</h4> +<pre>public org.apache.distributedlog.acl.AccessControlManager createAccessControlManager() + throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#createAccessControlManager--">DistributedLogNamespace</a></code></span></div> +<div class="block">Create an access control manager to manage/check acl for logs.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#createAccessControlManager--">createAccessControlManager</a></code> in interface <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace">DistributedLogNamespace</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>access control manager for logs under the namespace.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="openLogInternal-java.net.URI-java.lang.String-com.google.common.base.Optional-com.google.common.base.Optional-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openLogInternal</h4> +<pre>protected <a href="../../../org/apache/distributedlog/DistributedLogManager.html" title="interface in org.apache.distributedlog">DistributedLogManager</a> openLogInternal(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> uri, + <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> nameOfLogStream, + com.google.common.base.Optional<<a href="../../../org/apache/distributedlog/DistributedLogConfiguration.html" title="class in org.apache.distributedlog">DistributedLogConfiguration</a>> logConfiguration, + com.google.common.base.Optional<org.apache.distributedlog.config.DynamicDistributedLogConfiguration> dynamicLogConfiguration) + throws <a href="../../../org/apache/distributedlog/exceptions/InvalidStreamNameException.html" title="class in org.apache.distributedlog.exceptions">InvalidStreamNameException</a>, + <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Open the log in location <i>uri</i>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>uri</code> - location to store the log</dd> +<dd><code>nameOfLogStream</code> - name of the log</dd> +<dd><code>logConfiguration</code> - optional stream configuration</dd> +<dd><code>dynamicLogConfiguration</code> - dynamic stream configuration overrides.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>distributedlog manager instance.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/exceptions/InvalidStreamNameException.html" title="class in org.apache.distributedlog.exceptions">InvalidStreamNameException</a></code> - if the stream name is invalid</dd> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block">Close the distributed log manager factory, freeing any resources it may hold.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html#close--">close</a></code> in interface <code><a href="../../../org/apache/distributedlog/namespace/DistributedLogNamespace.html" title="interface in org.apache.distributedlog.namespace">DistributedLogNamespace</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/BKDistributedLogNamespace.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/distributedlog/AsyncNotification.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/BookKeeperClient.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/BKDistributedLogNamespace.html" target="_top">Frames</a></li> +<li><a href="BKDistributedLogNamespace.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 © 2016-2017 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/ef7245e8/content/docs/latest/api/java/org/apache/distributedlog/BookKeeperClient.html ---------------------------------------------------------------------- diff --git a/content/docs/latest/api/java/org/apache/distributedlog/BookKeeperClient.html b/content/docs/latest/api/java/org/apache/distributedlog/BookKeeperClient.html new file mode 100644 index 0000000..db27eed --- /dev/null +++ b/content/docs/latest/api/java/org/apache/distributedlog/BookKeeperClient.html @@ -0,0 +1,313 @@ +<!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 (1.8.0_121) on Wed Apr 26 11:46:58 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>BookKeeperClient (Apache DistributedLog for Java, version latest)</title> +<meta name="date" content="2017-04-26"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="BookKeeperClient (Apache DistributedLog for Java, version latest)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/BookKeeperClient.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/distributedlog/BKDistributedLogNamespace.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/BookKeeperClient.html" target="_top">Frames</a></li> +<li><a href="BookKeeperClient.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.distributedlog</div> +<h2 title="Class BookKeeperClient" class="title">Class BookKeeperClient</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.distributedlog.BookKeeperClient</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">BookKeeperClient</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">BookKeeper Client wrapper over <code>BookKeeper</code>. + + <h3>Metrics</h3> + <ul> + <li> bookkeeper operation stats are exposed under current scope by <code>BookKeeper</code> + </ul></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClient.html#checkClosedOrInError--">checkClosedOrInError</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClient.html#close--">close</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>com.twitter.util.Future<org.apache.bookkeeper.client.LedgerHandle></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClient.html#createLedger-int-int-int-">createLedger</a></span>(int ensembleSize, + int writeQuorumSize, + int ackQuorumSize)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClient.html#deleteLedger-long-boolean-">deleteLedger</a></span>(long lid, + boolean ignoreNonExistentLedger)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>org.apache.bookkeeper.client.BookKeeper</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/BookKeeperClient.html#get--">get</a></span>()</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-int-"; 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="get--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public org.apache.bookkeeper.client.BookKeeper get() + throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="createLedger-int-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createLedger</h4> +<pre>public com.twitter.util.Future<org.apache.bookkeeper.client.LedgerHandle> createLedger(int ensembleSize, + int writeQuorumSize, + int ackQuorumSize)</pre> +</li> +</ul> +<a name="deleteLedger-long-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteLedger</h4> +<pre>public com.twitter.util.Future<<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true"; title="class or interface in java.lang">Void</a>> deleteLedger(long lid, + boolean ignoreNonExistentLedger)</pre> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +</li> +</ul> +<a name="checkClosedOrInError--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>checkClosedOrInError</h4> +<pre>public void checkClosedOrInError() + throws <a href="../../../org/apache/distributedlog/exceptions/AlreadyClosedException.html" title="class in org.apache.distributedlog.exceptions">AlreadyClosedException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/exceptions/AlreadyClosedException.html" title="class in org.apache.distributedlog.exceptions">AlreadyClosedException</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/BookKeeperClient.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/distributedlog/BKDistributedLogNamespace.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/BookKeeperClientBuilder.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/BookKeeperClient.html" target="_top">Frames</a></li> +<li><a href="BookKeeperClient.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 © 2016-2017 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
