Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / current / javadocs / org / apache / storm / topology / package-summary.html
blob: 73033c0a0e3dc0b6bea9aa79563f8064ab7dc963 [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>org.apache.storm.topology (Storm 2.4.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="org.apache.storm.topology (Storm 2.4.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 class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/storm/testing/staticmocking/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/storm/topology/base/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/topology/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.storm.topology</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/BoltDeclarer.html" title="interface in org.apache.storm.topology">BoltDeclarer</a></td>
<td class="colLast">
<div class="block">BoltDeclarer includes grouping APIs for storm topology.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html" title="interface in org.apache.storm.topology">ComponentConfigurationDeclarer</a>&lt;T extends <a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html" title="interface in org.apache.storm.topology">ComponentConfigurationDeclarer</a>&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/IBasicBolt.html" title="interface in org.apache.storm.topology">IBasicBolt</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/IBasicOutputCollector.html" title="interface in org.apache.storm.topology">IBasicOutputCollector</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></td>
<td class="colLast">
<div class="block">Common methods for all possible components in a topology.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a>&lt;T extends <a href="../../../../org/apache/storm/topology/InputDeclarer.html" title="interface in org.apache.storm.topology">InputDeclarer</a>&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/IRichBolt.html" title="interface in org.apache.storm.topology">IRichBolt</a></td>
<td class="colLast">
<div class="block">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.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/IRichSpout.html" title="interface in org.apache.storm.topology">IRichSpout</a></td>
<td class="colLast">
<div class="block">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.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/IRichStateSpout.html" title="interface in org.apache.storm.topology">IRichStateSpout</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/IStatefulBolt.html" title="interface in org.apache.storm.topology">IStatefulBolt</a>&lt;T extends <a href="../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</td>
<td class="colLast">
<div class="block">A bolt abstraction for supporting stateful computation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/IStatefulComponent.html" title="interface in org.apache.storm.topology">IStatefulComponent</a>&lt;T extends <a href="../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</td>
<td class="colLast">
<div class="block">
Common methods for stateful components in the topology.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology">IStatefulWindowedBolt</a>&lt;T extends <a href="../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</td>
<td class="colLast">
<div class="block">A windowed bolt abstraction for supporting windowing operation with state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></td>
<td class="colLast">
<div class="block">A bolt abstraction for supporting time and count based sliding &amp; tumbling windows.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a>&lt;T extends <a href="../../../../org/apache/storm/topology/ResourceDeclarer.html" title="interface in org.apache.storm.topology">ResourceDeclarer</a>&gt;</td>
<td class="colLast">
<div class="block">This is a new base interface that can be used by anything that wants to mirror RAS&rsquo;s basic API.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/SpoutDeclarer.html" title="interface in org.apache.storm.topology">SpoutDeclarer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/BaseConfigurationDeclarer.html" title="class in org.apache.storm.topology">BaseConfigurationDeclarer</a>&lt;T extends <a href="../../../../org/apache/storm/topology/ComponentConfigurationDeclarer.html" title="interface in org.apache.storm.topology">ComponentConfigurationDeclarer</a>&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/BaseStatefulBoltExecutor.html" title="class in org.apache.storm.topology">BaseStatefulBoltExecutor</a></td>
<td class="colLast">
<div class="block">Base class that abstracts the common logic for executing bolts in a stateful topology.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/BaseStatefulBoltExecutor.AnchoringOutputCollector.html" title="class in org.apache.storm.topology">BaseStatefulBoltExecutor.AnchoringOutputCollector</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/BasicBoltExecutor.html" title="class in org.apache.storm.topology">BasicBoltExecutor</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/BasicOutputCollector.html" title="class in org.apache.storm.topology">BasicOutputCollector</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/CheckpointTupleForwarder.html" title="class in org.apache.storm.topology">CheckpointTupleForwarder</a></td>
<td class="colLast">
<div class="block">Wraps <a href="../../../../org/apache/storm/topology/IRichBolt.html" title="interface in org.apache.storm.topology"><code>IRichBolt</code></a> and forwards checkpoint tuples in a stateful topology.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/ConfigurableTopology.html" title="class in org.apache.storm.topology">ConfigurableTopology</a></td>
<td class="colLast">
<div class="block">Extensions of this class takes a reference to one or more configuration files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/OutputFieldsGetter.html" title="class in org.apache.storm.topology">OutputFieldsGetter</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/PersistentWindowedBoltExecutor.html" title="class in org.apache.storm.topology">PersistentWindowedBoltExecutor</a>&lt;T extends <a href="../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</td>
<td class="colLast">
<div class="block">Wraps a <a href="../../../../org/apache/storm/topology/IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology"><code>IStatefulWindowedBolt</code></a> and handles the execution.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/SharedOffHeapWithinNode.html" title="class in org.apache.storm.topology">SharedOffHeapWithinNode</a></td>
<td class="colLast">
<div class="block">A request for a shared memory region off heap between workers on a node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/SharedOffHeapWithinWorker.html" title="class in org.apache.storm.topology">SharedOffHeapWithinWorker</a></td>
<td class="colLast">
<div class="block">A request for a shared memory region off heap, but only within a worker.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/SharedOnHeap.html" title="class in org.apache.storm.topology">SharedOnHeap</a></td>
<td class="colLast">
<div class="block">A request for a shared memory region on heap.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/StatefulBoltExecutor.html" title="class in org.apache.storm.topology">StatefulBoltExecutor</a>&lt;T extends <a href="../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</td>
<td class="colLast">
<div class="block">Wraps a <a href="../../../../org/apache/storm/topology/IStatefulBolt.html" title="interface in org.apache.storm.topology"><code>IStatefulBolt</code></a> and manages the state of the bolt.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/StatefulWindowedBoltExecutor.html" title="class in org.apache.storm.topology">StatefulWindowedBoltExecutor</a>&lt;T extends <a href="../../../../org/apache/storm/state/State.html" title="interface in org.apache.storm.state">State</a>&gt;</td>
<td class="colLast">
<div class="block">Wraps a <a href="../../../../org/apache/storm/topology/IStatefulWindowedBolt.html" title="interface in org.apache.storm.topology"><code>IStatefulWindowedBolt</code></a> and handles the execution.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/TopologyBuilder.html" title="class in org.apache.storm.topology">TopologyBuilder</a></td>
<td class="colLast">
<div class="block">TopologyBuilder exposes the Java API for specifying a topology for Storm to execute.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/TupleFieldTimestampExtractor.html" title="class in org.apache.storm.topology">TupleFieldTimestampExtractor</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/storm/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>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/WindowedBoltExecutor.html" title="class in org.apache.storm.topology">WindowedBoltExecutor</a></td>
<td class="colLast">
<div class="block">An <a href="../../../../org/apache/storm/topology/IWindowedBolt.html" title="interface in org.apache.storm.topology"><code>IWindowedBolt</code></a> wrapper that does the windowing of tuples.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/FailedException.html" title="class in org.apache.storm.topology">FailedException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/storm/topology/ReportedFailedException.html" title="class in org.apache.storm.topology">ReportedFailedException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">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">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/testing/staticmocking/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/storm/topology/base/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/topology/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>