blob: 85b92a2cc864bb4926fc88013103a816c322e8a5 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.storm.topology (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">
<meta name="generator" content="javadoc/PackageWriterImpl">
<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="package-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 class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.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#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li>Description&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</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">
<div class="header">
<h1 title="Package org.apache.storm.topology" class="title">Package org.apache.storm.topology</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.storm.topology</span></div>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.storm</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="base/package-summary.html">org.apache.storm.topology.base</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BaseConfigurationDeclarer.html" title="class in org.apache.storm.topology">BaseConfigurationDeclarer</a>&lt;T extends <a href="ComponentConfigurationDeclarer.html" title="interface in org.apache.storm.topology">ComponentConfigurationDeclarer</a>&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BaseStatefulBoltExecutor.html" title="class in org.apache.storm.topology">BaseStatefulBoltExecutor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Base class that abstracts the common logic for executing bolts in a stateful topology.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BaseStatefulBoltExecutor.AnchoringOutputCollector.html" title="class in org.apache.storm.topology">BaseStatefulBoltExecutor.AnchoringOutputCollector</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BasicBoltExecutor.html" title="class in org.apache.storm.topology">BasicBoltExecutor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BasicOutputCollector.html" title="class in org.apache.storm.topology">BasicOutputCollector</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">BoltDeclarer includes grouping APIs for storm topology.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CheckpointTupleForwarder.html" title="class in org.apache.storm.topology">CheckpointTupleForwarder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Wraps <a href="IRichBolt.html" title="interface in org.apache.storm.topology"><code>IRichBolt</code></a> and forwards checkpoint tuples in a stateful topology.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ComponentConfigurationDeclarer.html" title="interface in org.apache.storm.topology">ComponentConfigurationDeclarer</a>&lt;T extends <a href="ComponentConfigurationDeclarer.html" title="interface in org.apache.storm.topology">ComponentConfigurationDeclarer</a>&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ConfigurableTopology.html" title="class in org.apache.storm.topology">ConfigurableTopology</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Extensions of this class takes a reference to one or more configuration files.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="FailedException.html" title="class in org.apache.storm.topology">FailedException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="IBasicBolt.html" title="interface in org.apache.storm.topology">IBasicBolt</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="IBasicOutputCollector.html" title="interface in org.apache.storm.topology">IBasicOutputCollector</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Common methods for all possible components in a topology.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a>&lt;T extends <a href="InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a>&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="IRichBolt.html" title="interface in org.apache.storm.topology">IRichBolt</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">When writing topologies using Java, <a href="IRichBolt.html" title="interface in org.apache.storm.topology"><code>IRichBolt</code></a> and <a href="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.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="IRichSpout.html" title="interface in org.apache.storm.topology">IRichSpout</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">When writing topologies using Java, <a href="IRichBolt.html" title="interface in org.apache.storm.topology"><code>IRichBolt</code></a> and <a href="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.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="IRichStateSpout.html" title="interface in org.apache.storm.topology">IRichStateSpout</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="IStatefulBolt.html" title="interface in org.apache.storm.topology">IStatefulBolt</a>&lt;T extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A bolt abstraction for supporting stateful computation.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="IStatefulComponent.html" title="interface in org.apache.storm.topology">IStatefulComponent</a>&lt;T extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">
Common methods for stateful components in the topology.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology">IStatefulWindowedBolt</a>&lt;T extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A windowed bolt abstraction for supporting windowing operation with state.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A bolt abstraction for supporting time and count based sliding &amp; tumbling windows.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="OutputFieldsGetter.html" title="class in org.apache.storm.topology">OutputFieldsGetter</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PersistentWindowedBoltExecutor.html" title="class in org.apache.storm.topology">PersistentWindowedBoltExecutor</a>&lt;T extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Wraps a <a href="IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology"><code>IStatefulWindowedBolt</code></a> and handles the execution.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="ReportedFailedException.html" title="class in org.apache.storm.topology">ReportedFailedException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a>&lt;T extends <a href="ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a>&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">This is a new base interface that can be used by anything that wants to mirror RAS's basic API.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SharedOffHeapWithinNode.html" title="class in org.apache.storm.topology">SharedOffHeapWithinNode</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A request for a shared memory region off heap between workers on a node.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SharedOffHeapWithinWorker.html" title="class in org.apache.storm.topology">SharedOffHeapWithinWorker</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A request for a shared memory region off heap, but only within a worker.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SharedOnHeap.html" title="class in org.apache.storm.topology">SharedOnHeap</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A request for a shared memory region on heap.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SpoutDeclarer.html" title="interface in org.apache.storm.topology">SpoutDeclarer</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="StatefulBoltExecutor.html" title="class in org.apache.storm.topology">StatefulBoltExecutor</a>&lt;T extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Wraps a <a href="IStatefulBolt.html" title="interface in org.apache.storm.topology"><code>IStatefulBolt</code></a> and manages the state of the bolt.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StatefulWindowedBoltExecutor.html" title="class in org.apache.storm.topology">StatefulWindowedBoltExecutor</a>&lt;T extends <a href="../state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Wraps a <a href="IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology"><code>IStatefulWindowedBolt</code></a> and handles the execution.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TopologyBuilder.html" title="class in org.apache.storm.topology">TopologyBuilder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">TopologyBuilder exposes the Java API for specifying a topology for Storm to execute.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TupleFieldTimestampExtractor.html" title="class in org.apache.storm.topology">TupleFieldTimestampExtractor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A <a href="../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing"><code>TimestampExtractor</code></a> that extracts timestamp from a specific field in the tuple.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="WindowedBoltExecutor.html" title="class in org.apache.storm.topology">WindowedBoltExecutor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">An <a href="IWindowedBolt.html" title="interface in org.apache.storm.topology"><code>IWindowedBolt</code></a> wrapper that does the windowing of tuples.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>