| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>RuntimeManagerMain (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/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="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RuntimeManagerMain (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":9,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.heron.scheduler</a></div> |
| <h2 title="Class RuntimeManagerMain" class="title">Class RuntimeManagerMain</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.scheduler.RuntimeManagerMain</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">RuntimeManagerMain</span> |
| extends java.lang.Object</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.heron.spi.common.Config,org.apache.heron.scheduler.Command)">RuntimeManagerMain</a></span>​(<a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> config, |
| <a href="Command.html" title="enum in org.apache.heron.scheduler">Command</a> command)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callRuntimeManagerRunner(org.apache.heron.spi.common.Config,org.apache.heron.scheduler.client.ISchedulerClient,boolean)">callRuntimeManagerRunner</a></span>​(<a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime, |
| <a href="client/ISchedulerClient.html" title="interface in org.apache.heron.scheduler.client">ISchedulerClient</a> schedulerClient, |
| boolean potentialStaleExecutionData)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="client/ISchedulerClient.html" title="interface in org.apache.heron.scheduler.client">ISchedulerClient</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSchedulerClient(org.apache.heron.spi.common.Config)">getSchedulerClient</a></span>​(<a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#main(java.lang.String%5B%5D)">main</a></span>​(java.lang.String[] args)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#manageTopology()">manageTopology</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Manager a topology |
| 1.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#translateCommandLineConfig(org.apache.commons.cli.CommandLine,org.apache.heron.spi.common.Config.Builder)">translateCommandLineConfig</a></span>​(org.apache.commons.cli.CommandLine cmd, |
| <a href="../spi/common/Config.Builder.html" title="class in org.apache.heron.spi.common">Config.Builder</a> config)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateExecutionState(java.lang.String,org.apache.heron.proto.system.ExecutionEnvironment.ExecutionState)">validateExecutionState</a></span>​(java.lang.String topologyName, |
| <a href="../proto/system/ExecutionEnvironment.ExecutionState.html" title="class in org.apache.heron.proto.system">ExecutionEnvironment.ExecutionState</a> executionState)</code></th> |
| <td class="colLast"> |
| <div class="block">Verify that the environment information in execution state matches the request</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateRuntimeManage(org.apache.heron.spi.statemgr.SchedulerStateManagerAdaptor,java.lang.String)">validateRuntimeManage</a></span>​(<a href="../spi/statemgr/SchedulerStateManagerAdaptor.html" title="class in org.apache.heron.spi.statemgr">SchedulerStateManagerAdaptor</a> adaptor, |
| java.lang.String topologyName)</code></th> |
| <td class="colLast"> |
| <div class="block">Before continuing to the action logic, verify: |
| - the topology is running |
| - the information in execution state matches the request |
| There is an edge case that the topology data could be only partially available, |
| which could be caused by not fully successful SUBMIT or KILL command.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.heron.spi.common.Config,org.apache.heron.scheduler.Command)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RuntimeManagerMain</h4> |
| <pre>public RuntimeManagerMain​(<a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> config, |
| <a href="Command.html" title="enum in org.apache.heron.scheduler">Command</a> command)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="main(java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>main</h4> |
| <pre class="methodSignature">public static void main​(java.lang.String[] args) |
| throws java.lang.ClassNotFoundException, |
| java.lang.IllegalAccessException, |
| java.lang.InstantiationException, |
| java.io.IOException, |
| org.apache.commons.cli.ParseException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.ClassNotFoundException</code></dd> |
| <dd><code>java.lang.IllegalAccessException</code></dd> |
| <dd><code>java.lang.InstantiationException</code></dd> |
| <dd><code>java.io.IOException</code></dd> |
| <dd><code>org.apache.commons.cli.ParseException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="manageTopology()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>manageTopology</h4> |
| <pre class="methodSignature">public void manageTopology() |
| throws <a href="TopologyRuntimeManagementException.html" title="class in org.apache.heron.scheduler">TopologyRuntimeManagementException</a>, |
| <a href="../spi/utils/TManagerException.html" title="class in org.apache.heron.spi.utils">TManagerException</a>, |
| <a href="../spi/packing/PackingException.html" title="class in org.apache.heron.spi.packing">PackingException</a></pre> |
| <div class="block">Manager a topology |
| 1. Instantiate necessary resources |
| 2. Valid whether the runtime management is legal |
| 3. Complete the runtime management for a specific command</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="TopologyRuntimeManagementException.html" title="class in org.apache.heron.scheduler">TopologyRuntimeManagementException</a></code></dd> |
| <dd><code><a href="../spi/utils/TManagerException.html" title="class in org.apache.heron.spi.utils">TManagerException</a></code></dd> |
| <dd><code><a href="../spi/packing/PackingException.html" title="class in org.apache.heron.spi.packing">PackingException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="validateRuntimeManage(org.apache.heron.spi.statemgr.SchedulerStateManagerAdaptor,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateRuntimeManage</h4> |
| <pre class="methodSignature">protected boolean validateRuntimeManage​(<a href="../spi/statemgr/SchedulerStateManagerAdaptor.html" title="class in org.apache.heron.spi.statemgr">SchedulerStateManagerAdaptor</a> adaptor, |
| java.lang.String topologyName) |
| throws <a href="TopologyRuntimeManagementException.html" title="class in org.apache.heron.scheduler">TopologyRuntimeManagementException</a></pre> |
| <div class="block">Before continuing to the action logic, verify: |
| - the topology is running |
| - the information in execution state matches the request |
| There is an edge case that the topology data could be only partially available, |
| which could be caused by not fully successful SUBMIT or KILL command. In this |
| case, we need to skip the validation and allow KILL command to go through. |
| In case execution state data is available, environment check will be done anyway.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the topology execution data is found, false otherwise.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="TopologyRuntimeManagementException.html" title="class in org.apache.heron.scheduler">TopologyRuntimeManagementException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="validateExecutionState(java.lang.String,org.apache.heron.proto.system.ExecutionEnvironment.ExecutionState)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateExecutionState</h4> |
| <pre class="methodSignature">protected void validateExecutionState​(java.lang.String topologyName, |
| <a href="../proto/system/ExecutionEnvironment.ExecutionState.html" title="class in org.apache.heron.proto.system">ExecutionEnvironment.ExecutionState</a> executionState) |
| throws <a href="TopologyRuntimeManagementException.html" title="class in org.apache.heron.scheduler">TopologyRuntimeManagementException</a></pre> |
| <div class="block">Verify that the environment information in execution state matches the request</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="TopologyRuntimeManagementException.html" title="class in org.apache.heron.scheduler">TopologyRuntimeManagementException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="callRuntimeManagerRunner(org.apache.heron.spi.common.Config,org.apache.heron.scheduler.client.ISchedulerClient,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>callRuntimeManagerRunner</h4> |
| <pre class="methodSignature">protected void callRuntimeManagerRunner​(<a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime, |
| <a href="client/ISchedulerClient.html" title="interface in org.apache.heron.scheduler.client">ISchedulerClient</a> schedulerClient, |
| boolean potentialStaleExecutionData) |
| throws <a href="TopologyRuntimeManagementException.html" title="class in org.apache.heron.scheduler">TopologyRuntimeManagementException</a>, |
| <a href="../spi/utils/TManagerException.html" title="class in org.apache.heron.spi.utils">TManagerException</a>, |
| <a href="../spi/packing/PackingException.html" title="class in org.apache.heron.spi.packing">PackingException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="TopologyRuntimeManagementException.html" title="class in org.apache.heron.scheduler">TopologyRuntimeManagementException</a></code></dd> |
| <dd><code><a href="../spi/utils/TManagerException.html" title="class in org.apache.heron.spi.utils">TManagerException</a></code></dd> |
| <dd><code><a href="../spi/packing/PackingException.html" title="class in org.apache.heron.spi.packing">PackingException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSchedulerClient(org.apache.heron.spi.common.Config)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchedulerClient</h4> |
| <pre class="methodSignature">protected <a href="client/ISchedulerClient.html" title="interface in org.apache.heron.scheduler.client">ISchedulerClient</a> getSchedulerClient​(<a href="../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime) |
| throws <a href="../spi/scheduler/SchedulerException.html" title="class in org.apache.heron.spi.scheduler">SchedulerException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../spi/scheduler/SchedulerException.html" title="class in org.apache.heron.spi.scheduler">SchedulerException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="translateCommandLineConfig(org.apache.commons.cli.CommandLine,org.apache.heron.spi.common.Config.Builder)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>translateCommandLineConfig</h4> |
| <pre class="methodSignature">protected static void translateCommandLineConfig​(org.apache.commons.cli.CommandLine cmd, |
| <a href="../spi/common/Config.Builder.html" title="class in org.apache.heron.spi.common">Config.Builder</a> config)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
