Google Git
Sign in
apache / storm-site / 553ca57e4e37c342861887cd8dd404f44d39b4f9 / . / content / releases / 2.4.0 / javadocs / org / apache / storm / package-summary.html
blob: a0a33c2dd8e14211b4d8e64297410e7638136e18 [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 (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 (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/calcite/interpreter/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../org/apache/storm/annotation/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/storm/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</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/ICredentialsListener.html" title="interface in org.apache.storm">ICredentialsListener</a></td>
<td class="colLast">
<div class="block">Allows a bolt or a spout to be informed when the credentials of the topology have changed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></td>
<td class="colLast">
<div class="block">This is here mostly for backwards compatibility.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/storm/ILocalCluster.ILocalTopology.html" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></td>
<td class="colLast">
<div class="block">Close this class to kill the topology.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/ILocalClusterTrackedTopologyAware.html" title="interface in org.apache.storm">ILocalClusterTrackedTopologyAware</a></td>
<td class="colLast">
<div class="block">This is here mostly for backwards compatibility.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/storm/ILocalDRPC.html" title="interface in org.apache.storm">ILocalDRPC</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/ISubmitterHook.html" title="interface in org.apache.storm">ISubmitterHook</a></td>
<td class="colLast">
<div class="block">if FQCN of an implementation of this class is specified by setting the config storm.topology.submission.notifier.plugin.class, that class&rsquo;s notify method will be invoked when a topology is successfully submitted via StormSubmitter class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/storm/StormSubmitter.ProgressListener.html" title="interface in org.apache.storm">StormSubmitter.ProgressListener</a></td>
<td class="colLast">
<div class="block">Interface use to track progress of file upload.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/Testing.Condition.html" title="interface in org.apache.storm">Testing.Condition</a></td>
<td class="colLast">
<div class="block">Simply produces a boolean to see if a specific state is true or false.</div>
</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/Config.html" title="class in org.apache.storm">Config</a></td>
<td class="colLast">
<div class="block">Topology configs are specified as a plain old map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/Constants.html" title="class in org.apache.storm">Constants</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/storm/DaemonConfig.html" title="class in org.apache.storm">DaemonConfig</a></td>
<td class="colLast">
<div class="block">Storm configs are specified as a plain old map.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/ExclamationTopology.html" title="class in org.apache.storm">ExclamationTopology</a></td>
<td class="colLast">
<div class="block">This is a basic example of a Storm topology.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/storm/ExclamationTopology.ExclamationBolt.html" title="class in org.apache.storm">ExclamationTopology.ExclamationBolt</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/ExclamationTopology.FixedOrderWordSpout.html" title="class in org.apache.storm">ExclamationTopology.FixedOrderWordSpout</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/storm/LocalCluster.html" title="class in org.apache.storm">LocalCluster</a></td>
<td class="colLast">
<div class="block">A stand alone storm cluster that runs inside a single process.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></td>
<td class="colLast">
<div class="block">Simple way to configure a LocalCluster to meet your needs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/LocalDRPC.html" title="class in org.apache.storm">LocalDRPC</a></td>
<td class="colLast">
<div class="block">A Local way to test DRPC.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/storm/LogWriter.html" title="class in org.apache.storm">LogWriter</a></td>
<td class="colLast">
<div class="block">Launch a sub process and write files out to logs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/ProcessSimulator.html" title="class in org.apache.storm">ProcessSimulator</a></td>
<td class="colLast">
<div class="block">In local mode, <code>ProcessSimulator</code> keeps track of Shutdownable objects in place of actual processes (in cluster mode).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/storm/ServerConstants.html" title="class in org.apache.storm">ServerConstants</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/StormSubmitter.html" title="class in org.apache.storm">StormSubmitter</a></td>
<td class="colLast">
<div class="block">Use this class to submit topologies to run on the Storm cluster.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/storm/StormTimer.html" title="class in org.apache.storm">StormTimer</a></td>
<td class="colLast">
<div class="block">The timer defined in this file is very similar to java.util.Timer, except it integrates with Storm&rsquo;s time simulation capabilities.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/StormTimer.QueueEntry.html" title="class in org.apache.storm">StormTimer.QueueEntry</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/storm/StormTimer.StormTimerTask.html" title="class in org.apache.storm">StormTimer.StormTimerTask</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/Testing.html" title="class in org.apache.storm">Testing</a></td>
<td class="colLast">
<div class="block">A utility that helps with testing topologies, Bolts and Spouts.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/storm/Testing.CapturedTopology.html" title="class in org.apache.storm">Testing.CapturedTopology</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A topology that has all messages captured and can be read later on.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/Thrift.html" title="class in org.apache.storm">Thrift</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/storm/Thrift.BoltDetails.html" title="class in org.apache.storm">Thrift.BoltDetails</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/storm/Thrift.SpoutDetails.html" title="class in org.apache.storm">Thrift.SpoutDetails</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/calcite/interpreter/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../org/apache/storm/annotation/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/storm/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>