| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>WALFactory (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.wal, class: WALFactory"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/WALFactory.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.wal</a></div> |
| <h1 title="Class WALFactory" class="title">Class WALFactory</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.hbase.wal.WALFactory</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-64">WALFactory</a></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Entry point for users of the Write Ahead Log. Acts as the shim between internal use and the |
| particular WALProvider we use to handle wal requests. Configure which provider gets used with the |
| configuration setting "hbase.wal.provider". Available implementations: |
| <ul> |
| <li><em>defaultProvider</em> : whatever provider is standard for the hbase version. Currently |
| "asyncfs"</li> |
| <li><em>asyncfs</em> : a provider that will run on top of an implementation of the Hadoop |
| FileSystem interface via an asynchronous client.</li> |
| <li><em>filesystem</em> : a provider that will run on top of an implementation of the Hadoop |
| FileSystem interface via HDFS's synchronous DFSClient.</li> |
| <li><em>multiwal</em> : a provider that will use multiple "filesystem" wal instances per region |
| server.</li> |
| </ul> |
| Alternatively, you may provide a custom implementation of <a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal"><code>WALProvider</code></a> by class name.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>(package private) static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="WALFactory.Providers.html" class="type-name-link" title="enum class in org.apache.hadoop.hbase.wal">WALFactory.Providers</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Maps between configuration names for providers and implementation classes.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>(package private) final <a href="../Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#abortable" class="member-name-link">abortable</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final org.apache.hadoop.conf.Configuration</code></div> |
| <div class="col-second odd-row-color"><code><a href="#conf" class="member-name-link">conf</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>(package private) static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_WAL_PROVIDER" class="member-name-link">DEFAULT_WAL_PROVIDER</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final <a href="../io/asyncfs/monitor/ExcludeDatanodeManager.html" title="class in org.apache.hadoop.hbase.io.asyncfs.monitor">ExcludeDatanodeManager</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#excludeDatanodeManager" class="member-name-link">excludeDatanodeManager</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>(package private) final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#factoryId" class="member-name-link">factoryId</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private static final org.slf4j.Logger</code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#META_WAL_PROVIDER" class="member-name-link">META_WAL_PROVIDER</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final <a href="LazyInitializedWALProvider.html" title="class in org.apache.hadoop.hbase.wal">LazyInitializedWALProvider</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#metaProvider" class="member-name-link">metaProvider</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final <a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#provider" class="member-name-link">provider</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#REPLICATION_WAL_PROVIDER" class="member-name-link">REPLICATION_WAL_PROVIDER</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>(package private) static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#REPLICATION_WAL_PROVIDER_ID" class="member-name-link">REPLICATION_WAL_PROVIDER_ID</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final <a href="LazyInitializedWALProvider.html" title="class in org.apache.hadoop.hbase.wal">LazyInitializedWALProvider</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#replicationProvider" class="member-name-link">replicationProvider</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicReference.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicReference</a><<a href="WALFactory.html" title="class in org.apache.hadoop.hbase.wal">WALFactory</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#singleton" class="member-name-link">singleton</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#SINGLETON_ID" class="member-name-link">SINGLETON_ID</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#timeoutMillis" class="member-name-link">timeoutMillis</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">How long to attempt opening in-recovery wals</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#WAL_ENABLED" class="member-name-link">WAL_ENABLED</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#WAL_PROVIDER" class="member-name-link">WAL_PROVIDER</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#WAL_STREAM_READER_CLASS_IMPL" class="member-name-link">WAL_STREAM_READER_CLASS_IMPL</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Used in tests for injecting customized stream reader implementation, for example, inject fault |
| when reading, etc.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="WALStreamReader.html" title="interface in org.apache.hadoop.hbase.wal">WALStreamReader</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#walStreamReaderClass" class="member-name-link">walStreamReaderClass</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Configuration-specified WAL Reader used when a custom reader is requested</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration)" class="member-name-link">WALFactory</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code> </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration,java.lang.String)" class="member-name-link">WALFactory</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> factoryId)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Create a WALFactory.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration,java.lang.String,org.apache.hadoop.hbase.Abortable)" class="member-name-link">WALFactory</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> factoryId, |
| <a href="../Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a> abortable)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code> </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.ServerName,org.apache.hadoop.hbase.Abortable)" class="member-name-link">WALFactory</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> serverName, |
| <a href="../Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a> abortable)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Create a WALFactory.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Shutdown all WALs and clean up any underlying storage.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static <a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createProvider(java.lang.Class)" class="member-name-link">createProvider</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a>> clazz)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WALProvider.Writer.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider.Writer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createRecoveredEditsWriter(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">createRecoveredEditsWriter</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Should be package-private, visible for recovery testing.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static <a href="WALProvider.Writer.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider.Writer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createRecoveredEditsWriter(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)" class="member-name-link">createRecoveredEditsWriter</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| org.apache.hadoop.conf.Configuration configuration)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">If you already have a WALFactory, you should favor the instance method.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WALStreamReader.html" title="interface in org.apache.hadoop.hbase.wal">WALStreamReader</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createStreamReader(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">createStreamReader</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="WALStreamReader.html" title="interface in org.apache.hadoop.hbase.wal">WALStreamReader</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createStreamReader(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)" class="member-name-link">createStreamReader</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a one-way stream reader for a given path.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="WALStreamReader.html" title="interface in org.apache.hadoop.hbase.wal">WALStreamReader</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createStreamReader(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration,long)" class="member-name-link">createStreamReader</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| org.apache.hadoop.conf.Configuration conf, |
| long startPosition)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a one-way stream reader for a given path.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WALStreamReader.html" title="interface in org.apache.hadoop.hbase.wal">WALStreamReader</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createStreamReader(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.util.CancelableProgressable)" class="member-name-link">createStreamReader</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| <a href="../util/CancelableProgressable.html" title="interface in org.apache.hadoop.hbase.util">CancelableProgressable</a> reporter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create a one-way stream reader for the WAL.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WALStreamReader.html" title="interface in org.apache.hadoop.hbase.wal">WALStreamReader</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createStreamReader(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.util.CancelableProgressable,long)" class="member-name-link">createStreamReader</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| <a href="../util/CancelableProgressable.html" title="interface in org.apache.hadoop.hbase.util">CancelableProgressable</a> reporter, |
| long startPosition)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create a one-way stream reader for the WAL, and start reading from the given |
| <code>startPosition</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="WALTailingReader.html" title="interface in org.apache.hadoop.hbase.wal">WALTailingReader</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createTailingReader(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration,long)" class="member-name-link">createTailingReader</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| org.apache.hadoop.conf.Configuration conf, |
| long startPosition)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a tailing reader for the given path.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WALProvider.Writer.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider.Writer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createWALWriter(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">createWALWriter</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create a writer for the WAL.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="WALProvider.Writer.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider.Writer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createWALWriter(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)" class="member-name-link">createWALWriter</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| org.apache.hadoop.conf.Configuration configuration)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">If you already have a WALFactory, you should favor the instance method.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAllWALProviders()" class="member-name-link">getAllWALProviders</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns all the wal providers, for example, the default one, the one for hbase:meta and the one |
| for hbase:replication.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.hadoop.conf.Configuration</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConf()" class="member-name-link">getConf</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="WALFactory.Providers.html" title="enum class in org.apache.hadoop.hbase.wal">WALFactory.Providers</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDefaultProvider()" class="member-name-link">getDefaultProvider</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../io/asyncfs/monitor/ExcludeDatanodeManager.html" title="class in org.apache.hadoop.hbase.io.asyncfs.monitor">ExcludeDatanodeManager</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExcludeDatanodeManager()" class="member-name-link">getExcludeDatanodeManager</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFactoryId()" class="member-name-link">getFactoryId</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="WALFactory.html" title="class in org.apache.hadoop.hbase.wal">WALFactory</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(org.apache.hadoop.conf.Configuration)" class="member-name-link">getInstance</a><wbr>(org.apache.hadoop.conf.Configuration configuration)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMetaProvider()" class="member-name-link">getMetaProvider</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getProviderClass(java.lang.String,java.lang.String)" class="member-name-link">getProviderClass</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> defaultValue)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReplicationProvider()" class="member-name-link">getReplicationProvider</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WAL.html" title="interface in org.apache.hadoop.hbase.wal">WAL</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWAL(org.apache.hadoop.hbase.client.RegionInfo)" class="member-name-link">getWAL</a><wbr>(<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWALProvider()" class="member-name-link">getWALProvider</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WAL.html" title="interface in org.apache.hadoop.hbase.wal">WAL</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWALs()" class="member-name-link">getWALs</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shutdown()" class="member-name-link">shutdown</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Tell the underlying WAL providers to shut down, but do not clean up underlying storage.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="WAL_STREAM_READER_CLASS_IMPL"> |
| <h3>WAL_STREAM_READER_CLASS_IMPL</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-79">WAL_STREAM_READER_CLASS_IMPL</a></span></div> |
| <div class="block">Used in tests for injecting customized stream reader implementation, for example, inject fault |
| when reading, etc. |
| <p/> |
| After removing the sequence file based WAL, we always use protobuf based WAL reader, and we |
| will also determine whether the WAL file is encrypted and we should use |
| <a href="../regionserver/wal/SecureWALCellCodec.html" title="class in org.apache.hadoop.hbase.regionserver.wal"><code>SecureWALCellCodec</code></a> to decode by check the |
| header of the WAL file, so we do not need to specify a specical reader to read the WAL file |
| either. |
| <p/> |
| So typically you should not use this config in production.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.wal.WALFactory.WAL_STREAM_READER_CLASS_IMPL">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LOG"> |
| <h3>LOG</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-82">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WAL_PROVIDER"> |
| <h3>WAL_PROVIDER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-100">WAL_PROVIDER</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.wal.WALFactory.WAL_PROVIDER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_WAL_PROVIDER"> |
| <h3>DEFAULT_WAL_PROVIDER</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-101">DEFAULT_WAL_PROVIDER</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="META_WAL_PROVIDER"> |
| <h3>META_WAL_PROVIDER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-103">META_WAL_PROVIDER</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.wal.WALFactory.META_WAL_PROVIDER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="REPLICATION_WAL_PROVIDER"> |
| <h3>REPLICATION_WAL_PROVIDER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-105">REPLICATION_WAL_PROVIDER</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.wal.WALFactory.REPLICATION_WAL_PROVIDER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WAL_ENABLED"> |
| <h3>WAL_ENABLED</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-107">WAL_ENABLED</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.wal.WALFactory.WAL_ENABLED">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="REPLICATION_WAL_PROVIDER_ID"> |
| <h3>REPLICATION_WAL_PROVIDER_ID</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-109">REPLICATION_WAL_PROVIDER_ID</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.wal.WALFactory.REPLICATION_WAL_PROVIDER_ID">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="factoryId"> |
| <h3>factoryId</h3> |
| <div class="member-signature"><span class="modifiers">final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-111">factoryId</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="abortable"> |
| <h3>abortable</h3> |
| <div class="member-signature"><span class="modifiers">final</span> <span class="return-type"><a href="../Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-112">abortable</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="provider"> |
| <h3>provider</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-113">provider</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="metaProvider"> |
| <h3>metaProvider</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="LazyInitializedWALProvider.html" title="class in org.apache.hadoop.hbase.wal">LazyInitializedWALProvider</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-117">metaProvider</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="replicationProvider"> |
| <h3>replicationProvider</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="LazyInitializedWALProvider.html" title="class in org.apache.hadoop.hbase.wal">LazyInitializedWALProvider</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-120">replicationProvider</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="walStreamReaderClass"> |
| <h3>walStreamReaderClass</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="WALStreamReader.html" title="interface in org.apache.hadoop.hbase.wal">WALStreamReader</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-125">walStreamReaderClass</a></span></div> |
| <div class="block">Configuration-specified WAL Reader used when a custom reader is requested</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="timeoutMillis"> |
| <h3>timeoutMillis</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-130">timeoutMillis</a></span></div> |
| <div class="block">How long to attempt opening in-recovery wals</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="conf"> |
| <h3>conf</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">org.apache.hadoop.conf.Configuration</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-132">conf</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="excludeDatanodeManager"> |
| <h3>excludeDatanodeManager</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="../io/asyncfs/monitor/ExcludeDatanodeManager.html" title="class in org.apache.hadoop.hbase.io.asyncfs.monitor">ExcludeDatanodeManager</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-134">excludeDatanodeManager</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="singleton"> |
| <h3>singleton</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicReference.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicReference</a><<a href="WALFactory.html" title="class in org.apache.hadoop.hbase.wal">WALFactory</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-492">singleton</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SINGLETON_ID"> |
| <h3>SINGLETON_ID</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-493">SINGLETON_ID</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.conf.Configuration)"> |
| <h3>WALFactory</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-137">WALFactory</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.conf.Configuration,java.lang.String)"> |
| <h3>WALFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-209">WALFactory</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> factoryId)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Create a WALFactory.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.ServerName,org.apache.hadoop.hbase.Abortable)"> |
| <h3>WALFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-229">WALFactory</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> serverName, |
| <a href="../Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a> abortable)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Create a WALFactory. |
| <p/> |
| This is the constructor you should use when creating a WALFactory in normal code, to make sure |
| that the <code>factoryId</code> is the server name. We need this assumption in some places for |
| parsing the server name out from the wal file name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - must not be null, will keep a reference to read params in later reader/writer |
| instances.</dd> |
| <dd><code>serverName</code> - use to generate the factoryId, which will be append at the first of the final |
| file name</dd> |
| <dd><code>abortable</code> - the server associated with this WAL file</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.conf.Configuration,java.lang.String,org.apache.hadoop.hbase.Abortable)"> |
| <h3>WALFactory</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-241">WALFactory</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> factoryId, |
| <a href="../Abortable.html" title="interface in org.apache.hadoop.hbase">Abortable</a> abortable)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - must not be null, will keep a reference to read params in later reader/writer |
| instances.</dd> |
| <dd><code>factoryId</code> - a unique identifier for this factory. used i.e. by filesystem implementations |
| to make a directory</dd> |
| <dd><code>abortable</code> - the server associated with this WAL file</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getDefaultProvider()"> |
| <h3>getDefaultProvider</h3> |
| <div class="member-signature"><span class="return-type"><a href="WALFactory.Providers.html" title="enum class in org.apache.hadoop.hbase.wal">WALFactory.Providers</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-161">getDefaultProvider</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProviderClass(java.lang.String,java.lang.String)"> |
| <h3>getProviderClass</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-165">getProviderClass</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> defaultValue)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createProvider(java.lang.Class)"> |
| <h3>createProvider</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-195">createProvider</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a>> clazz)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConf()"> |
| <h3>getConf</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.hadoop.conf.Configuration</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-274">getConf</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-282">close</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Shutdown all WALs and clean up any underlying storage. Use only when you will not need to |
| replay and edits that have gone to any wals from this factory.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shutdown()"> |
| <h3>shutdown</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-321">shutdown</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Tell the underlying WAL providers to shut down, but do not clean up underlying storage. If you |
| are not ending cleanly and will need to replay edits from this factory's wals, use this method |
| if you can as it will try to leave things as tidy as possible.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWALs()"> |
| <h3>getWALs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WAL.html" title="interface in org.apache.hadoop.hbase.wal">WAL</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-355">getWALs</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMetaProvider()"> |
| <h3>getMetaProvider</h3> |
| <div class="member-signature"><span class="return-type"><a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-359">getMetaProvider</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReplicationProvider()"> |
| <h3>getReplicationProvider</h3> |
| <div class="member-signature"><span class="return-type"><a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-365">getReplicationProvider</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWAL(org.apache.hadoop.hbase.client.RegionInfo)"> |
| <h3>getWAL</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WAL.html" title="interface in org.apache.hadoop.hbase.wal">WAL</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-374">getWAL</a></span><wbr><span class="parameters">(<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>region</code> - the region which we want to get a WAL for. Could be null.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createStreamReader(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>createStreamReader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WALStreamReader.html" title="interface in org.apache.hadoop.hbase.wal">WALStreamReader</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-386">createStreamReader</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createStreamReader(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.util.CancelableProgressable)"> |
| <h3>createStreamReader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WALStreamReader.html" title="interface in org.apache.hadoop.hbase.wal">WALStreamReader</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-394">createStreamReader</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| <a href="../util/CancelableProgressable.html" title="interface in org.apache.hadoop.hbase.util">CancelableProgressable</a> reporter)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Create a one-way stream reader for the WAL.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A WAL reader. Close when done with it.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createStreamReader(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.util.CancelableProgressable,long)"> |
| <h3>createStreamReader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WALStreamReader.html" title="interface in org.apache.hadoop.hbase.wal">WALStreamReader</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-404">createStreamReader</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| <a href="../util/CancelableProgressable.html" title="interface in org.apache.hadoop.hbase.util">CancelableProgressable</a> reporter, |
| long startPosition)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Create a one-way stream reader for the WAL, and start reading from the given |
| <code>startPosition</code>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A WAL reader. Close when done with it.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createWALWriter(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>createWALWriter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WALProvider.Writer.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider.Writer</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-475">createWALWriter</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Create a writer for the WAL. Uses defaults. |
| <p> |
| Should be package-private. public only for tests and |
| <a href="../regionserver/wal/Compressor.html" title="class in org.apache.hadoop.hbase.regionserver.wal"><code>Compressor</code></a></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A WAL writer. Close when done with it.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createRecoveredEditsWriter(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>createRecoveredEditsWriter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WALProvider.Writer.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider.Writer</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-483">createRecoveredEditsWriter</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Should be package-private, visible for recovery testing. Uses defaults.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an overwritable writer for recovered edits. caller should close.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInstance(org.apache.hadoop.conf.Configuration)"> |
| <h3>getInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="WALFactory.html" title="class in org.apache.hadoop.hbase.wal">WALFactory</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-496">getInstance</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration configuration)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createTailingReader(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration,long)"> |
| <h3>createTailingReader</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="WALTailingReader.html" title="interface in org.apache.hadoop.hbase.wal">WALTailingReader</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-518">createTailingReader</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| org.apache.hadoop.conf.Configuration conf, |
| long startPosition)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Create a tailing reader for the given path. Mainly used in replication.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createStreamReader(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)"> |
| <h3>createStreamReader</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="WALStreamReader.html" title="interface in org.apache.hadoop.hbase.wal">WALStreamReader</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-528">createStreamReader</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| org.apache.hadoop.conf.Configuration conf)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Create a one-way stream reader for a given path.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createStreamReader(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration,long)"> |
| <h3>createStreamReader</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="WALStreamReader.html" title="interface in org.apache.hadoop.hbase.wal">WALStreamReader</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-536">createStreamReader</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| org.apache.hadoop.conf.Configuration conf, |
| long startPosition)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Create a one-way stream reader for a given path.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createRecoveredEditsWriter(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)"> |
| <h3>createRecoveredEditsWriter</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="WALProvider.Writer.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider.Writer</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-546">createRecoveredEditsWriter</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| org.apache.hadoop.conf.Configuration configuration)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">If you already have a WALFactory, you should favor the instance method. Uses defaults.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a Writer that will overwrite files. Caller must close.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createWALWriter(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration)"> |
| <h3>createWALWriter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="WALProvider.Writer.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider.Writer</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-555">createWALWriter</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| org.apache.hadoop.conf.Configuration configuration)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">If you already have a WALFactory, you should favor the instance method. Uses defaults.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a writer that won't overwrite files. Caller must close.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWALProvider()"> |
| <h3>getWALProvider</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-560">getWALProvider</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAllWALProviders()"> |
| <h3>getAllWALProviders</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="WALProvider.html" title="interface in org.apache.hadoop.hbase.wal">WALProvider</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-568">getAllWALProviders</a></span>()</div> |
| <div class="block">Returns all the wal providers, for example, the default one, the one for hbase:meta and the one |
| for hbase:replication.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExcludeDatanodeManager()"> |
| <h3>getExcludeDatanodeManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../io/asyncfs/monitor/ExcludeDatanodeManager.html" title="class in org.apache.hadoop.hbase.io.asyncfs.monitor">ExcludeDatanodeManager</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-584">getExcludeDatanodeManager</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFactoryId()"> |
| <h3>getFactoryId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/wal/WALFactory.html#line-588">getFactoryId</a></span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
