| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>KafkaBolt (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.kafka.bolt, class: KafkaBolt"> |
| <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/KafkaBolt.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.kafka.bolt</a></div> |
| <h1 title="Class KafkaBolt" class="title">Class KafkaBolt<K,<wbr>V></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"><a href="../../topology/base/BaseTickTupleAwareRichBolt.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseTickTupleAwareRichBolt</a> |
| <div class="inheritance">org.apache.storm.kafka.bolt.KafkaBolt<K,<wbr>V></div> |
| </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> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">KafkaBolt<K,<wbr>V></span> |
| <span class="extends-implements">extends <a href="../../topology/base/BaseTickTupleAwareRichBolt.html" title="class in org.apache.storm.topology.base">BaseTickTupleAwareRichBolt</a></span></div> |
| <div class="block">Bolt implementation that can send Tuple data to Kafka. |
| <p/> |
| Most configuration for this bolt should be through the various |
| setter methods in the bolt. |
| For backwards compatibility it supports the producer |
| configuration and topic to be placed in the storm config under |
| <p/> |
| 'kafka.broker.properties' and 'topic' |
| <p/> |
| respectively.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../serialized-form.html#org.apache.storm.kafka.bolt.KafkaBolt">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>static final <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"><code><a href="#TOPIC" class="member-name-link">TOPIC</a></code></div> |
| <div class="col-last even-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">KafkaBolt</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 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> declarer)</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-tab4"><code>protected org.apache.kafka.clients.producer.Producer<<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#mkProducer(java.util.Properties)" class="member-name-link">mkProducer</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> props)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Intended to be overridden for tests.</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="#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>> topoConf, |
| <a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context, |
| <a href="../../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a> collector)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Called when a task for this component is initialized within a worker on the cluster.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#process(org.apache.storm.tuple.Tuple)" class="member-name-link">process</a><wbr>(<a href="../../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> input)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Process a single non-tick tuple of input.</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="#setAsync(boolean)" class="member-name-link">setAsync</a><wbr>(boolean async)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">If set to true(the default) the bolt will not wait for the message |
| to be fully sent to Kafka before getting another tuple to send.</div> |
| </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="#setFireAndForget(boolean)" class="member-name-link">setFireAndForget</a><wbr>(boolean fireAndForget)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">If set to true the bolt will assume that sending a message to kafka will succeed and will ack |
| the tuple as soon as it has handed the message off to the producer API |
| if false (the default) the message will be acked after it was successfully sent to kafka or |
| failed if it was not successfully sent.</div> |
| </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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</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="KafkaBolt.html" title="class in org.apache.storm.kafka.bolt">KafkaBolt</a><<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withProducerCallback(org.apache.storm.kafka.bolt.PreparableCallback)" class="member-name-link">withProducerCallback</a><wbr>(<a href="PreparableCallback.html" title="interface in org.apache.storm.kafka.bolt">PreparableCallback</a> producerCallback)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets a user defined callback for use with the KafkaProducer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaBolt.html" title="class in org.apache.storm.kafka.bolt">KafkaBolt</a><<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withProducerProperties(java.util.Properties)" class="member-name-link">withProducerProperties</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> producerProperties)</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="KafkaBolt.html" title="class in org.apache.storm.kafka.bolt">KafkaBolt</a><<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTopicSelector(java.lang.String)" class="member-name-link">withTopicSelector</a><wbr>(<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> topic)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the messages to be published to a single topic.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="KafkaBolt.html" title="class in org.apache.storm.kafka.bolt">KafkaBolt</a><<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTopicSelector(org.apache.storm.kafka.bolt.selector.KafkaTopicSelector)" class="member-name-link">withTopicSelector</a><wbr>(<a href="selector/KafkaTopicSelector.html" title="interface in org.apache.storm.kafka.bolt.selector">KafkaTopicSelector</a> selector)</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="KafkaBolt.html" title="class in org.apache.storm.kafka.bolt">KafkaBolt</a><<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTupleToKafkaMapper(org.apache.storm.kafka.bolt.mapper.TupleToKafkaMapper)" class="member-name-link">withTupleToKafkaMapper</a><wbr>(<a href="mapper/TupleToKafkaMapper.html" title="interface in org.apache.storm.kafka.bolt.mapper">TupleToKafkaMapper</a><<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>> mapper)</code></div> |
| <div class="col-last even-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-org.apache.storm.topology.base.BaseTickTupleAwareRichBolt">Methods inherited from class org.apache.storm.topology.base.<a href="../../topology/base/BaseTickTupleAwareRichBolt.html" title="class in org.apache.storm.topology.base">BaseTickTupleAwareRichBolt</a></h3> |
| <code><a href="../../topology/base/BaseTickTupleAwareRichBolt.html#execute(org.apache.storm.tuple.Tuple)">execute</a>, <a href="../../topology/base/BaseTickTupleAwareRichBolt.html#onTickTuple(org.apache.storm.tuple.Tuple)">onTickTuple</a></code></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="../../topology/base/BaseComponent.html" title="class in org.apache.storm.topology.base">BaseComponent</a></h3> |
| <code><a href="../../topology/base/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#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.topology.IComponent">Methods inherited from interface org.apache.storm.topology.<a href="../../topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></h3> |
| <code><a href="../../topology/IComponent.html#getComponentConfiguration()">getComponentConfiguration</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="TOPIC"> |
| <h3>TOPIC</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/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">TOPIC</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.storm.kafka.bolt.KafkaBolt.TOPIC">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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>KafkaBolt</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">KafkaBolt</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="withTupleToKafkaMapper(org.apache.storm.kafka.bolt.mapper.TupleToKafkaMapper)"> |
| <h3>withTupleToKafkaMapper</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaBolt.html" title="class in org.apache.storm.kafka.bolt">KafkaBolt</a><<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>></span> <span class="element-name">withTupleToKafkaMapper</span><wbr><span class="parameters">(<a href="mapper/TupleToKafkaMapper.html" title="interface in org.apache.storm.kafka.bolt.mapper">TupleToKafkaMapper</a><<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>> mapper)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withTopicSelector(java.lang.String)"> |
| <h3>withTopicSelector</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaBolt.html" title="class in org.apache.storm.kafka.bolt">KafkaBolt</a><<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>></span> <span class="element-name">withTopicSelector</span><wbr><span class="parameters">(<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> topic)</span></div> |
| <div class="block">Set the messages to be published to a single topic.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topic</code> - the topic to publish to</dd> |
| <dt>Returns:</dt> |
| <dd>this</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withTopicSelector(org.apache.storm.kafka.bolt.selector.KafkaTopicSelector)"> |
| <h3>withTopicSelector</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaBolt.html" title="class in org.apache.storm.kafka.bolt">KafkaBolt</a><<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>></span> <span class="element-name">withTopicSelector</span><wbr><span class="parameters">(<a href="selector/KafkaTopicSelector.html" title="interface in org.apache.storm.kafka.bolt.selector">KafkaTopicSelector</a> selector)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withProducerProperties(java.util.Properties)"> |
| <h3>withProducerProperties</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaBolt.html" title="class in org.apache.storm.kafka.bolt">KafkaBolt</a><<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>></span> <span class="element-name">withProducerProperties</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> producerProperties)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withProducerCallback(org.apache.storm.kafka.bolt.PreparableCallback)"> |
| <h3>withProducerCallback</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="KafkaBolt.html" title="class in org.apache.storm.kafka.bolt">KafkaBolt</a><<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>></span> <span class="element-name">withProducerCallback</span><wbr><span class="parameters">(<a href="PreparableCallback.html" title="interface in org.apache.storm.kafka.bolt">PreparableCallback</a> producerCallback)</span></div> |
| <div class="block">Sets a user defined callback for use with the KafkaProducer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>producerCallback</code> - user defined callback</dd> |
| <dt>Returns:</dt> |
| <dd>this</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</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>> topoConf, |
| <a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a> context, |
| <a href="../../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a> collector)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../../task/IBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">IBolt</a></code></span></div> |
| <div class="block">Called when a task for this component is initialized within a worker on the cluster. It provides the bolt with the environment in |
| which the bolt executes. |
| |
| <p>This includes the:</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topoConf</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>context</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="mkProducer(java.util.Properties)"> |
| <h3>mkProducer</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.apache.kafka.clients.producer.Producer<<a href="KafkaBolt.html" title="type parameter in KafkaBolt">K</a>,<wbr><a href="KafkaBolt.html" title="type parameter in KafkaBolt">V</a>></span> <span class="element-name">mkProducer</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> props)</span></div> |
| <div class="block">Intended to be overridden for tests. Make the producer with the given props</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="process(org.apache.storm.tuple.Tuple)"> |
| <h3>process</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">process</span><wbr><span class="parameters">(<a href="../../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a> input)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../../topology/base/BaseTickTupleAwareRichBolt.html#process(org.apache.storm.tuple.Tuple)">BaseTickTupleAwareRichBolt</a></code></span></div> |
| <div class="block">Process a single non-tick tuple of input. Implementation needs to handle ack manually. More details on <a href="../../task/IBolt.html#execute(org.apache.storm.tuple.Tuple)"><code>IBolt.execute(Tuple)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../topology/base/BaseTickTupleAwareRichBolt.html#process(org.apache.storm.tuple.Tuple)">process</a></code> in class <code><a href="../../topology/base/BaseTickTupleAwareRichBolt.html" title="class in org.apache.storm.topology.base">BaseTickTupleAwareRichBolt</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>input</code> - The input tuple to be processed.</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> declarer)</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>declarer</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="setFireAndForget(boolean)"> |
| <h3>setFireAndForget</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setFireAndForget</span><wbr><span class="parameters">(boolean fireAndForget)</span></div> |
| <div class="block">If set to true the bolt will assume that sending a message to kafka will succeed and will ack |
| the tuple as soon as it has handed the message off to the producer API |
| if false (the default) the message will be acked after it was successfully sent to kafka or |
| failed if it was not successfully sent.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fireAndForget</code> - whether the bolt should fire and forget</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAsync(boolean)"> |
| <h3>setAsync</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAsync</span><wbr><span class="parameters">(boolean async)</span></div> |
| <div class="block">If set to true(the default) the bolt will not wait for the message |
| to be fully sent to Kafka before getting another tuple to send.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>async</code> - true to have multiple tuples in flight to kafka, else false.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></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> |
