| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>BaseRichBolt (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.topology.base, class: BaseRichBolt"> |
| <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/BaseRichBolt.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>Field | </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>Field | </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.topology.base</a></div> |
| <h1 title="Class BaseRichBolt" class="title">Class BaseRichBolt</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="BaseComponent.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseComponent</a> |
| <div class="inheritance">org.apache.storm.topology.base.BaseRichBolt</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="../IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code>, <code><a href="../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="../../hdfs/bolt/AbstractHdfsBolt.html" title="class in org.apache.storm.hdfs.bolt">AbstractHdfsBolt</a></code>, <code><a href="BaseTickTupleAwareRichBolt.html" title="class in org.apache.storm.topology.base">BaseTickTupleAwareRichBolt</a></code>, <code><a href="../../perf/bolt/DevNullBolt.html" title="class in org.apache.storm.perf.bolt">DevNullBolt</a></code>, <code><a href="../../ExclamationTopology.ExclamationBolt.html" title="class in org.apache.storm">ExclamationTopology.ExclamationBolt</a></code>, <code><a href="../../starter/ExclamationTopology.ExclamationBolt.html" title="class in org.apache.storm.starter">ExclamationTopology.ExclamationBolt</a></code>, <code><a href="../../jms/example/GenericBolt.html" title="class in org.apache.storm.jms.example">GenericBolt</a></code>, <code><a href="../../hdfs/bolt/HdfsFileTopology.MyBolt.html" title="class in org.apache.storm.hdfs.bolt">HdfsFileTopology.MyBolt</a></code>, <code><a href="../../hdfs/spout/HdfsSpoutTopology.ConstBolt.html" title="class in org.apache.storm.hdfs.spout">HdfsSpoutTopology.ConstBolt</a></code>, <code><a href="../../hive/bolt/HiveBolt.html" title="class in org.apache.storm.hive.bolt">HiveBolt</a></code>, <code><a href="../../perf/bolt/IdBolt.html" title="class in org.apache.storm.perf.bolt">IdBolt</a></code>, <code><a href="../../perf/utils/IdentityBolt.html" title="class in org.apache.storm.perf.utils">IdentityBolt</a></code>, <code><a href="../../drpc/JoinResult.html" title="class in org.apache.storm.drpc">JoinResult</a></code>, <code><a href="../../kafka/spout/KafkaSpoutTestBolt.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutTestBolt</a></code>, <code><a href="../../loadgen/LoadBolt.html" title="class in org.apache.storm.loadgen">LoadBolt</a></code>, <code><a href="../../redis/topology/LookupWordCount.PrintWordTotalCountBolt.html" title="class in org.apache.storm.redis.topology">LookupWordCount.PrintWordTotalCountBolt</a></code>, <code><a href="../../starter/MultipleLoggerTopology.ExclamationLoggingBolt.html" title="class in org.apache.storm.starter">MultipleLoggerTopology.ExclamationLoggingBolt</a></code>, <code><a href="../../starter/ResourceAwareExampleTopology.ExclamationBolt.html" title="class in org.apache.storm.starter">ResourceAwareExampleTopology.ExclamationBolt</a></code>, <code><a href="../../drpc/ReturnResults.html" title="class in org.apache.storm.drpc">ReturnResults</a></code>, <code><a href="../../starter/bolt/RollingCountAggBolt.html" title="class in org.apache.storm.starter.bolt">RollingCountAggBolt</a></code>, <code><a href="../../starter/bolt/RollingCountBolt.html" title="class in org.apache.storm.starter.bolt">RollingCountBolt</a></code>, <code><a href="../../hdfs/bolt/SequenceFileTopology.MyBolt.html" title="class in org.apache.storm.hdfs.bolt">SequenceFileTopology.MyBolt</a></code>, <code><a href="../../starter/bolt/SingleJoinBolt.html" title="class in org.apache.storm.starter.bolt">SingleJoinBolt</a></code>, <code><a href="../../sql/runtime/datasource/socket/bolt/SocketBolt.html" title="class in org.apache.storm.sql.runtime.datasource.socket.bolt">SocketBolt</a></code>, <code><a href="../../testing/TestAggregatesCounter.html" title="class in org.apache.storm.testing">TestAggregatesCounter</a></code>, <code><a href="../../testing/TestEventOrderCheckBolt.html" title="class in org.apache.storm.testing">TestEventOrderCheckBolt</a></code>, <code><a href="../../testing/TestGlobalCount.html" title="class in org.apache.storm.testing">TestGlobalCount</a></code>, <code><a href="../../testing/TestPlannerBolt.html" title="class in org.apache.storm.testing">TestPlannerBolt</a></code>, <code><a href="../../redis/topology/WhitelistWordCount.PrintWordTotalCountBolt.html" title="class in org.apache.storm.redis.topology">WhitelistWordCount.PrintWordTotalCountBolt</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">BaseRichBolt</span> |
| <span class="extends-implements">extends <a href="BaseComponent.html" title="class in org.apache.storm.topology.base">BaseComponent</a> |
| implements <a href="../IRichBolt.html" title="interface in org.apache.storm.topology">IRichBolt</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../serialized-form.html#org.apache.storm.topology.base.BaseRichBolt">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== 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">BaseRichBolt</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-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> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.topology.base.BaseComponent">Methods inherited from class org.apache.storm.topology.base.<a href="BaseComponent.html" title="class in org.apache.storm.topology.base">BaseComponent</a></h3> |
| <code><a href="BaseComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code></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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.task.IBolt">Methods inherited from interface org.apache.storm.task.<a href="../../task/IBolt.html" title="interface in org.apache.storm.task">IBolt</a></h3> |
| <code><a href="../../task/IBolt.html#execute(org.apache.storm.tuple.Tuple)">execute</a>, <a href="../../task/IBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">prepare</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.topology.IComponent">Methods inherited from interface org.apache.storm.topology.<a href="../IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></h3> |
| <code><a href="../IComponent.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a>, <a href="../IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= 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>BaseRichBolt</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">BaseRichBolt</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="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> |
| </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> |
