blob: 14cec310378af8189a613f990fa823042d8e2be0 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>LocalCluster.LocalTopology (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, class: LocalCluster, class: LocalTopology">
<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/LocalCluster.LocalTopology.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><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&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><a href="#constructor-detail">Constr</a>&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="Class LocalCluster.LocalTopology" class="title">Class LocalCluster.LocalTopology</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a>
<div class="inheritance"><a href="generated/StormTopology.html" title="class in org.apache.storm.generated">org.apache.storm.generated.StormTopology</a>
<div class="inheritance">org.apache.storm.LocalCluster.LocalTopology</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <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="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;<a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>&gt;</code>, <code><a href="ILocalCluster.ILocalTopology.html" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></code>, <code>org.apache.storm.thrift.TBase&lt;<a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>,<wbr><a href="generated/StormTopology._Fields.html" title="enum in org.apache.storm.generated">StormTopology._Fields</a>&gt;</code>, <code>org.apache.storm.thrift.TSerializable</code></dd>
</dl>
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="LocalCluster.html" title="class in org.apache.storm">LocalCluster</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">LocalCluster.LocalTopology</span>
<span class="extends-implements">extends <a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>
implements <a href="ILocalCluster.ILocalTopology.html" title="interface in org.apache.storm">ILocalCluster.ILocalTopology</a></span></div>
<div class="block">When running a topology locally, for tests etc. It is helpful to be sure that the topology is dead before the test exits. This is
an AutoCloseable topology that not only gives you access to the compiled StormTopology but also will kill the topology when it
closes.
<code>
try (LocalTopology testTopo = cluster.submitTopology("testing", ...)) {
// Run Some test
} // The topology has been killed
</code></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../serialized-form.html#org.apache.storm.LocalCluster.LocalTopology">Serialized Form</a></li>
</ul>
</dd>
</dl>
</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.generated.StormTopology">Nested classes/interfaces inherited from class&nbsp;org.apache.storm.generated.<a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a></h2>
<code><a href="generated/StormTopology._Fields.html" title="enum in org.apache.storm.generated">StormTopology._Fields</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.storm.generated.StormTopology">Fields inherited from class&nbsp;org.apache.storm.generated.<a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a></h3>
<code><a href="generated/StormTopology.html#metaDataMap">metaDataMap</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,org.apache.storm.generated.StormTopology)" class="member-name-link">LocalTopology</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;topoName,
<a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>&nbsp;topo)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.storm.generated.StormTopology">Methods inherited from class&nbsp;org.apache.storm.generated.<a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a></h3>
<code><a href="generated/StormTopology.html#add_to_dependency_artifacts(java.lang.String)">add_to_dependency_artifacts</a>, <a href="generated/StormTopology.html#add_to_dependency_jars(java.lang.String)">add_to_dependency_jars</a>, <a href="generated/StormTopology.html#add_to_worker_hooks(java.nio.ByteBuffer)">add_to_worker_hooks</a>, <a href="generated/StormTopology.html#clear()">clear</a>, <a href="generated/StormTopology.html#compareTo(org.apache.storm.generated.StormTopology)">compareTo</a>, <a href="generated/StormTopology.html#deepCopy()">deepCopy</a>, <a href="generated/StormTopology.html#equals(java.lang.Object)">equals</a>, <a href="generated/StormTopology.html#equals(org.apache.storm.generated.StormTopology)">equals</a>, <a href="generated/StormTopology.html#fieldForId(int)">fieldForId</a>, <a href="generated/StormTopology.html#get_bolts()">get_bolts</a>, <a href="generated/StormTopology.html#get_bolts_size()">get_bolts_size</a>, <a href="generated/StormTopology.html#get_component_to_shared_memory()">get_component_to_shared_memory</a>, <a href="generated/StormTopology.html#get_component_to_shared_memory_size()">get_component_to_shared_memory_size</a>, <a href="generated/StormTopology.html#get_dependency_artifacts()">get_dependency_artifacts</a>, <a href="generated/StormTopology.html#get_dependency_artifacts_iterator()">get_dependency_artifacts_iterator</a>, <a href="generated/StormTopology.html#get_dependency_artifacts_size()">get_dependency_artifacts_size</a>, <a href="generated/StormTopology.html#get_dependency_jars()">get_dependency_jars</a>, <a href="generated/StormTopology.html#get_dependency_jars_iterator()">get_dependency_jars_iterator</a>, <a href="generated/StormTopology.html#get_dependency_jars_size()">get_dependency_jars_size</a>, <a href="generated/StormTopology.html#get_jdk_version()">get_jdk_version</a>, <a href="generated/StormTopology.html#get_shared_memory()">get_shared_memory</a>, <a href="generated/StormTopology.html#get_shared_memory_size()">get_shared_memory_size</a>, <a href="generated/StormTopology.html#get_spouts()">get_spouts</a>, <a href="generated/StormTopology.html#get_spouts_size()">get_spouts_size</a>, <a href="generated/StormTopology.html#get_state_spouts()">get_state_spouts</a>, <a href="generated/StormTopology.html#get_state_spouts_size()">get_state_spouts_size</a>, <a href="generated/StormTopology.html#get_storm_version()">get_storm_version</a>, <a href="generated/StormTopology.html#get_worker_hooks()">get_worker_hooks</a>, <a href="generated/StormTopology.html#get_worker_hooks_iterator()">get_worker_hooks_iterator</a>, <a href="generated/StormTopology.html#get_worker_hooks_size()">get_worker_hooks_size</a>, <a href="generated/StormTopology.html#getFieldValue(org.apache.storm.generated.StormTopology._Fields)">getFieldValue</a>, <a href="generated/StormTopology.html#hashCode()">hashCode</a>, <a href="generated/StormTopology.html#is_set_bolts()">is_set_bolts</a>, <a href="generated/StormTopology.html#is_set_component_to_shared_memory()">is_set_component_to_shared_memory</a>, <a href="generated/StormTopology.html#is_set_dependency_artifacts()">is_set_dependency_artifacts</a>, <a href="generated/StormTopology.html#is_set_dependency_jars()">is_set_dependency_jars</a>, <a href="generated/StormTopology.html#is_set_jdk_version()">is_set_jdk_version</a>, <a href="generated/StormTopology.html#is_set_shared_memory()">is_set_shared_memory</a>, <a href="generated/StormTopology.html#is_set_spouts()">is_set_spouts</a>, <a href="generated/StormTopology.html#is_set_state_spouts()">is_set_state_spouts</a>, <a href="generated/StormTopology.html#is_set_storm_version()">is_set_storm_version</a>, <a href="generated/StormTopology.html#is_set_worker_hooks()">is_set_worker_hooks</a>, <a href="generated/StormTopology.html#isSet(org.apache.storm.generated.StormTopology._Fields)">isSet</a>, <a href="generated/StormTopology.html#put_to_bolts(java.lang.String,org.apache.storm.generated.Bolt)">put_to_bolts</a>, <a href="generated/StormTopology.html#put_to_component_to_shared_memory(java.lang.String,java.util.Set)">put_to_component_to_shared_memory</a>, <a href="generated/StormTopology.html#put_to_shared_memory(java.lang.String,org.apache.storm.generated.SharedMemory)">put_to_shared_memory</a>, <a href="generated/StormTopology.html#put_to_spouts(java.lang.String,org.apache.storm.generated.SpoutSpec)">put_to_spouts</a>, <a href="generated/StormTopology.html#put_to_state_spouts(java.lang.String,org.apache.storm.generated.StateSpoutSpec)">put_to_state_spouts</a>, <a href="generated/StormTopology.html#read(org.apache.storm.thrift.protocol.TProtocol)">read</a>, <a href="generated/StormTopology.html#set_bolts(java.util.Map)">set_bolts</a>, <a href="generated/StormTopology.html#set_bolts_isSet(boolean)">set_bolts_isSet</a>, <a href="generated/StormTopology.html#set_component_to_shared_memory(java.util.Map)">set_component_to_shared_memory</a>, <a href="generated/StormTopology.html#set_component_to_shared_memory_isSet(boolean)">set_component_to_shared_memory_isSet</a>, <a href="generated/StormTopology.html#set_dependency_artifacts(java.util.List)">set_dependency_artifacts</a>, <a href="generated/StormTopology.html#set_dependency_artifacts_isSet(boolean)">set_dependency_artifacts_isSet</a>, <a href="generated/StormTopology.html#set_dependency_jars(java.util.List)">set_dependency_jars</a>, <a href="generated/StormTopology.html#set_dependency_jars_isSet(boolean)">set_dependency_jars_isSet</a>, <a href="generated/StormTopology.html#set_jdk_version(java.lang.String)">set_jdk_version</a>, <a href="generated/StormTopology.html#set_jdk_version_isSet(boolean)">set_jdk_version_isSet</a>, <a href="generated/StormTopology.html#set_shared_memory(java.util.Map)">set_shared_memory</a>, <a href="generated/StormTopology.html#set_shared_memory_isSet(boolean)">set_shared_memory_isSet</a>, <a href="generated/StormTopology.html#set_spouts(java.util.Map)">set_spouts</a>, <a href="generated/StormTopology.html#set_spouts_isSet(boolean)">set_spouts_isSet</a>, <a href="generated/StormTopology.html#set_state_spouts(java.util.Map)">set_state_spouts</a>, <a href="generated/StormTopology.html#set_state_spouts_isSet(boolean)">set_state_spouts_isSet</a>, <a href="generated/StormTopology.html#set_storm_version(java.lang.String)">set_storm_version</a>, <a href="generated/StormTopology.html#set_storm_version_isSet(boolean)">set_storm_version_isSet</a>, <a href="generated/StormTopology.html#set_worker_hooks(java.util.List)">set_worker_hooks</a>, <a href="generated/StormTopology.html#set_worker_hooks_isSet(boolean)">set_worker_hooks_isSet</a>, <a href="generated/StormTopology.html#setFieldValue(org.apache.storm.generated.StormTopology._Fields,java.lang.Object)">setFieldValue</a>, <a href="generated/StormTopology.html#toString()">toString</a>, <a href="generated/StormTopology.html#unset_bolts()">unset_bolts</a>, <a href="generated/StormTopology.html#unset_component_to_shared_memory()">unset_component_to_shared_memory</a>, <a href="generated/StormTopology.html#unset_dependency_artifacts()">unset_dependency_artifacts</a>, <a href="generated/StormTopology.html#unset_dependency_jars()">unset_dependency_jars</a>, <a href="generated/StormTopology.html#unset_jdk_version()">unset_jdk_version</a>, <a href="generated/StormTopology.html#unset_shared_memory()">unset_shared_memory</a>, <a href="generated/StormTopology.html#unset_spouts()">unset_spouts</a>, <a href="generated/StormTopology.html#unset_state_spouts()">unset_state_spouts</a>, <a href="generated/StormTopology.html#unset_storm_version()">unset_storm_version</a>, <a href="generated/StormTopology.html#unset_worker_hooks()">unset_worker_hooks</a>, <a href="generated/StormTopology.html#validate()">validate</a>, <a href="generated/StormTopology.html#write(org.apache.storm.thrift.protocol.TProtocol)">write</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<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></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String,org.apache.storm.generated.StormTopology)">
<h3>LocalTopology</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">LocalTopology</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;topoName,
<a href="generated/StormTopology.html" title="class in org.apache.storm.generated">StormTopology</a>&nbsp;topo)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="close()">
<h3>close</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">close</span>()
throws <span class="exceptions">org.apache.storm.thrift.TException</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><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>&nbsp;in interface&nbsp;<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></dd>
<dt>Throws:</dt>
<dd><code>org.apache.storm.thrift.TException</code></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>