| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>LauncherUtils (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="LauncherUtils (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"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.utils</a></div> |
| <h2 title="Class LauncherUtils" class="title">Class LauncherUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.scheduler.utils.LauncherUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">LauncherUtils</span> |
| extends java.lang.Object</pre> |
| <div class="block"><a href="LauncherUtils.html" title="class in org.apache.heron.scheduler.utils"><code>LauncherUtils</code></a> contains helper methods used by the server and client side launch |
| controllers; <a href="../LaunchRunner.html" title="class in org.apache.heron.scheduler"><code>LaunchRunner</code></a> and |
| <a href="../SchedulerMain.html" title="class in org.apache.heron.scheduler"><code>SchedulerMain</code></a></div> |
| </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()">LauncherUtils</a></span>()</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><a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAdaptorRuntime(org.apache.heron.spi.statemgr.SchedulerStateManagerAdaptor)">createAdaptorRuntime</a></span>​(<a href="../../spi/statemgr/SchedulerStateManagerAdaptor.html" title="class in org.apache.heron.spi.statemgr">SchedulerStateManagerAdaptor</a> adaptor)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates initial runtime config of scheduler state manager adaptor</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createConfigWithPackingDetails(org.apache.heron.spi.common.Config,org.apache.heron.spi.packing.PackingPlan)">createConfigWithPackingDetails</a></span>​(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime, |
| <a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a> packing)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a config instance with packing plan info added to runtime config</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createPackingPlan(org.apache.heron.spi.common.Config,org.apache.heron.spi.common.Config)">createPackingPlan</a></span>​(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> config, |
| <a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a packing plan generated by configured packing class</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createPrimaryRuntime(org.apache.heron.api.generated.TopologyAPI.Topology)">createPrimaryRuntime</a></span>​(<a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates initial runtime config instance using topology information.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="LauncherUtils.html" title="class in org.apache.heron.scheduler.utils">LauncherUtils</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance()">getInstance</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSchedulerInstance(org.apache.heron.spi.common.Config,org.apache.heron.spi.common.Config)">getSchedulerInstance</a></span>​(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> config, |
| <a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates and initializes scheduler instance</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onScheduleAsLibrary(org.apache.heron.spi.common.Config,org.apache.heron.spi.common.Config,org.apache.heron.spi.scheduler.IScheduler,org.apache.heron.spi.packing.PackingPlan)">onScheduleAsLibrary</a></span>​(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> config, |
| <a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime, |
| <a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a> scheduler, |
| <a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a> packing)</code></th> |
| <td class="colLast"> |
| <div class="block">Invoke the onScheduler() in IScheduler directly as a library</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>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LauncherUtils</h4> |
| <pre>public LauncherUtils()</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="getInstance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstance</h4> |
| <pre class="methodSignature">public static <a href="LauncherUtils.html" title="class in org.apache.heron.scheduler.utils">LauncherUtils</a> getInstance()</pre> |
| </li> |
| </ul> |
| <a id="createPackingPlan(org.apache.heron.spi.common.Config,org.apache.heron.spi.common.Config)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createPackingPlan</h4> |
| <pre class="methodSignature">public <a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a> createPackingPlan​(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> config, |
| <a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime) |
| throws <a href="../../spi/packing/PackingException.html" title="class in org.apache.heron.spi.packing">PackingException</a></pre> |
| <div class="block">Returns a packing plan generated by configured packing class</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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="onScheduleAsLibrary(org.apache.heron.spi.common.Config,org.apache.heron.spi.common.Config,org.apache.heron.spi.scheduler.IScheduler,org.apache.heron.spi.packing.PackingPlan)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onScheduleAsLibrary</h4> |
| <pre class="methodSignature">public boolean onScheduleAsLibrary​(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> config, |
| <a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime, |
| <a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a> scheduler, |
| <a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a> packing)</pre> |
| <div class="block">Invoke the onScheduler() in IScheduler directly as a library</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - The Config to initialize IScheduler</dd> |
| <dd><code>runtime</code> - The runtime Config to initialize IScheduler</dd> |
| <dd><code>scheduler</code> - the IScheduler to invoke</dd> |
| <dd><code>packing</code> - The PackingPlan to scheduler for OnSchedule()</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if scheduling successfully</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSchedulerInstance(org.apache.heron.spi.common.Config,org.apache.heron.spi.common.Config)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSchedulerInstance</h4> |
| <pre class="methodSignature">public <a href="../../spi/scheduler/IScheduler.html" title="interface in org.apache.heron.spi.scheduler">IScheduler</a> getSchedulerInstance​(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> config, |
| <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> |
| <div class="block">Creates and initializes scheduler instance</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>initialized scheduler instances</dd> |
| <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="createPrimaryRuntime(org.apache.heron.api.generated.TopologyAPI.Topology)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createPrimaryRuntime</h4> |
| <pre class="methodSignature">public <a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> createPrimaryRuntime​(<a href="../../api/generated/TopologyAPI.Topology.html" title="class in org.apache.heron.api.generated">TopologyAPI.Topology</a> topology)</pre> |
| <div class="block">Creates initial runtime config instance using topology information.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>initial runtime config instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createAdaptorRuntime(org.apache.heron.spi.statemgr.SchedulerStateManagerAdaptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAdaptorRuntime</h4> |
| <pre class="methodSignature">public <a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> createAdaptorRuntime​(<a href="../../spi/statemgr/SchedulerStateManagerAdaptor.html" title="class in org.apache.heron.spi.statemgr">SchedulerStateManagerAdaptor</a> adaptor)</pre> |
| <div class="block">Creates initial runtime config of scheduler state manager adaptor</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>adaptor config</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createConfigWithPackingDetails(org.apache.heron.spi.common.Config,org.apache.heron.spi.packing.PackingPlan)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createConfigWithPackingDetails</h4> |
| <pre class="methodSignature">public <a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> createConfigWithPackingDetails​(<a href="../../spi/common/Config.html" title="class in org.apache.heron.spi.common">Config</a> runtime, |
| <a href="../../spi/packing/PackingPlan.html" title="class in org.apache.heron.spi.packing">PackingPlan</a> packing)</pre> |
| <div class="block">Creates a config instance with packing plan info added to runtime config</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>packing details config</dd> |
| </dl> |
| </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> |