blob: 98033bd651d16e5099c284bd522e7c6680194026 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) -->
<title>LocalCluster.Builder (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: Builder">
<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.Builder.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>Nested&nbsp;|&nbsp;</li>
<li>Field&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.Builder" class="title">Class LocalCluster.Builder</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">org.apache.storm.LocalCluster.Builder</div>
</div>
<section class="class-description" id="class-description">
<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 static class </span><span class="element-name type-name-label">LocalCluster.Builder</span>
<span class="extends-implements">extends <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></span></div>
<div class="block">Simple way to configure a LocalCluster to meet your needs.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== 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()" class="member-name-link">Builder</a>()</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><a href="LocalCluster.html" title="class in org.apache.storm">LocalCluster</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Builds a new LocalCluster.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withBlobStore(org.apache.storm.blobstore.BlobStore)" class="member-name-link">withBlobStore</a><wbr>(<a href="blobstore/BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a>&nbsp;store)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Use the following blobstore instead of the one in the config.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withClusterState(org.apache.storm.cluster.IStormClusterState)" class="member-name-link">withClusterState</a><wbr>(<a href="cluster/IStormClusterState.html" title="interface in org.apache.storm.cluster">IStormClusterState</a>&nbsp;clusterState)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Use the following clusterState instead of the one in the config.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withDaemonConf(java.lang.String,java.lang.Object)" class="member-name-link">withDaemonConf</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;key,
<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>&nbsp;value)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Add an single key/value config to the daemon conf.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withDaemonConf(java.util.Map)" class="member-name-link">withDaemonConf</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;conf)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the base config that the daemons should use.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withGroupMapper(org.apache.storm.security.auth.IGroupMappingServiceProvider)" class="member-name-link">withGroupMapper</a><wbr>(<a href="security/auth/IGroupMappingServiceProvider.html" title="interface in org.apache.storm.security.auth">IGroupMappingServiceProvider</a>&nbsp;groupMapper)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Override the code that maps users to groups for authorization.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withINimbus(org.apache.storm.scheduler.INimbus)" class="member-name-link">withINimbus</a><wbr>(<a href="scheduler/INimbus.html" title="interface in org.apache.storm.scheduler">INimbus</a>&nbsp;inimbus)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Override the INimbus instance that nimbus will use.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withLeaderElector(org.apache.storm.nimbus.ILeaderElector)" class="member-name-link">withLeaderElector</a><wbr>(<a href="nimbus/ILeaderElector.html" title="interface in org.apache.storm.nimbus">ILeaderElector</a>&nbsp;leaderElector)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Use the following leaderElector instead of the one in the config.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withNimbusDaemon()" class="member-name-link">withNimbusDaemon</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Have the local nimbus actually launch a thrift server.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withNimbusDaemon(java.lang.Boolean)" class="member-name-link">withNimbusDaemon</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&nbsp;nimbusDaemon)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">If nimbusDaemon is true the local nimbus will launch a thrift server.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withNimbusWrapper(java.util.function.UnaryOperator)" class="member-name-link">withNimbusWrapper</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/UnaryOperator.html" title="class or interface in java.util.function" class="external-link">UnaryOperator</a>&lt;<a href="daemon/nimbus/Nimbus.html" title="class in org.apache.storm.daemon.nimbus">Nimbus</a>&gt;&nbsp;nimbusWrapper)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Before nimbus is created/used call nimbusWrapper on it first and use the result instead.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withPortsPerSupervisor(int)" class="member-name-link">withPortsPerSupervisor</a><wbr>(int&nbsp;portsPerSupervisor)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the number of slots/ports each supervisor should have.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withSimulatedTime()" class="member-name-link">withSimulatedTime</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Turn on simulated time in the cluster.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withSimulatedTime(boolean)" class="member-name-link">withSimulatedTime</a><wbr>(boolean&nbsp;simulateTime)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Turn on simulated time in the cluster.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withSupervisors(int)" class="member-name-link">withSupervisors</a><wbr>(int&nbsp;supervisors)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the number of supervisors the cluster should have.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withSupervisorSlotPortMin(java.lang.Number)" class="member-name-link">withSupervisorSlotPortMin</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>&nbsp;minPort)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">When assigning ports to worker slots start at minPort.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTopoCache(org.apache.storm.daemon.nimbus.TopoCache)" class="member-name-link">withTopoCache</a><wbr>(<a href="daemon/nimbus/TopoCache.html" title="class in org.apache.storm.daemon.nimbus">TopoCache</a>&nbsp;topoCache)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Use the following topo cache instead of creating out own.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTracked()" class="member-name-link">withTracked</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">A tracked cluster can run tracked topologies.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withTracked(java.lang.String)" class="member-name-link">withTracked</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;trackId)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">A tracked cluster can run tracked topologies.</div>
</div>
</div>
</div>
</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#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</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#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</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#toString()" title="class or interface in java.lang" class="external-link">toString</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;()">
<h3>Builder</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Builder</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="withSupervisors(int)">
<h3>withSupervisors</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withSupervisors</span><wbr><span class="parameters">(int&nbsp;supervisors)</span></div>
<div class="block">Set the number of supervisors the cluster should have.</div>
</section>
</li>
<li>
<section class="detail" id="withPortsPerSupervisor(int)">
<h3>withPortsPerSupervisor</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withPortsPerSupervisor</span><wbr><span class="parameters">(int&nbsp;portsPerSupervisor)</span></div>
<div class="block">Set the number of slots/ports each supervisor should have.</div>
</section>
</li>
<li>
<section class="detail" id="withDaemonConf(java.util.Map)">
<h3>withDaemonConf</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withDaemonConf</span><wbr><span class="parameters">(<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)</span></div>
<div class="block">Set the base config that the daemons should use.</div>
</section>
</li>
<li>
<section class="detail" id="withDaemonConf(java.lang.String,java.lang.Object)">
<h3>withDaemonConf</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withDaemonConf</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;key,
<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>&nbsp;value)</span></div>
<div class="block">Add an single key/value config to the daemon conf.</div>
</section>
</li>
<li>
<section class="detail" id="withINimbus(org.apache.storm.scheduler.INimbus)">
<h3>withINimbus</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withINimbus</span><wbr><span class="parameters">(<a href="scheduler/INimbus.html" title="interface in org.apache.storm.scheduler">INimbus</a>&nbsp;inimbus)</span></div>
<div class="block">Override the INimbus instance that nimbus will use.</div>
</section>
</li>
<li>
<section class="detail" id="withGroupMapper(org.apache.storm.security.auth.IGroupMappingServiceProvider)">
<h3>withGroupMapper</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withGroupMapper</span><wbr><span class="parameters">(<a href="security/auth/IGroupMappingServiceProvider.html" title="interface in org.apache.storm.security.auth">IGroupMappingServiceProvider</a>&nbsp;groupMapper)</span></div>
<div class="block">Override the code that maps users to groups for authorization.</div>
</section>
</li>
<li>
<section class="detail" id="withSupervisorSlotPortMin(java.lang.Number)">
<h3>withSupervisorSlotPortMin</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withSupervisorSlotPortMin</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a>&nbsp;minPort)</span></div>
<div class="block">When assigning ports to worker slots start at minPort.</div>
</section>
</li>
<li>
<section class="detail" id="withNimbusDaemon()">
<h3>withNimbusDaemon</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withNimbusDaemon</span>()</div>
<div class="block">Have the local nimbus actually launch a thrift server. This is intended to be used mostly for internal storm testing.</div>
</section>
</li>
<li>
<section class="detail" id="withNimbusDaemon(java.lang.Boolean)">
<h3>withNimbusDaemon</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withNimbusDaemon</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&nbsp;nimbusDaemon)</span></div>
<div class="block">If nimbusDaemon is true the local nimbus will launch a thrift server. This is intended to be used mostly for internal storm
testing.</div>
</section>
</li>
<li>
<section class="detail" id="withSimulatedTime()">
<h3>withSimulatedTime</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withSimulatedTime</span>()</div>
<div class="block">Turn on simulated time in the cluster. This allows someone to simulate long periods of time for timeouts etc when testing
nimbus/supervisors themselves. NOTE: that this only works for code that uses the <a href="utils/Time.html" title="class in org.apache.storm.utils"><code>Time</code></a> class for
time management so it will not work in all cases.</div>
</section>
</li>
<li>
<section class="detail" id="withSimulatedTime(boolean)">
<h3>withSimulatedTime</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withSimulatedTime</span><wbr><span class="parameters">(boolean&nbsp;simulateTime)</span></div>
<div class="block">Turn on simulated time in the cluster. This allows someone to simulate long periods of time for timeouts etc when testing
nimbus/supervisors themselves. NOTE: that this only works for code that uses the <a href="utils/Time.html" title="class in org.apache.storm.utils"><code>Time</code></a> class for
time management so it will not work in all cases.</div>
</section>
</li>
<li>
<section class="detail" id="withNimbusWrapper(java.util.function.UnaryOperator)">
<h3>withNimbusWrapper</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withNimbusWrapper</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/UnaryOperator.html" title="class or interface in java.util.function" class="external-link">UnaryOperator</a>&lt;<a href="daemon/nimbus/Nimbus.html" title="class in org.apache.storm.daemon.nimbus">Nimbus</a>&gt;&nbsp;nimbusWrapper)</span></div>
<div class="block">Before nimbus is created/used call nimbusWrapper on it first and use the result instead. This is intended for internal testing
only, and it here to allow a mocking framework to spy on the nimbus class.</div>
</section>
</li>
<li>
<section class="detail" id="withBlobStore(org.apache.storm.blobstore.BlobStore)">
<h3>withBlobStore</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withBlobStore</span><wbr><span class="parameters">(<a href="blobstore/BlobStore.html" title="class in org.apache.storm.blobstore">BlobStore</a>&nbsp;store)</span></div>
<div class="block">Use the following blobstore instead of the one in the config. This is intended mostly for internal testing with Mocks.</div>
</section>
</li>
<li>
<section class="detail" id="withTopoCache(org.apache.storm.daemon.nimbus.TopoCache)">
<h3>withTopoCache</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withTopoCache</span><wbr><span class="parameters">(<a href="daemon/nimbus/TopoCache.html" title="class in org.apache.storm.daemon.nimbus">TopoCache</a>&nbsp;topoCache)</span></div>
<div class="block">Use the following topo cache instead of creating out own. This is intended mostly for internal testing with Mocks.</div>
</section>
</li>
<li>
<section class="detail" id="withClusterState(org.apache.storm.cluster.IStormClusterState)">
<h3>withClusterState</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withClusterState</span><wbr><span class="parameters">(<a href="cluster/IStormClusterState.html" title="interface in org.apache.storm.cluster">IStormClusterState</a>&nbsp;clusterState)</span></div>
<div class="block">Use the following clusterState instead of the one in the config. This is intended mostly for internal testing with Mocks.</div>
</section>
</li>
<li>
<section class="detail" id="withLeaderElector(org.apache.storm.nimbus.ILeaderElector)">
<h3>withLeaderElector</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withLeaderElector</span><wbr><span class="parameters">(<a href="nimbus/ILeaderElector.html" title="interface in org.apache.storm.nimbus">ILeaderElector</a>&nbsp;leaderElector)</span></div>
<div class="block">Use the following leaderElector instead of the one in the config. This is intended mostly for internal testing with Mocks.</div>
</section>
</li>
<li>
<section class="detail" id="withTracked(java.lang.String)">
<h3>withTracked</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withTracked</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;trackId)</span></div>
<div class="block">A tracked cluster can run tracked topologies. See <a href="testing/TrackedTopology.html" title="class in org.apache.storm.testing"><code>TrackedTopology</code></a> for more information on
tracked topologies.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>trackId</code> - an arbitrary unique id that is used to keep track of tracked topologies</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="withTracked()">
<h3>withTracked</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.Builder.html" title="class in org.apache.storm">LocalCluster.Builder</a></span>&nbsp;<span class="element-name">withTracked</span>()</div>
<div class="block">A tracked cluster can run tracked topologies. See <a href="testing/TrackedTopology.html" title="class in org.apache.storm.testing"><code>TrackedTopology</code></a> for more information on
tracked topologies.</div>
</section>
</li>
<li>
<section class="detail" id="build()">
<h3>build</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="LocalCluster.html" title="class in org.apache.storm">LocalCluster</a></span>&nbsp;<span class="element-name">build</span>()
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div>
<div class="block">Builds a new LocalCluster.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the LocalCluster</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - on any one of many different errors. This is intended for testing so yes it is ugly and throws Exception...</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>