blob: 65b307b55de8c42b4044127ee848550430525ccf [file] [log] [blame]
<!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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>LogSegmentMetadataStore (Apache DistributedLog for Java, version 0.5.0)</title>
<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="LogSegmentMetadataStore (Apache DistributedLog for Java, version 0.5.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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/LogSegmentMetadataStore.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/logsegment/LogSegmentMetadataCache.html" title="class in org.apache.distributedlog.logsegment"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/distributedlog/logsegment/LogSegmentRandomAccessEntryReader.html" title="interface in org.apache.distributedlog.logsegment"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/distributedlog/logsegment/LogSegmentMetadataStore.html" target="_top">Frames</a></li>
<li><a href="LogSegmentMetadataStore.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.distributedlog.logsegment</div>
<h2 title="Interface LogSegmentMetadataStore" class="title">Interface LogSegmentMetadataStore</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><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>@Beta
public interface <span class="typeNameLabel">LogSegmentMetadataStore</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></pre>
<div class="block">Interface for log segment metadata store. All operations that modify log segments should
be executed under a <code>Transaction</code>.</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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/logsegment/LogSegmentMetadataStore.html#createLogSegment-org.apache.distributedlog.util.Transaction-org.apache.distributedlog.LogSegmentMetadata-org.apache.distributedlog.util.Transaction.OpListener-">createLogSegment</a></span>(org.apache.distributedlog.util.Transaction&lt;<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>&gt;&nbsp;txn,
<a href="../../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a>&nbsp;segment,
org.apache.distributedlog.util.Transaction.OpListener&lt;<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>&gt;&nbsp;opListener)</code>
<div class="block">Create a log segment <code>segment</code> under transaction <code>txn</code>.</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/logsegment/LogSegmentMetadataStore.html#deleteLogSegment-org.apache.distributedlog.util.Transaction-org.apache.distributedlog.LogSegmentMetadata-org.apache.distributedlog.util.Transaction.OpListener-">deleteLogSegment</a></span>(org.apache.distributedlog.util.Transaction&lt;<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>&gt;&nbsp;txn,
<a href="../../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a>&nbsp;segment,
org.apache.distributedlog.util.Transaction.OpListener&lt;<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>&gt;&nbsp;opListener)</code>
<div class="block">Delete a log segment <code>segment</code> under transaction <code>txn</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a>&lt;<a href="../../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/logsegment/LogSegmentMetadataStore.html#getLogSegment-java.lang.String-">getLogSegment</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>&nbsp;logSegmentPath)</code>
<div class="block">Retrieve the log segment associated <code>path</code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a>&lt;org.apache.bookkeeper.versioning.Versioned&lt;<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>&lt;<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>&gt;&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/logsegment/LogSegmentMetadataStore.html#getLogSegmentNames-java.lang.String-org.apache.distributedlog.callback.LogSegmentNamesListener-">getLogSegmentNames</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>&nbsp;logSegmentsPath,
<a href="../../../../org/apache/distributedlog/callback/LogSegmentNamesListener.html" title="interface in org.apache.distributedlog.callback">LogSegmentNamesListener</a>&nbsp;listener)</code>
<div class="block">Retrieve the list of log segments under <code>logSegmentsPath</code> and register a <i>listener</i>
for subsequent changes for the list of log segments.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/logsegment/LogSegmentMetadataStore.html#storeMaxLogSegmentSequenceNumber-org.apache.distributedlog.util.Transaction-org.apache.distributedlog.metadata.LogMetadata-org.apache.bookkeeper.versioning.Versioned-org.apache.distributedlog.util.Transaction.OpListener-">storeMaxLogSegmentSequenceNumber</a></span>(org.apache.distributedlog.util.Transaction&lt;<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>&gt;&nbsp;txn,
<a href="../../../../org/apache/distributedlog/metadata/LogMetadata.html" title="class in org.apache.distributedlog.metadata">LogMetadata</a>&nbsp;logMetadata,
org.apache.bookkeeper.versioning.Versioned&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;sequenceNumber,
org.apache.distributedlog.util.Transaction.OpListener&lt;org.apache.bookkeeper.versioning.Version&gt;&nbsp;listener)</code>
<div class="block">Store the maximum log segment sequence number on <code>path</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/logsegment/LogSegmentMetadataStore.html#storeMaxTxnId-org.apache.distributedlog.util.Transaction-org.apache.distributedlog.metadata.LogMetadataForWriter-org.apache.bookkeeper.versioning.Versioned-org.apache.distributedlog.util.Transaction.OpListener-">storeMaxTxnId</a></span>(org.apache.distributedlog.util.Transaction&lt;<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>&gt;&nbsp;txn,
<a href="../../../../org/apache/distributedlog/metadata/LogMetadataForWriter.html" title="class in org.apache.distributedlog.metadata">LogMetadataForWriter</a>&nbsp;logMetadata,
org.apache.bookkeeper.versioning.Versioned&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;transactionId,
org.apache.distributedlog.util.Transaction.OpListener&lt;org.apache.bookkeeper.versioning.Version&gt;&nbsp;listener)</code>
<div class="block">Store the maximum transaction id for <code>path</code></div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>org.apache.distributedlog.util.Transaction&lt;<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>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/logsegment/LogSegmentMetadataStore.html#transaction--">transaction</a></span>()</code>
<div class="block">Start the transaction on changing log segment metadata store.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/logsegment/LogSegmentMetadataStore.html#unregisterLogSegmentListener-java.lang.String-org.apache.distributedlog.callback.LogSegmentNamesListener-">unregisterLogSegmentListener</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>&nbsp;logSegmentsPath,
<a href="../../../../org/apache/distributedlog/callback/LogSegmentNamesListener.html" title="interface in org.apache.distributedlog.callback">LogSegmentNamesListener</a>&nbsp;listener)</code>
<div class="block">Unregister a log segment <code>listener</code> on log segment changes under <code>logSegmentsPath</code>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/distributedlog/logsegment/LogSegmentMetadataStore.html#updateLogSegment-org.apache.distributedlog.util.Transaction-org.apache.distributedlog.LogSegmentMetadata-">updateLogSegment</a></span>(org.apache.distributedlog.util.Transaction&lt;<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>&gt;&nbsp;txn,
<a href="../../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a>&nbsp;segment)</code>
<div class="block">Update a log segment <code>segment</code> under transaction <code>txn</code>.</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&nbsp;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>
</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="transaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transaction</h4>
<pre>org.apache.distributedlog.util.Transaction&lt;<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>&gt;&nbsp;transaction()</pre>
<div class="block">Start the transaction on changing log segment metadata store.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>transaction of the log segment metadata store.</dd>
</dl>
</li>
</ul>
<a name="storeMaxLogSegmentSequenceNumber-org.apache.distributedlog.util.Transaction-org.apache.distributedlog.metadata.LogMetadata-org.apache.bookkeeper.versioning.Versioned-org.apache.distributedlog.util.Transaction.OpListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeMaxLogSegmentSequenceNumber</h4>
<pre>void&nbsp;storeMaxLogSegmentSequenceNumber(org.apache.distributedlog.util.Transaction&lt;<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>&gt;&nbsp;txn,
<a href="../../../../org/apache/distributedlog/metadata/LogMetadata.html" title="class in org.apache.distributedlog.metadata">LogMetadata</a>&nbsp;logMetadata,
org.apache.bookkeeper.versioning.Versioned&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;sequenceNumber,
org.apache.distributedlog.util.Transaction.OpListener&lt;org.apache.bookkeeper.versioning.Version&gt;&nbsp;listener)</pre>
<div class="block">Store the maximum log segment sequence number on <code>path</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>txn</code> - transaction to execute for storing log segment sequence number.</dd>
<dd><code>logMetadata</code> - metadata of the log stream</dd>
<dd><code>sequenceNumber</code> - log segment sequence number to store</dd>
<dd><code>listener</code> - listener on the result to this operation</dd>
</dl>
</li>
</ul>
<a name="storeMaxTxnId-org.apache.distributedlog.util.Transaction-org.apache.distributedlog.metadata.LogMetadataForWriter-org.apache.bookkeeper.versioning.Versioned-org.apache.distributedlog.util.Transaction.OpListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>storeMaxTxnId</h4>
<pre>void&nbsp;storeMaxTxnId(org.apache.distributedlog.util.Transaction&lt;<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>&gt;&nbsp;txn,
<a href="../../../../org/apache/distributedlog/metadata/LogMetadataForWriter.html" title="class in org.apache.distributedlog.metadata">LogMetadataForWriter</a>&nbsp;logMetadata,
org.apache.bookkeeper.versioning.Versioned&lt;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;transactionId,
org.apache.distributedlog.util.Transaction.OpListener&lt;org.apache.bookkeeper.versioning.Version&gt;&nbsp;listener)</pre>
<div class="block">Store the maximum transaction id for <code>path</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>txn</code> - transaction to execute for storing transaction id</dd>
<dd><code>logMetadata</code> - metadata of the log stream</dd>
<dd><code>transactionId</code> - transaction id to store</dd>
<dd><code>listener</code> - listener on the result to this operation</dd>
</dl>
</li>
</ul>
<a name="createLogSegment-org.apache.distributedlog.util.Transaction-org.apache.distributedlog.LogSegmentMetadata-org.apache.distributedlog.util.Transaction.OpListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createLogSegment</h4>
<pre>void&nbsp;createLogSegment(org.apache.distributedlog.util.Transaction&lt;<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>&gt;&nbsp;txn,
<a href="../../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a>&nbsp;segment,
org.apache.distributedlog.util.Transaction.OpListener&lt;<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>&gt;&nbsp;opListener)</pre>
<div class="block">Create a log segment <code>segment</code> under transaction <code>txn</code>.
NOTE: this operation shouldn't be a blocking call. and it shouldn't execute the operation
immediately. the operation should be executed via <code>Transaction.execute()</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>txn</code> - transaction to execute for this operation</dd>
<dd><code>segment</code> - segment to create</dd>
<dd><code>opListener</code> - the listener on the operation result</dd>
</dl>
</li>
</ul>
<a name="deleteLogSegment-org.apache.distributedlog.util.Transaction-org.apache.distributedlog.LogSegmentMetadata-org.apache.distributedlog.util.Transaction.OpListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteLogSegment</h4>
<pre>void&nbsp;deleteLogSegment(org.apache.distributedlog.util.Transaction&lt;<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>&gt;&nbsp;txn,
<a href="../../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a>&nbsp;segment,
org.apache.distributedlog.util.Transaction.OpListener&lt;<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>&gt;&nbsp;opListener)</pre>
<div class="block">Delete a log segment <code>segment</code> under transaction <code>txn</code>.
NOTE: this operation shouldn't be a blocking call. and it shouldn't execute the operation
immediately. the operation should be executed via <code>Transaction.execute()</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>txn</code> - transaction to execute for this operation</dd>
<dd><code>segment</code> - segment to delete</dd>
</dl>
</li>
</ul>
<a name="updateLogSegment-org.apache.distributedlog.util.Transaction-org.apache.distributedlog.LogSegmentMetadata-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateLogSegment</h4>
<pre>void&nbsp;updateLogSegment(org.apache.distributedlog.util.Transaction&lt;<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>&gt;&nbsp;txn,
<a href="../../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a>&nbsp;segment)</pre>
<div class="block">Update a log segment <code>segment</code> under transaction <code>txn</code>.
NOTE: this operation shouldn't be a blocking call. and it shouldn't execute the operation
immediately. the operation should be executed via <code>Transaction.execute()</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>txn</code> - transaction to execute for this operation</dd>
<dd><code>segment</code> - segment to update</dd>
</dl>
</li>
</ul>
<a name="getLogSegment-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogSegment</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a>&lt;<a href="../../../../org/apache/distributedlog/LogSegmentMetadata.html" title="class in org.apache.distributedlog">LogSegmentMetadata</a>&gt;&nbsp;getLogSegment(<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>&nbsp;logSegmentPath)</pre>
<div class="block">Retrieve the log segment associated <code>path</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>logSegmentPath</code> - path to store log segment metadata</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>future of the retrieved log segment metadata</dd>
</dl>
</li>
</ul>
<a name="getLogSegmentNames-java.lang.String-org.apache.distributedlog.callback.LogSegmentNamesListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogSegmentNames</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a>&lt;org.apache.bookkeeper.versioning.Versioned&lt;<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>&lt;<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>&gt;&gt;&gt;&nbsp;getLogSegmentNames(<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>&nbsp;logSegmentsPath,
<a href="../../../../org/apache/distributedlog/callback/LogSegmentNamesListener.html" title="interface in org.apache.distributedlog.callback">LogSegmentNamesListener</a>&nbsp;listener)</pre>
<div class="block">Retrieve the list of log segments under <code>logSegmentsPath</code> and register a <i>listener</i>
for subsequent changes for the list of log segments.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>logSegmentsPath</code> - path to store list of log segments</dd>
<dd><code>listener</code> - log segment listener on log segment changes</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>future of the retrieved list of log segment names</dd>
</dl>
</li>
</ul>
<a name="unregisterLogSegmentListener-java.lang.String-org.apache.distributedlog.callback.LogSegmentNamesListener-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>unregisterLogSegmentListener</h4>
<pre>void&nbsp;unregisterLogSegmentListener(<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>&nbsp;logSegmentsPath,
<a href="../../../../org/apache/distributedlog/callback/LogSegmentNamesListener.html" title="interface in org.apache.distributedlog.callback">LogSegmentNamesListener</a>&nbsp;listener)</pre>
<div class="block">Unregister a log segment <code>listener</code> on log segment changes under <code>logSegmentsPath</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>logSegmentsPath</code> - log segments path</dd>
<dd><code>listener</code> - log segment listener on log segment changes</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/LogSegmentMetadataStore.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/logsegment/LogSegmentMetadataCache.html" title="class in org.apache.distributedlog.logsegment"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/distributedlog/logsegment/LogSegmentRandomAccessEntryReader.html" title="interface in org.apache.distributedlog.logsegment"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/distributedlog/logsegment/LogSegmentMetadataStore.html" target="_top">Frames</a></li>
<li><a href="LogSegmentMetadataStore.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016-2018 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>