| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Sat Apr 08 11:09:15 PDT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TwillRunnerService (Apache Twill 0.11.0 API)</title> |
| <meta name="date" content="2017-04-08"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TwillRunnerService (Apache Twill 0.11.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TwillRunnerService.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/twill/api/TwillRunResources.html" title="interface in org.apache.twill.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/twill/api/TwillRunnerService.html" target="_top">Frames</a></li> |
| <li><a href="TwillRunnerService.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.twill.api</div> |
| <h2 title="Interface TwillRunnerService" class="title">Interface TwillRunnerService</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/twill/yarn/YarnTwillRunnerService.html" title="class in org.apache.twill.yarn">YarnTwillRunnerService</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">TwillRunnerService</span> |
| extends <a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></pre> |
| <div class="block">A <a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api"><code>TwillRunner</code></a> that provides lifecycle management functions. |
| The <a href="../../../../org/apache/twill/api/TwillRunnerService.html#start()"><code>start()</code></a> method needs to be called before calling any other method of this interface. |
| When done with this service, call <a href="../../../../org/apache/twill/api/TwillRunnerService.html#stop()"><code>stop()</code></a> to release any resources that it holds.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.twill.api.TwillRunner"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.twill.api.<a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></h3> |
| <code><a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api">TwillRunner.LiveInfo</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunnerService.html#start()">start</a></strong>()</code> |
| <div class="block">Starts the service.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunnerService.html#stop()">stop</a></strong>()</code> |
| <div class="block">Stops the service.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.twill.api.TwillRunner"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.twill.api.<a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></h3> |
| <code><a href="../../../../org/apache/twill/api/TwillRunner.html#lookup(java.lang.String)">lookup</a>, <a href="../../../../org/apache/twill/api/TwillRunner.html#lookup(java.lang.String,%20org.apache.twill.api.RunId)">lookup</a>, <a href="../../../../org/apache/twill/api/TwillRunner.html#lookupLive()">lookupLive</a>, <a href="../../../../org/apache/twill/api/TwillRunner.html#prepare(org.apache.twill.api.TwillApplication)">prepare</a>, <a href="../../../../org/apache/twill/api/TwillRunner.html#prepare(org.apache.twill.api.TwillRunnable)">prepare</a>, <a href="../../../../org/apache/twill/api/TwillRunner.html#prepare(org.apache.twill.api.TwillRunnable,%20org.apache.twill.api.ResourceSpecification)">prepare</a>, <a href="../../../../org/apache/twill/api/TwillRunner.html#scheduleSecureStoreUpdate(org.apache.twill.api.SecureStoreUpdater,%20long,%20long,%20java.util.concurrent.TimeUnit)">scheduleSecureStoreUpdate</a>, <a href="../../../../org/apache/twill/api/TwillRunner.html#setSecureStoreRenewer(org.apache.twill.api.security.SecureStoreRenewer,%20long,%20long,%20long,%20java.util.concurrent.TimeUnit)">setSecureStoreRenewer</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="start()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>void start()</pre> |
| <div class="block">Starts the service. Calling this method on a already started instance has no effect. |
| A service that is stopped cannot be started again.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - if the service failed to start.</dd></dl> |
| </li> |
| </ul> |
| <a name="stop()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>stop</h4> |
| <pre>void stop()</pre> |
| <div class="block">Stops the service. Calling this method on a already stopped instance has no effect.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - if the service failed to start.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TwillRunnerService.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/twill/api/TwillRunResources.html" title="interface in org.apache.twill.api"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/twill/api/TwillRunnerService.html" target="_top">Frames</a></li> |
| <li><a href="TwillRunnerService.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2013-2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |