Google Git
Sign in
apache / storm-site / 96a3de20b80697048cf32577d9eaa97f69519756 / . / releases / 2.0.0 / javadocs / org / apache / storm / topology / IRichBolt.html
blob: fba6493dd1b963797c95bed9493609fd8750f95a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IRichBolt (Storm 2.0.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IRichBolt (Storm 2.0.0 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IRichBolt.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="interface in org.apache.storm.topology"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/storm/topology/IRichSpout.html" title="interface in org.apache.storm.topology"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/topology/IRichBolt.html" target="_top">Frames</a></li>
<li><a href="IRichBolt.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.storm.topology</div>
<h2 title="Interface IRichBolt" class="title">Interface IRichBolt</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/apache/storm/task/IBolt.html" title="interface in org.apache.storm.task">IBolt</a>, <a href="../../../../org/apache/storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/storm/elasticsearch/bolt/AbstractEsBolt.html" title="class in org.apache.storm.elasticsearch.bolt">AbstractEsBolt</a>, <a href="../../../../org/apache/storm/hbase/bolt/AbstractHBaseBolt.html" title="class in org.apache.storm.hbase.bolt">AbstractHBaseBolt</a>, <a href="../../../../org/apache/storm/hdfs/bolt/AbstractHdfsBolt.html" title="class in org.apache.storm.hdfs.bolt">AbstractHdfsBolt</a>, <a href="../../../../org/apache/storm/jdbc/bolt/AbstractJdbcBolt.html" title="class in org.apache.storm.jdbc.bolt">AbstractJdbcBolt</a>, <a href="../../../../org/apache/storm/mongodb/bolt/AbstractMongoBolt.html" title="class in org.apache.storm.mongodb.bolt">AbstractMongoBolt</a>, <a href="../../../../org/apache/storm/redis/bolt/AbstractRedisBolt.html" title="class in org.apache.storm.redis.bolt">AbstractRedisBolt</a>, <a href="../../../../org/apache/storm/hdfs/bolt/AvroGenericRecordBolt.html" title="class in org.apache.storm.hdfs.bolt">AvroGenericRecordBolt</a>, <a href="../../../../org/apache/storm/cassandra/bolt/BaseCassandraBolt.html" title="class in org.apache.storm.cassandra.bolt">BaseCassandraBolt</a>, <a href="../../../../org/apache/storm/topology/base/BaseRichBolt.html" title="class in org.apache.storm.topology.base">BaseRichBolt</a>, <a href="../../../../org/apache/storm/topology/BaseStatefulBoltExecutor.html" title="class in org.apache.storm.topology">BaseStatefulBoltExecutor</a>, <a href="../../../../org/apache/storm/topology/base/BaseTickTupleAwareRichBolt.html" title="class in org.apache.storm.topology.base">BaseTickTupleAwareRichBolt</a>, <a href="../../../../org/apache/storm/topology/BasicBoltExecutor.html" title="class in org.apache.storm.topology">BasicBoltExecutor</a>, <a href="../../../../org/apache/storm/coordination/BatchBoltExecutor.html" title="class in org.apache.storm.coordination">BatchBoltExecutor</a>, <a href="../../../../org/apache/storm/cassandra/bolt/BatchCassandraWriterBolt.html" title="class in org.apache.storm.cassandra.bolt">BatchCassandraWriterBolt</a>, <a href="../../../../org/apache/storm/starter/BlobStoreAPIWordCountTopology.SplitSentence.html" title="class in org.apache.storm.starter">BlobStoreAPIWordCountTopology.SplitSentence</a>, <a href="../../../../org/apache/storm/testing/BoltTracker.html" title="class in org.apache.storm.testing">BoltTracker</a>, <a href="../../../../org/apache/storm/cassandra/bolt/CassandraWriterBolt.html" title="class in org.apache.storm.cassandra.bolt">CassandraWriterBolt</a>, <a href="../../../../org/apache/storm/topology/CheckpointTupleForwarder.html" title="class in org.apache.storm.topology">CheckpointTupleForwarder</a>, <a href="../../../../org/apache/storm/clojure/ClojureBolt.html" title="class in org.apache.storm.clojure">ClojureBolt</a>, <a href="../../../../org/apache/storm/coordination/CoordinatedBolt.html" title="class in org.apache.storm.coordination">CoordinatedBolt</a>, <a href="../../../../org/apache/storm/perf/bolt/DevNullBolt.html" title="class in org.apache.storm.perf.bolt">DevNullBolt</a>, <a href="../../../../org/apache/storm/elasticsearch/bolt/EsIndexBolt.html" title="class in org.apache.storm.elasticsearch.bolt">EsIndexBolt</a>, <a href="../../../../org/apache/storm/elasticsearch/bolt/EsLookupBolt.html" title="class in org.apache.storm.elasticsearch.bolt">EsLookupBolt</a>, <a href="../../../../org/apache/storm/elasticsearch/bolt/EsPercolateBolt.html" title="class in org.apache.storm.elasticsearch.bolt">EsPercolateBolt</a>, <a href="../../../../org/apache/storm/eventhubs/bolt/EventHubBolt.html" title="class in org.apache.storm.eventhubs.bolt">EventHubBolt</a>, <a href="../../../../org/apache/storm/ExclamationTopology.ExclamationBolt.html" title="class in org.apache.storm">ExclamationTopology.ExclamationBolt</a>, <a href="../../../../org/apache/storm/starter/ExclamationTopology.ExclamationBolt.html" title="class in org.apache.storm.starter">ExclamationTopology.ExclamationBolt</a>, <a href="../../../../org/apache/storm/flux/wrappers/bolts/FluxShellBolt.html" title="class in org.apache.storm.flux.wrappers.bolts">FluxShellBolt</a>, <a href="../../../../org/apache/storm/jms/example/GenericBolt.html" title="class in org.apache.storm.jms.example">GenericBolt</a>, <a href="../../../../org/apache/storm/hbase/bolt/HBaseBolt.html" title="class in org.apache.storm.hbase.bolt">HBaseBolt</a>, <a href="../../../../org/apache/storm/hbase/bolt/HBaseLookupBolt.html" title="class in org.apache.storm.hbase.bolt">HBaseLookupBolt</a>, <a href="../../../../org/apache/storm/hdfs/bolt/HdfsBolt.html" title="class in org.apache.storm.hdfs.bolt">HdfsBolt</a>, <a href="../../../../org/apache/storm/hdfs/bolt/HdfsFileTopology.MyBolt.html" title="class in org.apache.storm.hdfs.bolt">HdfsFileTopology.MyBolt</a>, <a href="../../../../org/apache/storm/hdfs/spout/HdfsSpoutTopology.ConstBolt.html" title="class in org.apache.storm.hdfs.spout">HdfsSpoutTopology.ConstBolt</a>, <a href="../../../../org/apache/storm/hive/bolt/HiveBolt.html" title="class in org.apache.storm.hive.bolt">HiveBolt</a>, <a href="../../../../org/apache/storm/perf/bolt/IdBolt.html" title="class in org.apache.storm.perf.bolt">IdBolt</a>, <a href="../../../../org/apache/storm/perf/utils/IdentityBolt.html" title="class in org.apache.storm.perf.utils">IdentityBolt</a>, <a href="../../../../org/apache/storm/jdbc/bolt/JdbcInsertBolt.html" title="class in org.apache.storm.jdbc.bolt">JdbcInsertBolt</a>, <a href="../../../../org/apache/storm/jdbc/bolt/JdbcLookupBolt.html" title="class in org.apache.storm.jdbc.bolt">JdbcLookupBolt</a>, <a href="../../../../org/apache/storm/jms/bolt/JmsBolt.html" title="class in org.apache.storm.jms.bolt">JmsBolt</a>, <a href="../../../../org/apache/storm/drpc/JoinResult.html" title="class in org.apache.storm.drpc">JoinResult</a>, <a href="../../../../org/apache/storm/kafka/bolt/KafkaBolt.html" title="class in org.apache.storm.kafka.bolt">KafkaBolt</a>, <a href="../../../../org/apache/storm/kafka/spout/KafkaSpoutTestBolt.html" title="class in org.apache.storm.kafka.spout">KafkaSpoutTestBolt</a>, <a href="../../../../org/apache/storm/drpc/KeyedFairBolt.html" title="class in org.apache.storm.drpc">KeyedFairBolt</a>, <a href="../../../../org/apache/storm/loadgen/LoadBolt.html" title="class in org.apache.storm.loadgen">LoadBolt</a>, <a href="../../../../org/apache/storm/redis/topology/LookupWordCount.PrintWordTotalCountBolt.html" title="class in org.apache.storm.redis.topology">LookupWordCount.PrintWordTotalCountBolt</a>, <a href="../../../../org/apache/storm/mongodb/bolt/MongoInsertBolt.html" title="class in org.apache.storm.mongodb.bolt">MongoInsertBolt</a>, <a href="../../../../org/apache/storm/mongodb/bolt/MongoLookupBolt.html" title="class in org.apache.storm.mongodb.bolt">MongoLookupBolt</a>, <a href="../../../../org/apache/storm/mongodb/bolt/MongoUpdateBolt.html" title="class in org.apache.storm.mongodb.bolt">MongoUpdateBolt</a>, <a href="../../../../org/apache/storm/mqtt/bolt/MqttBolt.html" title="class in org.apache.storm.mqtt.bolt">MqttBolt</a>, <a href="../../../../org/apache/storm/starter/MultipleLoggerTopology.ExclamationLoggingBolt.html" title="class in org.apache.storm.starter">MultipleLoggerTopology.ExclamationLoggingBolt</a>, <a href="../../../../org/apache/storm/opentsdb/bolt/OpenTsdbBolt.html" title="class in org.apache.storm.opentsdb.bolt">OpenTsdbBolt</a>, <a href="../../../../org/apache/storm/topology/PersistentWindowedBoltExecutor.html" title="class in org.apache.storm.topology">PersistentWindowedBoltExecutor</a>, <a href="../../../../org/apache/storm/pmml/PMMLPredictorBolt.html" title="class in org.apache.storm.pmml">PMMLPredictorBolt</a>, <a href="../../../../org/apache/storm/testing/PythonShellMetricsBolt.html" title="class in org.apache.storm.testing">PythonShellMetricsBolt</a>, <a href="../../../../org/apache/storm/redis/bolt/RedisFilterBolt.html" title="class in org.apache.storm.redis.bolt">RedisFilterBolt</a>, <a href="../../../../org/apache/storm/redis/bolt/RedisLookupBolt.html" title="class in org.apache.storm.redis.bolt">RedisLookupBolt</a>, <a href="../../../../org/apache/storm/redis/bolt/RedisStoreBolt.html" title="class in org.apache.storm.redis.bolt">RedisStoreBolt</a>, <a href="../../../../org/apache/storm/starter/ResourceAwareExampleTopology.ExclamationBolt.html" title="class in org.apache.storm.starter">ResourceAwareExampleTopology.ExclamationBolt</a>, <a href="../../../../org/apache/storm/drpc/ReturnResults.html" title="class in org.apache.storm.drpc">ReturnResults</a>, <a href="../../../../org/apache/storm/clojure/RichShellBolt.html" title="class in org.apache.storm.clojure">RichShellBolt</a>, <a href="../../../../org/apache/storm/rocketmq/bolt/RocketMqBolt.html" title="class in org.apache.storm.rocketmq.bolt">RocketMqBolt</a>, <a href="../../../../org/apache/storm/starter/bolt/RollingCountAggBolt.html" title="class in org.apache.storm.starter.bolt">RollingCountAggBolt</a>, <a href="../../../../org/apache/storm/starter/bolt/RollingCountBolt.html" title="class in org.apache.storm.starter.bolt">RollingCountBolt</a>, <a href="../../../../org/apache/storm/hdfs/bolt/SequenceFileBolt.html" title="class in org.apache.storm.hdfs.bolt">SequenceFileBolt</a>, <a href="../../../../org/apache/storm/hdfs/bolt/SequenceFileTopology.MyBolt.html" title="class in org.apache.storm.hdfs.bolt">SequenceFileTopology.MyBolt</a>, <a href="../../../../org/apache/storm/starter/bolt/SingleJoinBolt.html" title="class in org.apache.storm.starter.bolt">SingleJoinBolt</a>, <a href="../../../../org/apache/storm/sql/runtime/datasource/socket/bolt/SocketBolt.html" title="class in org.apache.storm.sql.runtime.datasource.socket.bolt">SocketBolt</a>, <a href="../../../../org/apache/storm/solr/bolt/SolrUpdateBolt.html" title="class in org.apache.storm.solr.bolt">SolrUpdateBolt</a>, <a href="../../../../org/apache/storm/topology/StatefulBoltExecutor.html" title="class in org.apache.storm.topology">StatefulBoltExecutor</a>, <a href="../../../../org/apache/storm/topology/StatefulWindowedBoltExecutor.html" title="class in org.apache.storm.topology">StatefulWindowedBoltExecutor</a>, <a href="../../../../org/apache/storm/testing/TestAggregatesCounter.html" title="class in org.apache.storm.testing">TestAggregatesCounter</a>, <a href="../../../../org/apache/storm/testing/TestEventOrderCheckBolt.html" title="class in org.apache.storm.testing">TestEventOrderCheckBolt</a>, <a href="../../../../org/apache/storm/testing/TestGlobalCount.html" title="class in org.apache.storm.testing">TestGlobalCount</a>, <a href="../../../../org/apache/storm/testing/TestPlannerBolt.html" title="class in org.apache.storm.testing">TestPlannerBolt</a>, <a href="../../../../org/apache/storm/trident/topology/TridentBoltExecutor.html" title="class in org.apache.storm.trident.topology">TridentBoltExecutor</a>, <a href="../../../../org/apache/storm/testing/TupleCaptureBolt.html" title="class in org.apache.storm.testing">TupleCaptureBolt</a>, <a href="../../../../org/apache/storm/redis/topology/WhitelistWordCount.PrintWordTotalCountBolt.html" title="class in org.apache.storm.redis.topology">WhitelistWordCount.PrintWordTotalCountBolt</a>, <a href="../../../../org/apache/storm/topology/WindowedBoltExecutor.html" title="class in org.apache.storm.topology">WindowedBoltExecutor</a>, <a href="../../../../org/apache/storm/starter/WordCountTopology.SplitSentence.html" title="class in org.apache.storm.starter">WordCountTopology.SplitSentence</a>, <a href="../../../../org/apache/storm/starter/WordCountTopologyNode.SplitSentence.html" title="class in org.apache.storm.starter">WordCountTopologyNode.SplitSentence</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">IRichBolt</span>
extends <a href="../../../../org/apache/storm/task/IBolt.html" title="interface in org.apache.storm.task">IBolt</a>, <a href="../../../../org/apache/storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></pre>
<div class="block"><p>When writing topologies using Java, <a href="../../../../org/apache/storm/topology/IRichBolt.html" title="interface in org.apache.storm.topology"><code>IRichBolt</code></a> and <a href="../../../../org/apache/storm/topology/IRichSpout.html" title="interface in org.apache.storm.topology"><code>IRichSpout</code></a> are the main interfaces to use to implement components of the topology.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.task.IBolt">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.storm.task.<a href="../../../../org/apache/storm/task/IBolt.html" title="interface in org.apache.storm.task">IBolt</a></h3>
<code><a href="../../../../org/apache/storm/task/IBolt.html#cleanup--">cleanup</a>, <a href="../../../../org/apache/storm/task/IBolt.html#execute-org.apache.storm.tuple.Tuple-">execute</a>, <a href="../../../../org/apache/storm/task/IBolt.html#prepare-java.util.Map-org.apache.storm.task.TopologyContext-org.apache.storm.task.OutputCollector-">prepare</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.topology.IComponent">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.storm.topology.<a href="../../../../org/apache/storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></h3>
<code><a href="../../../../org/apache/storm/topology/IComponent.html#declareOutputFields-org.apache.storm.topology.OutputFieldsDeclarer-">declareOutputFields</a>, <a href="../../../../org/apache/storm/topology/IComponent.html#getComponentConfiguration--">getComponentConfiguration</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IRichBolt.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><script type="text/javascript" src="../../../../highlight.pack.js"></script>
<script type="text/javascript"><!--
hljs.initHighlightingOnLoad();
//--></script></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="interface in org.apache.storm.topology"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/storm/topology/IRichSpout.html" title="interface in org.apache.storm.topology"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/topology/IRichBolt.html" target="_top">Frames</a></li>
<li><a href="IRichBolt.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>