blob: 92b43bb0455f5b34cd12251598d3d0100fc887da [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>ILocalClusterTrackedTopologyAware (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, interface: ILocalClusterTrackedTopologyAware">
<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/ILocalClusterTrackedTopologyAware.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:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.storm</a></div>
<h1 title="Interface ILocalClusterTrackedTopologyAware" class="title">Interface ILocalClusterTrackedTopologyAware</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="LocalCluster.html" title="class in org.apache.storm">LocalCluster</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ILocalClusterTrackedTopologyAware</span><span class="extends-implements">
extends <a href="ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></span></div>
<div class="block">This is here mostly for backwards compatibility. Please see <a href="LocalCluster.html" title="class in org.apache.storm"><code>LocalCluster</code></a> for more details on testing a Storm
Topology.</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="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.storm.ILocalCluster">Nested classes/interfaces inherited from interface&nbsp;org.apache.storm.<a href="ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></h2>
<code><a href="ILocalCluster.ILocalTopology.html" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></code></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="ILocalCluster.ILocalTopology.html" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#submitTopology(java.lang.String,java.util.Map,org.apache.storm.testing.TrackedTopology)" class="member-name-link">submitTopology</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>&nbsp;topologyName,
<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;conf,
<a href="testing/TrackedTopology.html" title="class in org.apache.storm.testing">TrackedTopology</a>&nbsp;topology)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Submit a tracked topology to be run in local mode.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ILocalCluster.ILocalTopology.html" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#submitTopologyWithOpts(java.lang.String,java.util.Map,org.apache.storm.testing.TrackedTopology,org.apache.storm.generated.SubmitOptions)" class="member-name-link">submitTopologyWithOpts</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>&nbsp;topologyName,
<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;conf,
<a href="testing/TrackedTopology.html" title="class in org.apache.storm.testing">TrackedTopology</a>&nbsp;topology,
<a href="generated/SubmitOptions.html" title="class in org.apache.storm.generated">SubmitOptions</a>&nbsp;submitOpts)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Submit a tracked topology to be run in local mode.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.AutoCloseable">Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.storm.ILocalCluster">Methods inherited from interface&nbsp;org.apache.storm.<a href="ILocalCluster.html" title="interface in org.apache.storm">ILocalCluster</a></h3>
<code><a href="ILocalCluster.html#activate(java.lang.String)">activate</a>, <a href="ILocalCluster.html#advanceClusterTime(int)">advanceClusterTime</a>, <a href="ILocalCluster.html#advanceClusterTime(int,int)">advanceClusterTime</a>, <a href="ILocalCluster.html#deactivate(java.lang.String)">deactivate</a>, <a href="ILocalCluster.html#getClusterInfo()">getClusterInfo</a>, <a href="ILocalCluster.html#getClusterState()">getClusterState</a>, <a href="ILocalCluster.html#getTopology(java.lang.String)">getTopology</a>, <a href="ILocalCluster.html#getTopologyConf(java.lang.String)">getTopologyConf</a>, <a href="ILocalCluster.html#getTopologyInfo(java.lang.String)">getTopologyInfo</a>, <a href="ILocalCluster.html#getTopologyInfoByName(java.lang.String)">getTopologyInfoByName</a>, <a href="ILocalCluster.html#getTopologyInfoByNameWithOpts(java.lang.String,org.apache.storm.generated.GetInfoOptions)">getTopologyInfoByNameWithOpts</a>, <a href="ILocalCluster.html#getTopologyInfoWithOpts(java.lang.String,org.apache.storm.generated.GetInfoOptions)">getTopologyInfoWithOpts</a>, <a href="ILocalCluster.html#getTopologySummaries()">getTopologySummaries</a>, <a href="ILocalCluster.html#getTopologySummary(java.lang.String)">getTopologySummary</a>, <a href="ILocalCluster.html#getTopologySummaryByName(java.lang.String)">getTopologySummaryByName</a>, <a href="ILocalCluster.html#getTrackedId()">getTrackedId</a>, <a href="ILocalCluster.html#killTopology(java.lang.String)">killTopology</a>, <a href="ILocalCluster.html#killTopologyWithOpts(java.lang.String,org.apache.storm.generated.KillOptions)">killTopologyWithOpts</a>, <a href="ILocalCluster.html#rebalance(java.lang.String,org.apache.storm.generated.RebalanceOptions)">rebalance</a>, <a href="ILocalCluster.html#shutdown()">shutdown</a>, <a href="ILocalCluster.html#submitTopology(java.lang.String,java.util.Map,org.apache.storm.generated.StormTopology)">submitTopology</a>, <a href="ILocalCluster.html#submitTopologyWithOpts(java.lang.String,java.util.Map,org.apache.storm.generated.StormTopology,org.apache.storm.generated.SubmitOptions)">submitTopologyWithOpts</a>, <a href="ILocalCluster.html#uploadNewCredentials(java.lang.String,org.apache.storm.generated.Credentials)">uploadNewCredentials</a></code></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="submitTopology(java.lang.String,java.util.Map,org.apache.storm.testing.TrackedTopology)">
<h3>submitTopology</h3>
<div class="member-signature"><span class="return-type"><a href="ILocalCluster.ILocalTopology.html" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></span>&nbsp;<span class="element-name">submitTopology</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>&nbsp;topologyName,
<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;conf,
<a href="testing/TrackedTopology.html" title="class in org.apache.storm.testing">TrackedTopology</a>&nbsp;topology)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Submit a tracked topology to be run in local mode.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>topologyName</code> - the name of the topology to use</dd>
<dd><code>conf</code> - the config for the topology</dd>
<dd><code>topology</code> - the topology itself.</dd>
<dt>Returns:</dt>
<dd>an AutoCloseable that will kill the topology.</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="submitTopologyWithOpts(java.lang.String,java.util.Map,org.apache.storm.testing.TrackedTopology,org.apache.storm.generated.SubmitOptions)">
<h3>submitTopologyWithOpts</h3>
<div class="member-signature"><span class="return-type"><a href="ILocalCluster.ILocalTopology.html" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></span>&nbsp;<span class="element-name">submitTopologyWithOpts</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>&nbsp;topologyName,
<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;conf,
<a href="testing/TrackedTopology.html" title="class in org.apache.storm.testing">TrackedTopology</a>&nbsp;topology,
<a href="generated/SubmitOptions.html" title="class in org.apache.storm.generated">SubmitOptions</a>&nbsp;submitOpts)</span>
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<div class="block">Submit a tracked topology to be run in local mode.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>topologyName</code> - the name of the topology to use</dd>
<dd><code>conf</code> - the config for the topology</dd>
<dd><code>topology</code> - the topology itself.</dd>
<dd><code>submitOpts</code> - options for topology</dd>
<dt>Returns:</dt>
<dd>an AutoCloseable that will kill the topology.</dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code> - on any error from nimbus</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</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>