blob: 2627d796ae6f2afdb82a8d848ed92315ddf1058f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Interface org.apache.storm.ILocalCluster (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="use: package: org.apache.storm, interface: ILocalCluster">
<meta name="generator" content="javadoc/ClassUseWriter">
<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-use-page">
<script type="text/javascript">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><a href="../ILocalCluster.html" title="interface in org.apache.storm">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<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="Uses of Interface org.apache.storm.ILocalCluster" class="title">Uses of Interface<br>org.apache.storm.ILocalCluster</h1>
</div>
<div class="caption"><span>Packages that use <a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></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="#org.apache.storm">org.apache.storm</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.storm.testing">org.apache.storm.testing</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.storm">
<h2>Uses of <a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a> in <a href="../package-summary.html">org.apache.storm</a></h2>
<div class="caption"><span>Subinterfaces of <a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a> in <a href="../package-summary.html">org.apache.storm</a></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>interface&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../ILocalClusterTrackedTopologyAware.html" class="type-name-link" title="interface in org.apache.storm">ILocalClusterTrackedTopologyAware</a></code></div>
<div class="col-last even-row-color">
<div class="block">This is here mostly for backwards compatibility.</div>
</div>
</div>
<div class="caption"><span>Classes in <a href="../package-summary.html">org.apache.storm</a> that implement <a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></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">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../LocalCluster.html" class="type-name-link" title="class in org.apache.storm">LocalCluster</a></code></div>
<div class="col-last even-row-color">
<div class="block">A stand alone storm cluster that runs inside a single process.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.storm</a> that return <a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static <a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Testing.</span><code><a href="../Testing.html#getLocalCluster(java.util.Map)" class="member-name-link">getLocalCluster</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>&lt;<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>&gt;&nbsp;clusterConf)</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use ```
try (LocalCluster cluster = new LocalCluster.Builder()....build()) {
...
}
```</div>
</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.storm</a> with parameters of type <a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">Testing.</span><code><a href="../Testing.html#advanceClusterTime(org.apache.storm.ILocalCluster,java.lang.Integer)" class="member-name-link">advanceClusterTime</a><wbr>(<a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a>&nbsp;cluster,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&nbsp;secs)</code></div>
<div class="col-last even-row-color">
<div class="block">Simulated time wait for a cluster.</div>
</div>
<div class="col-first odd-row-color"><code>static void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Testing.</span><code><a href="../Testing.html#advanceClusterTime(org.apache.storm.ILocalCluster,java.lang.Integer,java.lang.Integer)" class="member-name-link">advanceClusterTime</a><wbr>(<a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a>&nbsp;cluster,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&nbsp;secs,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&nbsp;step)</code></div>
<div class="col-last odd-row-color">
<div class="block">Simulated time wait for a cluster.</div>
</div>
<div class="col-first even-row-color"><code>static <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>&lt;<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/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../testing/FixedTuple.html" title="class in org.apache.storm.testing">FixedTuple</a>&gt;&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">Testing.</span><code><a href="../Testing.html#completeTopology(org.apache.storm.ILocalCluster,org.apache.storm.generated.StormTopology)" class="member-name-link">completeTopology</a><wbr>(<a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a>&nbsp;cluster,
<a href="../generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>&nbsp;topology)</code></div>
<div class="col-last even-row-color">
<div class="block">Run a topology to completion capturing all of the messages that are emitted.</div>
</div>
<div class="col-first odd-row-color"><code>static <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>&lt;<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/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../testing/FixedTuple.html" title="class in org.apache.storm.testing">FixedTuple</a>&gt;&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Testing.</span><code><a href="../Testing.html#completeTopology(org.apache.storm.ILocalCluster,org.apache.storm.generated.StormTopology,org.apache.storm.testing.CompleteTopologyParam)" class="member-name-link">completeTopology</a><wbr>(<a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a>&nbsp;cluster,
<a href="../generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>&nbsp;topology,
<a href="../testing/CompleteTopologyParam.html" title="class in org.apache.storm.testing">CompleteTopologyParam</a>&nbsp;param)</code></div>
<div class="col-last odd-row-color">
<div class="block">Run a topology to completion capturing all of the messages that are emitted.</div>
</div>
<div class="col-first even-row-color"><code>static <a href="../testing/TrackedTopology.html" title="class in org.apache.storm.testing">TrackedTopology</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Testing.</span><code><a href="../Testing.html#mkTrackedTopology(org.apache.storm.ILocalCluster,org.apache.storm.generated.StormTopology)" class="member-name-link">mkTrackedTopology</a><wbr>(<a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a>&nbsp;cluster,
<a href="../generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>&nbsp;topology)</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">use <a href="../testing/TrackedTopology.html" title="class in org.apache.storm.testing"><code>TrackedTopology</code></a> directly.</div>
</div>
</div>
<div class="col-first odd-row-color"><code>static void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Testing.</span><code><a href="../Testing.html#simulateWait(org.apache.storm.ILocalCluster)" class="member-name-link">simulateWait</a><wbr>(<a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a>&nbsp;cluster)</code></div>
<div class="col-last odd-row-color">
<div class="block">If using simulated time simulate waiting for 10 seconds.</div>
</div>
<div class="col-first even-row-color"><code>static <a href="../Testing.CapturedTopology.html" title="class in org.apache.storm">Testing.CapturedTopology</a>&lt;<a href="../testing/TrackedTopology.html" title="class in org.apache.storm.testing">TrackedTopology</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">Testing.</span><code><a href="../Testing.html#trackAndCaptureTopology(org.apache.storm.ILocalCluster,org.apache.storm.generated.StormTopology)" class="member-name-link">trackAndCaptureTopology</a><wbr>(<a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a>&nbsp;cluster,
<a href="../generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>&nbsp;topology)</code></div>
<div class="col-last even-row-color">
<div class="block">Track and capture a topology.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.storm.testing">
<h2>Uses of <a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a> in <a href="../testing/package-summary.html">org.apache.storm.testing</a></h2>
<div class="caption"><span>Methods in <a href="../testing/package-summary.html">org.apache.storm.testing</a> that return <a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">TrackedTopology.</span><code><a href="../testing/TrackedTopology.html#getCluster()" class="member-name-link">getCluster</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../testing/package-summary.html">org.apache.storm.testing</a> with parameters of type <a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">TestJob.</span><code><a href="../testing/TestJob.html#run(org.apache.storm.ILocalCluster)" class="member-name-link">run</a><wbr>(<a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a>&nbsp;cluster)</code></div>
<div class="col-last even-row-color">
<div class="block">run the testing logic with the cluster.</div>
</div>
</div>
<div class="caption"><span>Constructors in <a href="../testing/package-summary.html">org.apache.storm.testing</a> with parameters of type <a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../testing/TrackedTopology.html#%3Cinit%3E(org.apache.storm.generated.StormTopology,org.apache.storm.ILocalCluster)" class="member-name-link">TrackedTopology</a><wbr>(<a href="../generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>&nbsp;origTopo,
<a href="../ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a>&nbsp;cluster)</code></div>
<div class="col-last even-row-color">
<div class="block">Create a new topology to be tracked.</div>
</div>
</div>
</section>
</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>