http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/1e6843e5/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogWriter.html ---------------------------------------------------------------------- diff --git a/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogWriter.html b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogWriter.html new file mode 100644 index 0000000..f9a5244 --- /dev/null +++ b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/LogWriter.html @@ -0,0 +1,353 @@ +<!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_92) on Sun Jan 08 19:29:05 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>LogWriter (Apache DistributedLog for Java, version 0.4.0-incubating)</title> +<meta name="date" content="2017-01-08"> +<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="LogWriter (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":38}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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/LogWriter.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/LogSegmentMetadata.TruncationStatus.html" title="enum in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/MetadataAccessor.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/LogWriter.html" target="_top">Frames</a></li> +<li><a href="LogWriter.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="Interface LogWriter" class="title">Interface LogWriter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../org/apache/distributedlog/io/Abortable.html" title="interface in org.apache.distributedlog.io">Abortable</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">LogWriter</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a>, <a href="../../../org/apache/distributedlog/io/Abortable.html" title="interface in org.apache.distributedlog.io">Abortable</a></pre> +</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogWriter.html#flushAndSync--">flushAndSync</a></span>()</code> +<div class="block">Flush and sync all data that is ready to be flush + <a href="../../../org/apache/distributedlog/LogWriter.html#setReadyToFlush--"><code>setReadyToFlush()</code></a> into underlying persistent store.</div> +</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/LogWriter.html#markEndOfStream--">markEndOfStream</a></span>()</code> +<div class="block">Flushes all the data up to this point, + adds the end of stream marker and marks the stream + as read-only in the metadata.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogWriter.html#setReadyToFlush--">setReadyToFlush</a></span>()</code> +<div class="block">All data that has been written to the stream so far will be sent to + persistent storage.</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/LogWriter.html#write-org.apache.distributedlog.LogRecord-">write</a></span>(<a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog">LogRecord</a> record)</code> +<div class="block">Write a log record to the stream.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/LogWriter.html#writeBulk-java.util.List-">writeBulk</a></span>(<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><<a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog">LogRecord</a>> records)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.io.Closeable"> +<!-- --> +</a> +<h3>Methods inherited from interface java.io.<a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a></h3> +<code><a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close--"; title="class or interface in java.io">close</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.distributedlog.io.Abortable"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.distributedlog.io.<a href="../../../org/apache/distributedlog/io/Abortable.html" title="interface in org.apache.distributedlog.io">Abortable</a></h3> +<code><a href="../../../org/apache/distributedlog/io/Abortable.html#abort--">abort</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="write-org.apache.distributedlog.LogRecord-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>void write(<a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog">LogRecord</a> record) + 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">Write a log record to the stream.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>record</code> - single log record</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="writeBulk-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeBulk</h4> +<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +int writeBulk(<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><<a href="../../../org/apache/distributedlog/LogRecord.html" title="class in org.apache.distributedlog">LogRecord</a>> records) + 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="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Write a list of log records to the stream.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>records</code> - list of log records</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="setReadyToFlush--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReadyToFlush</h4> +<pre>long setReadyToFlush() + 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">All data that has been written to the stream so far will be sent to + persistent storage. + The transmission is asynchronous and new data can be still written to the + stream while flushing is performed. + + TODO: rename this to flush()</div> +<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="flushAndSync--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flushAndSync</h4> +<pre>long flushAndSync() + 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">Flush and sync all data that is ready to be flush + <a href="../../../org/apache/distributedlog/LogWriter.html#setReadyToFlush--"><code>setReadyToFlush()</code></a> into underlying persistent store.</div> +<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> - TODO: rename this to commit()</dd> +</dl> +</li> +</ul> +<a name="markEndOfStream--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>markEndOfStream</h4> +<pre>void markEndOfStream() + 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">Flushes all the data up to this point, + adds the end of stream marker and marks the stream + as read-only in the metadata. No appends to the + stream will be allowed after this point</div> +<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> +</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/LogWriter.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/LogSegmentMetadata.TruncationStatus.html" title="enum in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/MetadataAccessor.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/distributedlog/LogWriter.html" target="_top">Frames</a></li> +<li><a href="LogWriter.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>
http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/1e6843e5/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/MetadataAccessor.html ---------------------------------------------------------------------- diff --git a/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/MetadataAccessor.html b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/MetadataAccessor.html new file mode 100644 index 0000000..de9d55e --- /dev/null +++ b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/MetadataAccessor.html @@ -0,0 +1,336 @@ +<!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_92) on Sun Jan 08 19:29:05 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>MetadataAccessor (Apache DistributedLog for Java, version 0.4.0-incubating)</title> +<meta name="date" content="2017-01-08"> +<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="MetadataAccessor (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/MetadataAccessor.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/LogWriter.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/ReadUtils.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/MetadataAccessor.html" target="_top">Frames</a></li> +<li><a href="MetadataAccessor.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="Interface MetadataAccessor" class="title">Interface MetadataAccessor</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../org/apache/distributedlog/io/AsyncCloseable.html" title="interface in org.apache.distributedlog.io">AsyncCloseable</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">MetadataAccessor</span> +extends <a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a>, <a href="../../../org/apache/distributedlog/io/AsyncCloseable.html" title="interface in org.apache.distributedlog.io">AsyncCloseable</a></pre> +</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> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.distributedlog.io.AsyncCloseable"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.distributedlog.io.<a href="../../../org/apache/distributedlog/io/AsyncCloseable.html" title="interface in org.apache.distributedlog.io">AsyncCloseable</a></h3> +<code><a href="../../../org/apache/distributedlog/io/AsyncCloseable.html#CLOSE_FUNC">CLOSE_FUNC</a>, <a href="../../../org/apache/distributedlog/io/AsyncCloseable.html#CLOSE_FUNC_IGNORE_ERRORS">CLOSE_FUNC_IGNORE_ERRORS</a>, <a href="../../../org/apache/distributedlog/io/AsyncCloseable.html#NULL">NULL</a></code></li> +</ul> +</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/MetadataAccessor.html#close--">close</a></span>()</code> +<div class="block">Close the distributed log metadata, freeing any resources it may hold.</div> +</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/MetadataAccessor.html#createOrUpdateMetadata-byte:A-">createOrUpdateMetadata</a></span>(byte[] metadata)</code> </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/MetadataAccessor.html#deleteMetadata--">deleteMetadata</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/MetadataAccessor.html#getMetadata--">getMetadata</a></span>()</code> </td> +</tr> +<tr id="i4" 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><span class="memberNameLink"><a href="../../../org/apache/distributedlog/MetadataAccessor.html#getStreamName--">getStreamName</a></span>()</code> +<div class="block">Get the name of the stream managed by this log manager</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.distributedlog.io.AsyncCloseable"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.distributedlog.io.<a href="../../../org/apache/distributedlog/io/AsyncCloseable.html" title="interface in org.apache.distributedlog.io">AsyncCloseable</a></h3> +<code><a href="../../../org/apache/distributedlog/io/AsyncCloseable.html#asyncClose--">asyncClose</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="getStreamName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStreamName</h4> +<pre><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> getStreamName()</pre> +<div class="block">Get the name of the stream managed by this log manager</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>streamName</dd> +</dl> +</li> +</ul> +<a name="createOrUpdateMetadata-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createOrUpdateMetadata</h4> +<pre>void createOrUpdateMetadata(byte[] metadata) + 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="deleteMetadata--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteMetadata</h4> +<pre>void deleteMetadata() + 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="getMetadata--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMetadata</h4> +<pre>byte[] getMetadata() + 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="close--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>void close() + 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">Close the distributed log metadata, freeing any resources it may hold.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true#close--"; title="class or interface in java.lang">close</a></code> in interface <code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true#close--"; title="class or interface in java.io">close</a></code> in interface <code><a href="http://download.oracle.com/javase/6/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a></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></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/MetadataAccessor.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/LogWriter.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/ReadUtils.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/MetadataAccessor.html" target="_top">Frames</a></li> +<li><a href="MetadataAccessor.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> http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/1e6843e5/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/ReadUtils.html ---------------------------------------------------------------------- diff --git a/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/ReadUtils.html b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/ReadUtils.html new file mode 100644 index 0000000..cd6a584 --- /dev/null +++ b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/ReadUtils.html @@ -0,0 +1,402 @@ +<!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_92) on Sun Jan 08 19:29:05 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ReadUtils (Apache DistributedLog for Java, version 0.4.0-incubating)</title> +<meta name="date" content="2017-01-08"> +<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="ReadUtils (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/ReadUtils.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/MetadataAccessor.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/ZooKeeperClient.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/ReadUtils.html" target="_top">Frames</a></li> +<li><a href="ReadUtils.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.distributedlog</div> +<h2 title="Class ReadUtils" class="title">Class ReadUtils</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.ReadUtils</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ReadUtils</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">Utility function for readers</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="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/ReadUtils.html#ReadUtils--">ReadUtils</a></span>()</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static com.twitter.util.Future<<a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/ReadUtils.html#asyncReadFirstUserRecord-java.lang.String-org.apache.distributedlog.LogSegmentMetadata-int-int-java.util.concurrent.atomic.AtomicInteger-java.util.concurrent.ExecutorService-org.apache.distributedlog.logsegment.LogSegmentEntryStore-org.apache.distributedlog.DLSN-">asyncReadFirstUserRecord</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> streamName, + <a href="../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a> l, + int scanStartBatchSize, + int scanMaxBatchSize, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/atomic/AtomicInteger.html?is-external=true"; title="class or interface in java.util.concurrent.atomic">AtomicInteger</a> numRecordsScanned, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/ExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent">ExecutorService</a> executorService, + <a href="../../../org/apache/distributedlog/logsegment/LogSegmentEntryStore.html" title="interface in org.apache.distributedlog.logsegment">LogSegmentEntryStore</a> entryStore, + <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> dlsn)</code> +<div class="block">Read first record from a log segment with a DLSN larger than that given.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static com.twitter.util.Future<<a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/ReadUtils.html#asyncReadLastRecord-java.lang.String-org.apache.distributedlog.LogSegmentMetadata-boolean-boolean-boolean-int-int-java.util.concurrent.atomic.AtomicInteger-java.util.concurrent.ExecutorService-org.apache.distributedlog.logsegment.LogSegmentEntryStore-">asyncReadLastRecord</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> streamName, + <a href="../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a> l, + boolean fence, + boolean includeControl, + boolean includeEndOfStream, + int scanStartBatchSize, + int scanMaxBatchSize, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/atomic/AtomicInteger.html?is-external=true"; title="class or interface in java.util.concurrent.atomic">AtomicInteger</a> numRecordsScanned, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/ExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent">ExecutorService</a> executorService, + <a href="../../../org/apache/distributedlog/logsegment/LogSegmentEntryStore.html" title="interface in org.apache.distributedlog.logsegment">LogSegmentEntryStore</a> entryStore)</code> +<div class="block">Read last record from a log segment.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static com.twitter.util.Future<com.google.common.base.Optional<<a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/ReadUtils.html#getLogRecordNotLessThanTxId-java.lang.String-org.apache.distributedlog.LogSegmentMetadata-long-java.util.concurrent.ExecutorService-org.apache.distributedlog.logsegment.LogSegmentEntryStore-int-">getLogRecordNotLessThanTxId</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, + <a href="../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a> segment, + long transactionId, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/ExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent">ExecutorService</a> executorService, + <a href="../../../org/apache/distributedlog/logsegment/LogSegmentEntryStore.html" title="interface in org.apache.distributedlog.logsegment">LogSegmentEntryStore</a> entryStore, + int nWays)</code> +<div class="block">Get the log record whose transaction id is not less than provided <code>transactionId</code>.</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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ReadUtils--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ReadUtils</h4> +<pre>public ReadUtils()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="asyncReadLastRecord-java.lang.String-org.apache.distributedlog.LogSegmentMetadata-boolean-boolean-boolean-int-int-java.util.concurrent.atomic.AtomicInteger-java.util.concurrent.ExecutorService-org.apache.distributedlog.logsegment.LogSegmentEntryStore-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asyncReadLastRecord</h4> +<pre>public static com.twitter.util.Future<<a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a>> asyncReadLastRecord(<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> streamName, + <a href="../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a> l, + boolean fence, + boolean includeControl, + boolean includeEndOfStream, + int scanStartBatchSize, + int scanMaxBatchSize, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/atomic/AtomicInteger.html?is-external=true"; title="class or interface in java.util.concurrent.atomic">AtomicInteger</a> numRecordsScanned, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/ExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent">ExecutorService</a> executorService, + <a href="../../../org/apache/distributedlog/logsegment/LogSegmentEntryStore.html" title="interface in org.apache.distributedlog.logsegment">LogSegmentEntryStore</a> entryStore)</pre> +<div class="block">Read last record from a log segment.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>streamName</code> - fully qualified stream name (used for logging)</dd> +<dd><code>l</code> - log segment metadata.</dd> +<dd><code>fence</code> - whether to fence the log segment.</dd> +<dd><code>includeControl</code> - whether to include control record.</dd> +<dd><code>includeEndOfStream</code> - whether to include end of stream.</dd> +<dd><code>scanStartBatchSize</code> - first num entries used for read last record scan</dd> +<dd><code>scanMaxBatchSize</code> - max num entries used for read last record scan</dd> +<dd><code>numRecordsScanned</code> - num of records scanned to get last record</dd> +<dd><code>executorService</code> - executor service used for processing entries</dd> +<dd><code>entryStore</code> - log segment entry store</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a future with last record.</dd> +</dl> +</li> +</ul> +<a name="asyncReadFirstUserRecord-java.lang.String-org.apache.distributedlog.LogSegmentMetadata-int-int-java.util.concurrent.atomic.AtomicInteger-java.util.concurrent.ExecutorService-org.apache.distributedlog.logsegment.LogSegmentEntryStore-org.apache.distributedlog.DLSN-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asyncReadFirstUserRecord</h4> +<pre>public static com.twitter.util.Future<<a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a>> asyncReadFirstUserRecord(<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> streamName, + <a href="../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a> l, + int scanStartBatchSize, + int scanMaxBatchSize, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/atomic/AtomicInteger.html?is-external=true"; title="class or interface in java.util.concurrent.atomic">AtomicInteger</a> numRecordsScanned, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/ExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent">ExecutorService</a> executorService, + <a href="../../../org/apache/distributedlog/logsegment/LogSegmentEntryStore.html" title="interface in org.apache.distributedlog.logsegment">LogSegmentEntryStore</a> entryStore, + <a href="../../../org/apache/distributedlog/DLSN.html" title="class in org.apache.distributedlog">DLSN</a> dlsn)</pre> +<div class="block">Read first record from a log segment with a DLSN larger than that given.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>streamName</code> - fully qualified stream name (used for logging)</dd> +<dd><code>l</code> - log segment metadata.</dd> +<dd><code>scanStartBatchSize</code> - first num entries used for read last record scan</dd> +<dd><code>scanMaxBatchSize</code> - max num entries used for read last record scan</dd> +<dd><code>numRecordsScanned</code> - num of records scanned to get last record</dd> +<dd><code>executorService</code> - executor service used for processing entries</dd> +<dd><code>entryStore</code> - log segment entry store</dd> +<dd><code>dlsn</code> - threshold dlsn</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a future with last record.</dd> +</dl> +</li> +</ul> +<a name="getLogRecordNotLessThanTxId-java.lang.String-org.apache.distributedlog.LogSegmentMetadata-long-java.util.concurrent.ExecutorService-org.apache.distributedlog.logsegment.LogSegmentEntryStore-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLogRecordNotLessThanTxId</h4> +<pre>public static com.twitter.util.Future<com.google.common.base.Optional<<a href="../../../org/apache/distributedlog/LogRecordWithDLSN.html" title="class in org.apache.distributedlog">LogRecordWithDLSN</a>>> getLogRecordNotLessThanTxId(<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, + <a href="../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a> segment, + long transactionId, + <a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/ExecutorService.html?is-external=true"; title="class or interface in java.util.concurrent">ExecutorService</a> executorService, + <a href="../../../org/apache/distributedlog/logsegment/LogSegmentEntryStore.html" title="interface in org.apache.distributedlog.logsegment">LogSegmentEntryStore</a> entryStore, + int nWays)</pre> +<div class="block">Get the log record whose transaction id is not less than provided <code>transactionId</code>. + + <p> + It uses a binary-search like algorithm to find the log record whose transaction id is not less than + provided <code>transactionId</code> within a log <code>segment</code>. You could think of a log segment + in terms of a sequence of records whose transaction ids are non-decreasing. + + - The sequence of records within a log segment is divided into N pieces. + - Find the piece of records that contains a record whose transaction id is not less than provided + <code>transactionId</code>. + + N could be chosen based on trading off concurrency and latency. + </p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>logName</code> - name of the log</dd> +<dd><code>segment</code> - metadata of the log segment</dd> +<dd><code>transactionId</code> - transaction id</dd> +<dd><code>executorService</code> - executor service used for processing entries</dd> +<dd><code>entryStore</code> - log segment entry store</dd> +<dd><code>nWays</code> - how many number of entries to search in parallel</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>found log record. none if all transaction ids are less than provided <code>transactionId</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/ReadUtils.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/MetadataAccessor.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/ZooKeeperClient.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/ReadUtils.html" target="_top">Frames</a></li> +<li><a href="ReadUtils.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 © 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/1e6843e5/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/ZooKeeperClient.Credentials.html ---------------------------------------------------------------------- diff --git a/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/ZooKeeperClient.Credentials.html b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/ZooKeeperClient.Credentials.html new file mode 100644 index 0000000..95a011d --- /dev/null +++ b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/ZooKeeperClient.Credentials.html @@ -0,0 +1,267 @@ +<!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_92) on Sun Jan 08 19:29:05 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ZooKeeperClient.Credentials (Apache DistributedLog for Java, version 0.4.0-incubating)</title> +<meta name="date" content="2017-01-08"> +<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="ZooKeeperClient.Credentials (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ZooKeeperClient.Credentials.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/ZooKeeperClient.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/ZooKeeperClient.DigestCredentials.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/ZooKeeperClient.Credentials.html" target="_top">Frames</a></li> +<li><a href="ZooKeeperClient.Credentials.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>Constr | </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>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="Interface ZooKeeperClient.Credentials" class="title">Interface ZooKeeperClient.Credentials</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/distributedlog/ZooKeeperClient.DigestCredentials.html" title="class in org.apache.distributedlog">ZooKeeperClient.DigestCredentials</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../org/apache/distributedlog/ZooKeeperClient.html" title="class in org.apache.distributedlog">ZooKeeperClient</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="typeNameLabel">ZooKeeperClient.Credentials</span></pre> +</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>static <a href="../../../org/apache/distributedlog/ZooKeeperClient.Credentials.html" title="interface in org.apache.distributedlog">ZooKeeperClient.Credentials</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/distributedlog/ZooKeeperClient.Credentials.html#NONE">NONE</a></span></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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/ZooKeeperClient.Credentials.html#authenticate-org.apache.zookeeper.ZooKeeper-">authenticate</a></span>(org.apache.zookeeper.ZooKeeper zooKeeper)</code> </td> +</tr> +</table> +</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="NONE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NONE</h4> +<pre>static final <a href="../../../org/apache/distributedlog/ZooKeeperClient.Credentials.html" title="interface in org.apache.distributedlog">ZooKeeperClient.Credentials</a> NONE</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="authenticate-org.apache.zookeeper.ZooKeeper-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>authenticate</h4> +<pre>void authenticate(org.apache.zookeeper.ZooKeeper zooKeeper)</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> +<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/ZooKeeperClient.Credentials.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/ZooKeeperClient.html" title="class in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/ZooKeeperClient.DigestCredentials.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/ZooKeeperClient.Credentials.html" target="_top">Frames</a></li> +<li><a href="ZooKeeperClient.Credentials.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>Constr | </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>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> http://git-wip-us.apache.org/repos/asf/incubator-distributedlog/blob/1e6843e5/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/ZooKeeperClient.DigestCredentials.html ---------------------------------------------------------------------- diff --git a/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/ZooKeeperClient.DigestCredentials.html b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/ZooKeeperClient.DigestCredentials.html new file mode 100644 index 0000000..29d8b2e --- /dev/null +++ b/content/docs/0.4.0-incubating/api/java/org/apache/distributedlog/ZooKeeperClient.DigestCredentials.html @@ -0,0 +1,303 @@ +<!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_92) on Sun Jan 08 19:29:05 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ZooKeeperClient.DigestCredentials (Apache DistributedLog for Java, version 0.4.0-incubating)</title> +<meta name="date" content="2017-01-08"> +<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="ZooKeeperClient.DigestCredentials (Apache DistributedLog for Java, version 0.4.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/ZooKeeperClient.DigestCredentials.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/ZooKeeperClient.Credentials.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/ZooKeeperClient.ZooKeeperConnectionException.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/ZooKeeperClient.DigestCredentials.html" target="_top">Frames</a></li> +<li><a href="ZooKeeperClient.DigestCredentials.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.distributedlog</div> +<h2 title="Class ZooKeeperClient.DigestCredentials" class="title">Class ZooKeeperClient.DigestCredentials</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.ZooKeeperClient.DigestCredentials</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/ZooKeeperClient.Credentials.html" title="interface in org.apache.distributedlog">ZooKeeperClient.Credentials</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../org/apache/distributedlog/ZooKeeperClient.html" title="class in org.apache.distributedlog">ZooKeeperClient</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">ZooKeeperClient.DigestCredentials</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/ZooKeeperClient.Credentials.html" title="interface in org.apache.distributedlog">ZooKeeperClient.Credentials</a></pre> +</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> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.distributedlog.ZooKeeperClient.Credentials"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.distributedlog.<a href="../../../org/apache/distributedlog/ZooKeeperClient.Credentials.html" title="interface in org.apache.distributedlog">ZooKeeperClient.Credentials</a></h3> +<code><a href="../../../org/apache/distributedlog/ZooKeeperClient.Credentials.html#NONE">NONE</a></code></li> +</ul> +</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/ZooKeeperClient.DigestCredentials.html#DigestCredentials-java.lang.String-java.lang.String-">DigestCredentials</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> username, + <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> password)</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/ZooKeeperClient.DigestCredentials.html#authenticate-org.apache.zookeeper.ZooKeeper-">authenticate</a></span>(org.apache.zookeeper.ZooKeeper zooKeeper)</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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DigestCredentials-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DigestCredentials</h4> +<pre>public DigestCredentials(<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> username, + <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> password)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="authenticate-org.apache.zookeeper.ZooKeeper-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>authenticate</h4> +<pre>public void authenticate(org.apache.zookeeper.ZooKeeper zooKeeper)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../org/apache/distributedlog/ZooKeeperClient.Credentials.html#authenticate-org.apache.zookeeper.ZooKeeper-">authenticate</a></code> in interface <code><a href="../../../org/apache/distributedlog/ZooKeeperClient.Credentials.html" title="interface in org.apache.distributedlog">ZooKeeperClient.Credentials</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/ZooKeeperClient.DigestCredentials.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/ZooKeeperClient.Credentials.html" title="interface in org.apache.distributedlog"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/distributedlog/ZooKeeperClient.ZooKeeperConnectionException.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/ZooKeeperClient.DigestCredentials.html" target="_top">Frames</a></li> +<li><a href="ZooKeeperClient.DigestCredentials.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 © 2016-2017 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
