| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>BasicContainer (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.daemon.supervisor, class: BasicContainer"> |
| <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/BasicContainer.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: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">org.apache.storm.daemon.supervisor</a></div> |
| <h1 title="Class BasicContainer" class="title">Class BasicContainer</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="Container.html" title="class in org.apache.storm.daemon.supervisor">org.apache.storm.daemon.supervisor.Container</a> |
| <div class="inheritance">org.apache.storm.daemon.supervisor.BasicContainer</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="Killable.html" title="interface in org.apache.storm.daemon.supervisor">Killable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">BasicContainer</span> |
| <span class="extends-implements">extends <a href="Container.html" title="class in org.apache.storm.daemon.supervisor">Container</a></span></div> |
| <div class="block">A container that runs processes on the local box.</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.daemon.supervisor.Container">Nested classes/interfaces inherited from class org.apache.storm.daemon.supervisor.<a href="Container.html" title="class in org.apache.storm.daemon.supervisor">Container</a></h2> |
| <code><a href="Container.ContainerType.html" title="enum in org.apache.storm.daemon.supervisor">Container.ContainerType</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</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">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#exitedEarly" class="member-name-link">exitedEarly</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final double</code></div> |
| <div class="col-second odd-row-color"><code><a href="#hardMemoryLimitMultiplier" class="member-name-link">hardMemoryLimitMultiplier</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final long</code></div> |
| <div class="col-second even-row-color"><code><a href="#hardMemoryLimitOver" class="member-name-link">hardMemoryLimitOver</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="../../utils/LocalState.html" title="class in org.apache.storm.utils">LocalState</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#localState" class="member-name-link">localState</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final long</code></div> |
| <div class="col-second even-row-color"><code><a href="#lowMemoryThresholdMb" class="member-name-link">lowMemoryThresholdMb</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#mediumMemoryGracePeriodMs" class="member-name-link">mediumMemoryGracePeriodMs</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final long</code></div> |
| <div class="col-second even-row-color"><code><a href="#mediumMemoryThresholdMb" class="member-name-link">mediumMemoryThresholdMb</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#memoryLimitExceededStart" class="member-name-link">memoryLimitExceededStart</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected long</code></div> |
| <div class="col-second even-row-color"><code><a href="#memoryLimitMb" class="member-name-link">memoryLimitMb</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <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></code></div> |
| <div class="col-second odd-row-color"><code><a href="#profileCmd" class="member-name-link">profileCmd</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#stormHome" class="member-name-link">stormHome</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.storm.daemon.supervisor.Container">Fields inherited from class org.apache.storm.daemon.supervisor.<a href="Container.html" title="class in org.apache.storm.daemon.supervisor">Container</a></h3> |
| <code><a href="Container.html#assignment">assignment</a>, <a href="Container.html#conf">conf</a>, <a href="Container.html#containerMemoryTracker">containerMemoryTracker</a>, <a href="Container.html#ops">ops</a>, <a href="Container.html#port">port</a>, <a href="Container.html#resourceIsolationManager">resourceIsolationManager</a>, <a href="Container.html#runAsUser">runAsUser</a>, <a href="Container.html#supervisorId">supervisorId</a>, <a href="Container.html#supervisorPort">supervisorPort</a>, <a href="Container.html#symlinksDisabled">symlinksDisabled</a>, <a href="Container.html#topoConf">topoConf</a>, <a href="Container.html#topologyId">topologyId</a>, <a href="Container.html#type">type</a>, <a href="Container.html#workerId">workerId</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(org.apache.storm.daemon.supervisor.Container.ContainerType,java.util.Map,java.lang.String,int,int,org.apache.storm.generated.LocalAssignment,org.apache.storm.container.ResourceIsolationInterface,org.apache.storm.utils.LocalState,java.lang.String,org.apache.storm.metric.StormMetricsRegistry,org.apache.storm.daemon.supervisor.ContainerMemoryTracker)" class="member-name-link">BasicContainer</a><wbr>(<a href="Container.ContainerType.html" title="enum in org.apache.storm.daemon.supervisor">Container.ContainerType</a> type, |
| <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><<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>> conf, |
| <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> supervisorId, |
| int supervisorPort, |
| int port, |
| <a href="../../generated/LocalAssignment.html" title="class in org.apache.storm.generated">LocalAssignment</a> assignment, |
| <a href="../../container/ResourceIsolationInterface.html" title="interface in org.apache.storm.container">ResourceIsolationInterface</a> resourceIsolationManager, |
| <a href="../../utils/LocalState.html" title="class in org.apache.storm.utils">LocalState</a> localState, |
| <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> workerId, |
| <a href="../../metric/StormMetricsRegistry.html" title="class in org.apache.storm.metric">StormMetricsRegistry</a> metricsRegistry, |
| <a href="ContainerMemoryTracker.html" title="class in org.apache.storm.daemon.supervisor">ContainerMemoryTracker</a> containerMemoryTracker)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Create a new BasicContainer.</div> |
| </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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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="#cleanUpForRestart()" class="member-name-link">cleanUpForRestart</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Clean up the container partly preparing for restart.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createNewWorkerId()" class="member-name-link">createNewWorkerId</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create a new worker ID for this process and store in in this object and in the local state.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#didMainProcessExit()" class="member-name-link">didMainProcessExit</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return true if the main process exited, else false.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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><<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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#frameworkClasspath(org.apache.storm.utils.SimpleVersion)" class="member-name-link">frameworkClasspath</a><wbr>(<a href="../../utils/SimpleVersion.html" title="class in org.apache.storm.utils">SimpleVersion</a> topoVersion)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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><<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>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDependencyLocationsFor(java.util.Map,java.lang.String,org.apache.storm.daemon.supervisor.AdvancedFSOps,java.lang.String)" class="member-name-link">getDependencyLocationsFor</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><<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>> conf, |
| <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> topologyId, |
| <a href="AdvancedFSOps.html" title="class in org.apache.storm.daemon.supervisor">AdvancedFSOps</a> ops, |
| <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> stormRoot)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMemoryReservationMb()" class="member-name-link">getMemoryReservationMb</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the current memory reservation of this container.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMemoryUsageMb()" class="member-name-link">getMemoryUsageMb</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the current memory usage of this container.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getStormVersionFor(java.util.Map,java.lang.String,org.apache.storm.daemon.supervisor.AdvancedFSOps,java.lang.String)" class="member-name-link">getStormVersionFor</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><<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>> conf, |
| <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> topologyId, |
| <a href="AdvancedFSOps.html" title="class in org.apache.storm.daemon.supervisor">AdvancedFSOps</a> ops, |
| <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> stormRoot)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWildcardDir(java.io.File)" class="member-name-link">getWildcardDir</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> dir)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a path with a wildcard as the final element, so that the JVM will expand that to all JARs in the directory.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWorkerClassPath(java.lang.String,java.util.List,org.apache.storm.utils.SimpleVersion)" class="member-name-link">getWorkerClassPath</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> stormJar, |
| <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><<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>> dependencyLocations, |
| <a href="../../utils/SimpleVersion.html" title="class in org.apache.storm.utils">SimpleVersion</a> topoVersion)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compute the classpath for the worker process.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWorkerLogWriter(org.apache.storm.utils.SimpleVersion)" class="member-name-link">getWorkerLogWriter</a><wbr>(<a href="../../utils/SimpleVersion.html" title="class in org.apache.storm.utils">SimpleVersion</a> topoVersion)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWorkerMain(org.apache.storm.utils.SimpleVersion)" class="member-name-link">getWorkerMain</a><wbr>(<a href="../../utils/SimpleVersion.html" title="class in org.apache.storm.utils">SimpleVersion</a> topoVersion)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isMemoryLimitViolated(org.apache.storm.generated.LocalAssignment)" class="member-name-link">isMemoryLimitViolated</a><wbr>(<a href="../../generated/LocalAssignment.html" title="class in org.apache.storm.generated">LocalAssignment</a> withUpdatedLimits)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Check if the container is over its memory limit AND needs to be killed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#javaCmd(java.lang.String)" class="member-name-link">javaCmd</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> cmd)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#javaLibraryPath(java.lang.String,java.util.Map)" class="member-name-link">javaLibraryPath</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> stormRoot, |
| <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><<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>> conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compute the java.library.path that should be used for the worker.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#launch()" class="member-name-link">launch</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Launch the process for the first time.</div> |
| </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="#relaunch()" class="member-name-link">relaunch</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Restart the processes in this container.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#runProfiling(org.apache.storm.generated.ProfileRequest,boolean)" class="member-name-link">runProfiling</a><wbr>(<a href="../../generated/ProfileRequest.html" title="class in org.apache.storm.generated">ProfileRequest</a> request, |
| boolean stop)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Run a profiling request.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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><<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>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#substituteChildopts(java.lang.Object)" class="member-name-link">substituteChildopts</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> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <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><<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>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#substituteChildopts(java.lang.Object,int,int)" class="member-name-link">substituteChildopts</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> value, |
| int memOnheap, |
| int memOffHeap)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.daemon.supervisor.Container">Methods inherited from class org.apache.storm.daemon.supervisor.<a href="Container.html" title="class in org.apache.storm.daemon.supervisor">Container</a></h3> |
| <code><a href="Container.html#areAllProcessesDead()">areAllProcessesDead</a>, <a href="Container.html#cleanUp()">cleanUp</a>, <a href="Container.html#createArtifactsLink()">createArtifactsLink</a>, <a href="Container.html#createBlobstoreLinks()">createBlobstoreLinks</a>, <a href="Container.html#deleteSavedWorkerUser()">deleteSavedWorkerUser</a>, <a href="Container.html#forceKill()">forceKill</a>, <a href="Container.html#getTotalTopologyMemoryReserved(org.apache.storm.generated.LocalAssignment)">getTotalTopologyMemoryReserved</a>, <a href="Container.html#getTotalTopologyMemoryUsed()">getTotalTopologyMemoryUsed</a>, <a href="Container.html#getTotalWorkersForThisTopology()">getTotalWorkersForThisTopology</a>, <a href="Container.html#getWorkerId()">getWorkerId</a>, <a href="Container.html#getWorkerUser()">getWorkerUser</a>, <a href="Container.html#kill()">kill</a>, <a href="Container.html#readHeartbeat()">readHeartbeat</a>, <a href="Container.html#readTopoConf()">readTopoConf</a>, <a href="Container.html#saveWorkerUser(java.lang.String)">saveWorkerUser</a>, <a href="Container.html#setup()">setup</a>, <a href="Container.html#toString()">toString</a>, <a href="Container.html#updateMemoryAccounting()">updateMemoryAccounting</a>, <a href="Container.html#writeLogMetadata(java.lang.String)">writeLogMetadata</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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#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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="localState"> |
| <h3>localState</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../../utils/LocalState.html" title="class in org.apache.storm.utils">LocalState</a></span> <span class="element-name">localState</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="profileCmd"> |
| <h3>profileCmd</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><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></span> <span class="element-name">profileCmd</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stormHome"> |
| <h3>stormHome</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><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></span> <span class="element-name">stormHome</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hardMemoryLimitMultiplier"> |
| <h3>hardMemoryLimitMultiplier</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">double</span> <span class="element-name">hardMemoryLimitMultiplier</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hardMemoryLimitOver"> |
| <h3>hardMemoryLimitOver</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">long</span> <span class="element-name">hardMemoryLimitOver</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lowMemoryThresholdMb"> |
| <h3>lowMemoryThresholdMb</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">long</span> <span class="element-name">lowMemoryThresholdMb</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="mediumMemoryThresholdMb"> |
| <h3>mediumMemoryThresholdMb</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">long</span> <span class="element-name">mediumMemoryThresholdMb</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="mediumMemoryGracePeriodMs"> |
| <h3>mediumMemoryGracePeriodMs</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">long</span> <span class="element-name">mediumMemoryGracePeriodMs</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="exitedEarly"> |
| <h3>exitedEarly</h3> |
| <div class="member-signature"><span class="modifiers">protected volatile</span> <span class="return-type">boolean</span> <span class="element-name">exitedEarly</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="memoryLimitMb"> |
| <h3>memoryLimitMb</h3> |
| <div class="member-signature"><span class="modifiers">protected volatile</span> <span class="return-type">long</span> <span class="element-name">memoryLimitMb</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="memoryLimitExceededStart"> |
| <h3>memoryLimitExceededStart</h3> |
| <div class="member-signature"><span class="modifiers">protected volatile</span> <span class="return-type">long</span> <span class="element-name">memoryLimitExceededStart</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.storm.daemon.supervisor.Container.ContainerType,java.util.Map,java.lang.String,int,int,org.apache.storm.generated.LocalAssignment,org.apache.storm.container.ResourceIsolationInterface,org.apache.storm.utils.LocalState,java.lang.String,org.apache.storm.metric.StormMetricsRegistry,org.apache.storm.daemon.supervisor.ContainerMemoryTracker)"> |
| <h3>BasicContainer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">BasicContainer</span><wbr><span class="parameters">(<a href="Container.ContainerType.html" title="enum in org.apache.storm.daemon.supervisor">Container.ContainerType</a> type, |
| <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><<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>> conf, |
| <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> supervisorId, |
| int supervisorPort, |
| int port, |
| <a href="../../generated/LocalAssignment.html" title="class in org.apache.storm.generated">LocalAssignment</a> assignment, |
| <a href="../../container/ResourceIsolationInterface.html" title="interface in org.apache.storm.container">ResourceIsolationInterface</a> resourceIsolationManager, |
| <a href="../../utils/LocalState.html" title="class in org.apache.storm.utils">LocalState</a> localState, |
| <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> workerId, |
| <a href="../../metric/StormMetricsRegistry.html" title="class in org.apache.storm.metric">StormMetricsRegistry</a> metricsRegistry, |
| <a href="ContainerMemoryTracker.html" title="class in org.apache.storm.daemon.supervisor">ContainerMemoryTracker</a> containerMemoryTracker)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Create a new BasicContainer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - the type of container being made.</dd> |
| <dd><code>conf</code> - the supervisor config</dd> |
| <dd><code>supervisorId</code> - the ID of the supervisor this is a part of.</dd> |
| <dd><code>supervisorPort</code> - the thrift server port of the supervisor this is a part of.</dd> |
| <dd><code>port</code> - the port the container is on. Should be <= 0 if only a partial recovery</dd> |
| <dd><code>assignment</code> - the assignment for this container. Should be null if only a partial recovery.</dd> |
| <dd><code>resourceIsolationManager</code> - used to isolate resources for a container can be null if no isolation is used.</dd> |
| <dd><code>localState</code> - the local state of the supervisor. May be null if partial recovery</dd> |
| <dd><code>workerId</code> - the id of the worker to use. Must not be null if doing a partial recovery.</dd> |
| <dd><code>metricsRegistry</code> - The metrics registry.</dd> |
| <dd><code>containerMemoryTracker</code> - The shared memory tracker for the supervisor's containers</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </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="getDependencyLocationsFor(java.util.Map,java.lang.String,org.apache.storm.daemon.supervisor.AdvancedFSOps,java.lang.String)"> |
| <h3>getDependencyLocationsFor</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><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><<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>></span> <span class="element-name">getDependencyLocationsFor</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><<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>> conf, |
| <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> topologyId, |
| <a href="AdvancedFSOps.html" title="class in org.apache.storm.daemon.supervisor">AdvancedFSOps</a> ops, |
| <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> stormRoot)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStormVersionFor(java.util.Map,java.lang.String,org.apache.storm.daemon.supervisor.AdvancedFSOps,java.lang.String)"> |
| <h3>getStormVersionFor</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><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></span> <span class="element-name">getStormVersionFor</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><<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>> conf, |
| <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> topologyId, |
| <a href="AdvancedFSOps.html" title="class in org.apache.storm.daemon.supervisor">AdvancedFSOps</a> ops, |
| <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> stormRoot)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createNewWorkerId()"> |
| <h3>createNewWorkerId</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">createNewWorkerId</span>()</div> |
| <div class="block">Create a new worker ID for this process and store in in this object and in the local state. Never call this if a worker is currently |
| up and running. We will lose track of the process.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanUpForRestart()"> |
| <h3>cleanUpForRestart</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">cleanUpForRestart</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Container.html#cleanUpForRestart()">Container</a></code></span></div> |
| <div class="block">Clean up the container partly preparing for restart. By default delete all of the temp directories we are going to get a new |
| worker_id anyways. POST CONDITION: the workerId will be set to null</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Container.html#cleanUpForRestart()">cleanUpForRestart</a></code> in class <code><a href="Container.html" title="class in org.apache.storm.daemon.supervisor">Container</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - on any error</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="relaunch()"> |
| <h3>relaunch</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">relaunch</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Container.html#relaunch()">Container</a></code></span></div> |
| <div class="block">Restart the processes in this container. PREREQUISITE: cleanUpForRestart has run and passed</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Container.html#relaunch()">relaunch</a></code> in class <code><a href="Container.html" title="class in org.apache.storm.daemon.supervisor">Container</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - on any error</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="didMainProcessExit()"> |
| <h3>didMainProcessExit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">didMainProcessExit</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Container.html#didMainProcessExit()">Container</a></code></span></div> |
| <div class="block">Return true if the main process exited, else false. This is just best effort return false if unknown.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Container.html#didMainProcessExit()">didMainProcessExit</a></code> in class <code><a href="Container.html" title="class in org.apache.storm.daemon.supervisor">Container</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="runProfiling(org.apache.storm.generated.ProfileRequest,boolean)"> |
| <h3>runProfiling</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">runProfiling</span><wbr><span class="parameters">(<a href="../../generated/ProfileRequest.html" title="class in org.apache.storm.generated">ProfileRequest</a> request, |
| boolean stop)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Container.html#runProfiling(org.apache.storm.generated.ProfileRequest,boolean)">Container</a></code></span></div> |
| <div class="block">Run a profiling request.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Container.html#runProfiling(org.apache.storm.generated.ProfileRequest,boolean)">runProfiling</a></code> in class <code><a href="Container.html" title="class in org.apache.storm.daemon.supervisor">Container</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>request</code> - the request to run</dd> |
| <dd><code>stop</code> - is this a stop request?</dd> |
| <dt>Returns:</dt> |
| <dd>true if it succeeded, else false</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - on any error</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code> - if running the command is interrupted.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="javaLibraryPath(java.lang.String,java.util.Map)"> |
| <h3>javaLibraryPath</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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></span> <span class="element-name">javaLibraryPath</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> stormRoot, |
| <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><<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>> conf)</span></div> |
| <div class="block">Compute the java.library.path that should be used for the worker. This helps it to load JNI libraries that are packaged in the uber |
| jar.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stormRoot</code> - the root directory of the worker process</dd> |
| <dd><code>conf</code> - the config for the supervisor.</dd> |
| <dt>Returns:</dt> |
| <dd>the java.library.path/LD_LIBRARY_PATH to use so native libraries load correctly.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWildcardDir(java.io.File)"> |
| <h3>getWildcardDir</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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></span> <span class="element-name">getWildcardDir</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> dir)</span></div> |
| <div class="block">Returns a path with a wildcard as the final element, so that the JVM will expand that to all JARs in the directory.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dir</code> - the directory to which a wildcard will be appended</dd> |
| <dt>Returns:</dt> |
| <dd>the path with wildcard ("*") suffix</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="frameworkClasspath(org.apache.storm.utils.SimpleVersion)"> |
| <h3>frameworkClasspath</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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><<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>></span> <span class="element-name">frameworkClasspath</span><wbr><span class="parameters">(<a href="../../utils/SimpleVersion.html" title="class in org.apache.storm.utils">SimpleVersion</a> topoVersion)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWorkerMain(org.apache.storm.utils.SimpleVersion)"> |
| <h3>getWorkerMain</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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></span> <span class="element-name">getWorkerMain</span><wbr><span class="parameters">(<a href="../../utils/SimpleVersion.html" title="class in org.apache.storm.utils">SimpleVersion</a> topoVersion)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWorkerLogWriter(org.apache.storm.utils.SimpleVersion)"> |
| <h3>getWorkerLogWriter</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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></span> <span class="element-name">getWorkerLogWriter</span><wbr><span class="parameters">(<a href="../../utils/SimpleVersion.html" title="class in org.apache.storm.utils">SimpleVersion</a> topoVersion)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWorkerClassPath(java.lang.String,java.util.List,org.apache.storm.utils.SimpleVersion)"> |
| <h3>getWorkerClassPath</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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></span> <span class="element-name">getWorkerClassPath</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> stormJar, |
| <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><<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>> dependencyLocations, |
| <a href="../../utils/SimpleVersion.html" title="class in org.apache.storm.utils">SimpleVersion</a> topoVersion)</span></div> |
| <div class="block">Compute the classpath for the worker process.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>stormJar</code> - the topology jar</dd> |
| <dd><code>dependencyLocations</code> - any dependencies from the topology</dd> |
| <dd><code>topoVersion</code> - the version of the storm framework to use</dd> |
| <dt>Returns:</dt> |
| <dd>the full classpath</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="substituteChildopts(java.lang.Object)"> |
| <h3>substituteChildopts</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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><<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>></span> <span class="element-name">substituteChildopts</span><wbr><span class="parameters">(<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> value)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="substituteChildopts(java.lang.Object,int,int)"> |
| <h3>substituteChildopts</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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><<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>></span> <span class="element-name">substituteChildopts</span><wbr><span class="parameters">(<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> value, |
| int memOnheap, |
| int memOffHeap)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="javaCmd(java.lang.String)"> |
| <h3>javaCmd</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><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></span> <span class="element-name">javaCmd</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> cmd)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isMemoryLimitViolated(org.apache.storm.generated.LocalAssignment)"> |
| <h3>isMemoryLimitViolated</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isMemoryLimitViolated</span><wbr><span class="parameters">(<a href="../../generated/LocalAssignment.html" title="class in org.apache.storm.generated">LocalAssignment</a> withUpdatedLimits)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Container.html#isMemoryLimitViolated(org.apache.storm.generated.LocalAssignment)">Container</a></code></span></div> |
| <div class="block">Check if the container is over its memory limit AND needs to be killed. This does not necessarily mean that it just went over the |
| limit.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Container.html#isMemoryLimitViolated(org.apache.storm.generated.LocalAssignment)">isMemoryLimitViolated</a></code> in class <code><a href="Container.html" title="class in org.apache.storm.daemon.supervisor">Container</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - on any error</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMemoryUsageMb()"> |
| <h3>getMemoryUsageMb</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMemoryUsageMb</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Container.html#getMemoryUsageMb()">Container</a></code></span></div> |
| <div class="block">Get the current memory usage of this container.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Container.html#getMemoryUsageMb()">getMemoryUsageMb</a></code> in class <code><a href="Container.html" title="class in org.apache.storm.daemon.supervisor">Container</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMemoryReservationMb()"> |
| <h3>getMemoryReservationMb</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMemoryReservationMb</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Container.html#getMemoryReservationMb()">Container</a></code></span></div> |
| <div class="block">Get the current memory reservation of this container.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="Container.html#getMemoryReservationMb()">getMemoryReservationMb</a></code> in class <code><a href="Container.html" title="class in org.apache.storm.daemon.supervisor">Container</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="launch()"> |
| <h3>launch</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">launch</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="Container.html#launch()">Container</a></code></span></div> |
| <div class="block">Launch the process for the first time. PREREQUISITE: setup has run and passed</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Container.html#launch()">launch</a></code> in class <code><a href="Container.html" title="class in org.apache.storm.daemon.supervisor">Container</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - on any error</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
