| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AbstractHdfsBolt (Storm 2.6.2 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.storm.hdfs.bolt, class: AbstractHdfsBolt"> |
| <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/AbstractHdfsBolt.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>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="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.storm.hdfs.bolt</a></div> |
| <h1 title="Class AbstractHdfsBolt" class="title">Class AbstractHdfsBolt</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/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"><a href="../../topology/base/BaseComponent.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseComponent</a> |
| <div class="inheritance"><a href="../../topology/base/BaseRichBolt.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseRichBolt</a> |
| <div class="inheritance">org.apache.storm.hdfs.bolt.AbstractHdfsBolt</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="../../task/IBolt.html" title="interface in org.apache.storm.task">IBolt</a></code>, <code><a href="../../topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code>, <code><a href="../../topology/IRichBolt.html" title="interface in org.apache.storm.topology">IRichBolt</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="AvroGenericRecordBolt.html" title="class in org.apache.storm.hdfs.bolt">AvroGenericRecordBolt</a></code>, <code><a href="HdfsBolt.html" title="class in org.apache.storm.hdfs.bolt">HdfsBolt</a></code>, <code><a href="SequenceFileBolt.html" title="class in org.apache.storm.hdfs.bolt">SequenceFileBolt</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractHdfsBolt</span> |
| <span class="extends-implements">extends <a href="../../topology/base/BaseRichBolt.html" title="class in org.apache.storm.topology.base">BaseRichBolt</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../serialized-form.html#org.apache.storm.hdfs.bolt.AbstractHdfsBolt">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== 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>protected <a href="../../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#collector" class="member-name-link">collector</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/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="#configKey" class="member-name-link">configKey</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="format/FileNameFormat.html" title="interface in org.apache.storm.hdfs.bolt.format">FileNameFormat</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#fileNameFormat" class="member-name-link">fileNameFormat</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#fileRetryCount" class="member-name-link">fileRetryCount</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected org.apache.hadoop.fs.FileSystem</code></div> |
| <div class="col-second even-row-color"><code><a href="#fs" class="member-name-link">fs</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/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="#fsUrl" class="member-name-link">fsUrl</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected org.apache.hadoop.conf.Configuration</code></div> |
| <div class="col-second even-row-color"><code><a href="#hdfsConfig" class="member-name-link">hdfsConfig</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#maxOpenFiles" class="member-name-link">maxOpenFiles</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected long</code></div> |
| <div class="col-second even-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="../common/Partitioner.html" title="interface in org.apache.storm.hdfs.common">Partitioner</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#partitioner" class="member-name-link">partitioner</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../common/rotation/RotationAction.html" title="interface in org.apache.storm.hdfs.common.rotation">RotationAction</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#rotationActions" class="member-name-link">rotationActions</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#rotationCounterMap" class="member-name-link">rotationCounterMap</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="rotation/FileRotationPolicy.html" title="interface in org.apache.storm.hdfs.bolt.rotation">FileRotationPolicy</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#rotationPolicy" class="member-name-link">rotationPolicy</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Timer.html" title="class or interface in java.util" class="external-link">Timer</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#rotationTimer" class="member-name-link">rotationTimer</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="sync/SyncPolicy.html" title="interface in org.apache.storm.hdfs.bolt.sync">SyncPolicy</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#syncPolicy" class="member-name-link">syncPolicy</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#tickTupleInterval" class="member-name-link">tickTupleInterval</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#writeLock" class="member-name-link">writeLock</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="Writer.html" title="interface in org.apache.storm.hdfs.bolt">Writer</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#writers" class="member-name-link">writers</a></code></div> |
| <div class="col-last odd-row-color"> </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 two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">AbstractHdfsBolt</a>()</code></div> |
| <div class="col-last even-row-color"> </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-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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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="#cleanup()" class="member-name-link">cleanup</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Called when an IBolt is going to be shutdown.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)" class="member-name-link">declareOutputFields</a><wbr>(<a href="../../topology/OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a> outputFieldsDeclarer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Declare the output schema for all the streams of this topology.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#doPrepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)" class="member-name-link">doPrepare</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> conf, |
| <a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> topologyContext, |
| <a href="../../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a> collector)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(org.apache.storm.tuple.Tuple)" class="member-name-link">execute</a><wbr>(<a href="../../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> tuple)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Process a single tuple of input.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBasePathForNextFile(org.apache.storm.tuple.Tuple)" class="member-name-link">getBasePathForNextFile</a><wbr>(<a href="../../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> tuple)</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/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComponentConfiguration()" class="member-name-link">getComponentConfiguration</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Declare configuration specific to this component.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract <a href="https://docs.oracle.com/en/java/javase/11/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-tab3"><code><a href="#getWriterKey(org.apache.storm.tuple.Tuple)" class="member-name-link">getWriterKey</a><wbr>(<a href="../../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> tuple)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract <a href="Writer.html" title="interface in org.apache.storm.hdfs.bolt">Writer</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#makeNewWriter(org.apache.hadoop.fs.Path,org.apache.storm.tuple.Tuple)" class="member-name-link">makeNewWriter</a><wbr>(org.apache.hadoop.fs.Path path, |
| <a href="../../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> tuple)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)" class="member-name-link">prepare</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> conf, |
| <a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> topologyContext, |
| <a href="../../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a> collector)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Marked as final to prevent override.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#rotateOutputFile(org.apache.storm.hdfs.bolt.Writer)" class="member-name-link">rotateOutputFile</a><wbr>(<a href="Writer.html" title="interface in org.apache.storm.hdfs.bolt">Writer</a> writer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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/11/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/11/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/11/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/11/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/11/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/11/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/11/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/11/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/11/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/11/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/11/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/11/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="writers"> |
| <h3>writers</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="Writer.html" title="interface in org.apache.storm.hdfs.bolt">Writer</a>></span> <span class="element-name">writers</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rotationCounterMap"> |
| <h3>rotationCounterMap</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name">rotationCounterMap</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rotationActions"> |
| <h3>rotationActions</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../common/rotation/RotationAction.html" title="interface in org.apache.storm.hdfs.common.rotation">RotationAction</a>></span> <span class="element-name">rotationActions</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="collector"> |
| <h3>collector</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a></span> <span class="element-name">collector</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fs"> |
| <h3>fs</h3> |
| <div class="member-signature"><span class="modifiers">protected transient</span> <span class="return-type">org.apache.hadoop.fs.FileSystem</span> <span class="element-name">fs</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="syncPolicy"> |
| <h3>syncPolicy</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="sync/SyncPolicy.html" title="interface in org.apache.storm.hdfs.bolt.sync">SyncPolicy</a></span> <span class="element-name">syncPolicy</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rotationPolicy"> |
| <h3>rotationPolicy</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="rotation/FileRotationPolicy.html" title="interface in org.apache.storm.hdfs.bolt.rotation">FileRotationPolicy</a></span> <span class="element-name">rotationPolicy</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fileNameFormat"> |
| <h3>fileNameFormat</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="format/FileNameFormat.html" title="interface in org.apache.storm.hdfs.bolt.format">FileNameFormat</a></span> <span class="element-name">fileNameFormat</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fsUrl"> |
| <h3>fsUrl</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/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">fsUrl</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="configKey"> |
| <h3>configKey</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/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">configKey</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeLock"> |
| <h3>writeLock</h3> |
| <div class="member-signature"><span class="modifiers">protected transient</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">writeLock</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rotationTimer"> |
| <h3>rotationTimer</h3> |
| <div class="member-signature"><span class="modifiers">protected transient</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Timer.html" title="class or interface in java.util" class="external-link">Timer</a></span> <span class="element-name">rotationTimer</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="offset"> |
| <h3>offset</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name">offset</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fileRetryCount"> |
| <h3>fileRetryCount</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">fileRetryCount</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="tickTupleInterval"> |
| <h3>tickTupleInterval</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">tickTupleInterval</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="maxOpenFiles"> |
| <h3>maxOpenFiles</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">maxOpenFiles</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="partitioner"> |
| <h3>partitioner</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../common/Partitioner.html" title="interface in org.apache.storm.hdfs.common">Partitioner</a></span> <span class="element-name">partitioner</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hdfsConfig"> |
| <h3>hdfsConfig</h3> |
| <div class="member-signature"><span class="modifiers">protected transient</span> <span class="return-type">org.apache.hadoop.conf.Configuration</span> <span class="element-name">hdfsConfig</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>()"> |
| <h3>AbstractHdfsBolt</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AbstractHdfsBolt</span>()</div> |
| </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="rotateOutputFile(org.apache.storm.hdfs.bolt.Writer)"> |
| <h3>rotateOutputFile</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">rotateOutputFile</span><wbr><span class="parameters">(<a href="Writer.html" title="interface in org.apache.storm.hdfs.bolt">Writer</a> writer)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/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/11/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="prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)"> |
| <h3>prepare</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">prepare</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> conf, |
| <a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> topologyContext, |
| <a href="../../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a> collector)</span></div> |
| <div class="block">Marked as final to prevent override. Subclasses should implement the doPrepare() method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - The Storm configuration for this bolt. This is the configuration provided to the topology merged in with cluster |
| configuration on this machine.</dd> |
| <dd><code>topologyContext</code> - This object can be used to get information about this task's place within the topology, including the task id and |
| component id of this task, input and output information, etc.</dd> |
| <dd><code>collector</code> - The collector is used to emit tuples from this bolt. Tuples can be emitted at any time, including the prepare and |
| cleanup methods. The collector is thread-safe and should be saved as an instance variable of this bolt object.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="execute(org.apache.storm.tuple.Tuple)"> |
| <h3>execute</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">execute</span><wbr><span class="parameters">(<a href="../../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> tuple)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../task/IBolt.html#execute(org.apache.storm.tuple.Tuple)">IBolt</a></code></span></div> |
| <div class="block">Process a single tuple of input. The Tuple object contains metadata on it about which component/stream/task it came from. The values |
| of the Tuple can be accessed using Tuple#getValue. The IBolt does not have to process the Tuple immediately. It is perfectly fine to |
| hang onto a tuple and process it later (for instance, to do an aggregation or join). |
| |
| <p>Tuples should be emitted using the OutputCollector provided through the prepare method. It is required that all input tuples are |
| acked or failed at some point using the OutputCollector. Otherwise, Storm will be unable to determine when tuples coming off the |
| spouts have been completed. |
| |
| <p>For the common case of acking an input tuple at the end of the execute method, see IBasicBolt which automates this.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>tuple</code> - The input tuple to be processed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComponentConfiguration()"> |
| <h3>getComponentConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">getComponentConfiguration</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../topology/IComponent.html#getComponentConfiguration()">IComponent</a></code></span></div> |
| <div class="block">Declare configuration specific to this component. Only a subset of the "topology.*" configs can be overridden. The component |
| configuration can be further overridden when constructing the topology using <a href="../../topology/TopologyBuilder.html" title="class in org.apache.storm.topology"><code>TopologyBuilder</code></a></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../topology/IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code> in interface <code><a href="../../topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../topology/base/BaseComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code> in class <code><a href="../../topology/base/BaseComponent.html" title="class in org.apache.storm.topology.base">BaseComponent</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)"> |
| <h3>declareOutputFields</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">declareOutputFields</span><wbr><span class="parameters">(<a href="../../topology/OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a> outputFieldsDeclarer)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../topology/IComponent.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">IComponent</a></code></span></div> |
| <div class="block">Declare the output schema for all the streams of this topology.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>outputFieldsDeclarer</code> - this is used to declare output stream ids, output fields, and whether or not each output stream is a direct stream</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanup()"> |
| <h3>cleanup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">cleanup</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../task/IBolt.html#cleanup()">IBolt</a></code></span></div> |
| <div class="block">Called when an IBolt is going to be shutdown. Storm will make a best-effort attempt to call this if the worker shutdown is orderly. |
| The <a href="../../Config.html#SUPERVISOR_WORKER_SHUTDOWN_SLEEP_SECS"><code>Config.SUPERVISOR_WORKER_SHUTDOWN_SLEEP_SECS</code></a> setting controls how long orderly shutdown is allowed to take. |
| There is no guarantee that cleanup will be called if shutdown is not orderly, or if the shutdown exceeds the time limit. |
| |
| <p>The one context where cleanup is guaranteed to be called is when a topology is killed when running Storm in local mode.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../task/IBolt.html#cleanup()">cleanup</a></code> in interface <code><a href="../../task/IBolt.html" title="interface in org.apache.storm.task">IBolt</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../../topology/base/BaseRichBolt.html#cleanup()">cleanup</a></code> in class <code><a href="../../topology/base/BaseRichBolt.html" title="class in org.apache.storm.topology.base">BaseRichBolt</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBasePathForNextFile(org.apache.storm.tuple.Tuple)"> |
| <h3>getBasePathForNextFile</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name">getBasePathForNextFile</span><wbr><span class="parameters">(<a href="../../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> tuple)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="doPrepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)"> |
| <h3>doPrepare</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type">void</span> <span class="element-name">doPrepare</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> conf, |
| <a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> topologyContext, |
| <a href="../../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a> collector)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/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/11/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="getWriterKey(org.apache.storm.tuple.Tuple)"> |
| <h3>getWriterKey</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/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">getWriterKey</span><wbr><span class="parameters">(<a href="../../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> tuple)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="makeNewWriter(org.apache.hadoop.fs.Path,org.apache.storm.tuple.Tuple)"> |
| <h3>makeNewWriter</h3> |
| <div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type"><a href="Writer.html" title="interface in org.apache.storm.hdfs.bolt">Writer</a></span> <span class="element-name">makeNewWriter</span><wbr><span class="parameters">(org.apache.hadoop.fs.Path path, |
| <a href="../../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> tuple)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/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/11/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> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
