| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ITridentSpout (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.trident.spout, interface: ITridentSpout"> |
| <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/ITridentSpout.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.trident.spout</a></div> |
| <h1 title="Interface ITridentSpout" class="title">Interface ITridentSpout<T></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="ITridentDataSource.html" title="interface in org.apache.storm.trident.spout">ITridentDataSource</a></code>, <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></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="ICommitterTridentSpout.html" title="interface in org.apache.storm.trident.spout">ICommitterTridentSpout</a><X></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="BatchSpoutExecutor.html" title="class in org.apache.storm.trident.spout">BatchSpoutExecutor</a></code>, <code><a href="../testing/FeederBatchSpout.html" title="class in org.apache.storm.trident.testing">FeederBatchSpout</a></code>, <code><a href="../testing/FeederCommitterBatchSpout.html" title="class in org.apache.storm.trident.testing">FeederCommitterBatchSpout</a></code>, <code><a href="OpaquePartitionedTridentSpoutExecutor.html" title="class in org.apache.storm.trident.spout">OpaquePartitionedTridentSpoutExecutor</a></code>, <code><a href="PartitionedTridentSpoutExecutor.html" title="class in org.apache.storm.trident.spout">PartitionedTridentSpoutExecutor</a></code>, <code><a href="RichSpoutBatchExecutor.html" title="class in org.apache.storm.trident.spout">RichSpoutBatchExecutor</a></code>, <code><a href="../../jms/trident/TridentJmsSpout.html" title="class in org.apache.storm.jms.trident">TridentJmsSpout</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ITridentSpout<T></span><span class="extends-implements"> |
| extends <a href="ITridentDataSource.html" title="interface in org.apache.storm.trident.spout">ITridentDataSource</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="ITridentSpout.BatchCoordinator.html" class="type-name-link" title="interface in org.apache.storm.trident.spout">ITridentSpout.BatchCoordinator</a><<a href="ITridentSpout.BatchCoordinator.html" title="type parameter in ITridentSpout.BatchCoordinator">X</a>></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static interface </code></div> |
| <div class="col-second odd-row-color"><code><a href="ITridentSpout.Emitter.html" class="type-name-link" title="interface in org.apache.storm.trident.spout">ITridentSpout.Emitter</a><<a href="ITridentSpout.Emitter.html" title="type parameter in ITridentSpout.Emitter">X</a>></code></div> |
| <div class="col-last odd-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></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-tab3"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getComponentConfiguration()" class="member-name-link">getComponentConfiguration</a>()</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><a href="ITridentSpout.BatchCoordinator.html" title="interface in org.apache.storm.trident.spout">ITridentSpout.BatchCoordinator</a><<a href="ITridentSpout.html" title="type parameter in ITridentSpout">T</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCoordinator(java.lang.String,java.util.Map,org.apache.storm.task.TopologyContext)" class="member-name-link">getCoordinator</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> txStateId, |
| <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> context)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">The coordinator for a TransactionalSpout runs in a single thread and indicates when batches of tuples should be |
| emitted.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ITridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout">ITridentSpout.Emitter</a><<a href="ITridentSpout.html" title="type parameter in ITridentSpout">T</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEmitter(java.lang.String,java.util.Map,org.apache.storm.task.TopologyContext)" class="member-name-link">getEmitter</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> txStateId, |
| <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> context)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">The emitter for a TransactionalSpout runs as many tasks across the cluster.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOutputFields()" class="member-name-link">getOutputFields</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getCoordinator(java.lang.String,java.util.Map,org.apache.storm.task.TopologyContext)"> |
| <h3>getCoordinator</h3> |
| <div class="member-signature"><span class="return-type"><a href="ITridentSpout.BatchCoordinator.html" title="interface in org.apache.storm.trident.spout">ITridentSpout.BatchCoordinator</a><<a href="ITridentSpout.html" title="type parameter in ITridentSpout">T</a>></span> <span class="element-name">getCoordinator</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> txStateId, |
| <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> context)</span></div> |
| <div class="block">The coordinator for a TransactionalSpout runs in a single thread and indicates when batches of tuples should be |
| emitted. The Coordinator that you provide in a TransactionalSpout provides metadata for each transaction so that |
| the transactions can be replayed in case of failure. |
| |
| <p>Two instances are requested, one on the master batch coordinator where isReady() is called, and an instance in |
| the coordinator bolt which is used for all other operations. The two instances do not necessarily share a worker |
| JVM.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>txStateId</code> - stream id</dd> |
| <dd><code>conf</code> - Storm config map</dd> |
| <dd><code>context</code> - topology context</dd> |
| <dt>Returns:</dt> |
| <dd>spout coordinator instance</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEmitter(java.lang.String,java.util.Map,org.apache.storm.task.TopologyContext)"> |
| <h3>getEmitter</h3> |
| <div class="member-signature"><span class="return-type"><a href="ITridentSpout.Emitter.html" title="interface in org.apache.storm.trident.spout">ITridentSpout.Emitter</a><<a href="ITridentSpout.html" title="type parameter in ITridentSpout">T</a>></span> <span class="element-name">getEmitter</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> txStateId, |
| <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> context)</span></div> |
| <div class="block">The emitter for a TransactionalSpout runs as many tasks across the cluster. Emitters are responsible for emitting |
| batches of tuples for a transaction and must ensure that the same batch of tuples is always emitted for the same |
| transaction id. |
| |
| <p>All emitter tasks get the same transaction metadata. The topology context parameter contains the instance task |
| id that can be used to distribute the work across the tasks.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>txStateId</code> - stream id</dd> |
| <dd><code>conf</code> - Storm config map</dd> |
| <dd><code>context</code> - topology context</dd> |
| <dt>Returns:</dt> |
| <dd>spout emitter</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComponentConfiguration()"> |
| <h3>getComponentConfiguration</h3> |
| <div class="member-signature"><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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOutputFields()"> |
| <h3>getOutputFields</h3> |
| <div class="member-signature"><span class="return-type"><a href="../../tuple/Fields.html" title="class in org.apache.storm.tuple">Fields</a></span> <span class="element-name">getOutputFields</span>()</div> |
| </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> |
