| <!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 (1.8.0_221) on Wed Jan 29 15:38:00 PST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TwillPreparer (Apache Twill 0.14.0 API)</title> |
| <meta name="date" content="2020-01-29"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="TwillPreparer (Apache Twill 0.14.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":38,"i9":6,"i10":6,"i11":6,"i12":38,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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/TwillPreparer.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/TwillController.html" title="interface in org.apache.twill.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/twill/api/TwillPreparer.html" target="_top">Frames</a></li> |
| <li><a href="TwillPreparer.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 TwillPreparer" class="title">Interface TwillPreparer</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">TwillPreparer</span></pre> |
| <div class="block">This interface exposes methods to set up the Twill runtime environment and start a Twill application.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#addJVMOptions-java.lang.String-">addJVMOptions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> options)</code> |
| <div class="block">This methods adds extra JVM options that will be passed to the java command line for every runnable |
| of the application started through this <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#addLogHandler-org.apache.twill.api.logging.LogHandler-">addLogHandler</a></span>(<a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging">LogHandler</a> handler)</code> |
| <div class="block">Adds a <a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging"><code>LogHandler</code></a> for receiving an application log.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#addSecureStore-org.apache.twill.api.SecureStore-">addSecureStore</a></span>(<a href="../../../../org/apache/twill/api/SecureStore.html" title="interface in org.apache.twill.api">SecureStore</a> secureStore)</code> |
| <div class="block">Adds security credentials for the runtime environment to gives application access to resources.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#enableDebugging-boolean-java.lang.String...-">enableDebugging</a></span>(boolean doSuspend, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... runnables)</code> |
| <div class="block">Enable debugging for runnables.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#enableDebugging-java.lang.String...-">enableDebugging</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... runnables)</code> |
| <div class="block">Enable debugging for runnables, without suspending the virtual machine to wait for the debugger.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#setClassLoader-java.lang.String-">setClassLoader</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> classLoaderClassName)</code> |
| <div class="block">Sets the class name of the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> to be used for loading twill and application classes for |
| all containers.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#setJVMOptions-java.lang.String-">setJVMOptions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> options)</code> |
| <div class="block">This methods sets the extra JVM options that will be passed to the java command line for every runnable |
| of the application started through this <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#setJVMOptions-java.lang.String-java.lang.String-">setJVMOptions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> options)</code> |
| <div class="block">This methods sets the extra JVM options that will be passed to the java command line for the given runnable |
| of the application started through this <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#setLogLevel-org.apache.twill.api.logging.LogEntry.Level-">setLogLevel</a></span>(<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a> logLevel)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/twill/api/TwillPreparer.html#setLogLevels-java.util.Map-"><code>setLogLevels(Map)</code></a> with key <code>Logger.ROOT_LOGGER_NAME</code> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#setLogLevels-java.util.Map-">setLogLevels</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a>> logLevels)</code> |
| <div class="block">Set the log levels for requested logger names for Twill applications running in a container.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#setLogLevels-java.lang.String-java.util.Map-">setLogLevels</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a>> logLevelsForRunnable)</code> |
| <div class="block">Set the log levels for requested logger names for a <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#setSchedulerQueue-java.lang.String-">setSchedulerQueue</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Sets the name of the scheduler queue to use.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#setUser-java.lang.String-">setUser</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">This method will be removed in future version.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#start--">start</a></span>()</code> |
| <div class="block">Starts the application.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#start-long-java.util.concurrent.TimeUnit-">start</a></span>(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeoutUnit)</code> |
| <div class="block">Starts the application.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withApplicationArguments-java.lang.Iterable-">withApplicationArguments</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args)</code> |
| <div class="block">Sets the list of arguments that will be passed to the application.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withApplicationArguments-java.lang.String...-">withApplicationArguments</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</code> |
| <div class="block">Sets the list of arguments that will be passed to the application.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withApplicationClassPaths-java.lang.Iterable-">withApplicationClassPaths</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> classPaths)</code> |
| <div class="block">Adds the set of paths to the classpath on the target machine for ApplicationMaster and all runnables.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withApplicationClassPaths-java.lang.String...-">withApplicationClassPaths</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... classPaths)</code> |
| <div class="block">Adds the set of paths to the classpath on the target machine for ApplicationMaster and all runnables.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withArguments-java.lang.String-java.lang.Iterable-">withArguments</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args)</code> |
| <div class="block">Sets the list of arguments that will be passed to the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> identified by the given name.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withArguments-java.lang.String-java.lang.String...-">withArguments</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</code> |
| <div class="block">Sets the list of arguments that will be passed to the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> identified by the given name.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withBundlerClassAcceptor-org.apache.twill.api.ClassAcceptor-">withBundlerClassAcceptor</a></span>(<a href="../../../../org/apache/twill/api/ClassAcceptor.html" title="class in org.apache.twill.api">ClassAcceptor</a> classAcceptor)</code> |
| <div class="block">Uses <a href="../../../../org/apache/twill/api/ClassAcceptor.html" title="class in org.apache.twill.api"><code>ClassAcceptor</code></a> to determine the classes to include in the bundle jar for |
| ApplicationMaster and all runnables.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withClassPaths-java.lang.Iterable-">withClassPaths</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> classPaths)</code> |
| <div class="block">Adds the set of paths to the classpath on the target machine for all runnables.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withClassPaths-java.lang.String...-">withClassPaths</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... classPaths)</code> |
| <div class="block">Adds the set of paths to the classpath on the target machine for all runnables.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withConfiguration-java.util.Map-">withConfiguration</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> config)</code> |
| <div class="block">Overrides the default configuration with the given set of configurations.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withConfiguration-java.lang.String-java.util.Map-">withConfiguration</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> config)</code> |
| <div class="block">Overrides the default configuration with the given set of configurations for the given runnable only.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withDependencies-java.lang.Class...-">withDependencies</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>... classes)</code> |
| <div class="block">Adds extra classes that the application is dependent on and is not traceable from the application itself.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withDependencies-java.lang.Iterable-">withDependencies</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>> classes)</code> |
| <div class="block">Adds extra classes that the application is dependent on and is not traceable from the application itself.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withEnv-java.util.Map-">withEnv</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env)</code> |
| <div class="block">Adds the set of environment variables that will be set as container environment variables for all runnables.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withEnv-java.lang.String-java.util.Map-">withEnv</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env)</code> |
| <div class="block">Adds the set of environment variables that will be set as container environment variables for the given runnable.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withMaxRetries-java.lang.String-int-">withMaxRetries</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| int maxRetries)</code> |
| <div class="block">Sets the maximum number of times (per instance) a runnable will be retried if it exits without success.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withResources-java.lang.Iterable-">withResources</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>> resources)</code> |
| <div class="block">Adds resources that will be available through the ClassLoader of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>runnables</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillPreparer.html#withResources-java.net.URI...-">withResources</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>... resources)</code> |
| <div class="block">Adds resources that will be available through the ClassLoader of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>runnables</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </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="withConfiguration-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withConfiguration</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withConfiguration(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> config)</pre> |
| <div class="block">Overrides the default configuration with the given set of configurations.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - set of configurations to override</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withConfiguration-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withConfiguration</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withConfiguration(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> config)</pre> |
| <div class="block">Overrides the default configuration with the given set of configurations for the given runnable only. |
| This is useful to override configurations that affects runnables, such as |
| <a href="../../../../org/apache/twill/api/Configs.Keys.html#JAVA_RESERVED_MEMORY_MB"><code>Configs.Keys.JAVA_RESERVED_MEMORY_MB</code></a> and <a href="../../../../org/apache/twill/api/Configs.Keys.html#HEAP_RESERVED_MIN_RATIO"><code>Configs.Keys.HEAP_RESERVED_MIN_RATIO</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnableName</code> - Name of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</dd> |
| <dd><code>config</code> - set of configurations to override</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addLogHandler-org.apache.twill.api.logging.LogHandler-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addLogHandler</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> addLogHandler(<a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging">LogHandler</a> handler)</pre> |
| <div class="block">Adds a <a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging"><code>LogHandler</code></a> for receiving an application log.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>handler</code> - The <a href="../../../../org/apache/twill/api/logging/LogHandler.html" title="interface in org.apache.twill.api.logging"><code>LogHandler</code></a>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setUser-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setUser</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> setUser(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> user)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">This method will be removed in future version.</span></div> |
| <div class="block">Sets the user name that runs the application. Default value is get from <code>"user.name"</code> by calling |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#getProperty-java.lang.String-" title="class or interface in java.lang"><code>System.getProperty(String)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>user</code> - User name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSchedulerQueue-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSchedulerQueue</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> setSchedulerQueue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Sets the name of the scheduler queue to use.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Name of the scheduler queue</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setJVMOptions-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setJVMOptions</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> setJVMOptions(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> options)</pre> |
| <div class="block">This methods sets the extra JVM options that will be passed to the java command line for every runnable |
| of the application started through this <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> instance. |
| |
| This is intended for advance usage. All options will be passed unchanged to the java command line. Invalid |
| options could cause application not able to start.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - extra JVM options.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setJVMOptions-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setJVMOptions</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> setJVMOptions(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> options)</pre> |
| <div class="block">This methods sets the extra JVM options that will be passed to the java command line for the given runnable |
| of the application started through this <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> instance. |
| The options set for the given runnable will be appended to any global options set through the |
| <a href="../../../../org/apache/twill/api/TwillPreparer.html#setJVMOptions-java.lang.String-"><code>setJVMOptions(String)</code></a> or <a href="../../../../org/apache/twill/api/TwillPreparer.html#addJVMOptions-java.lang.String-"><code>addJVMOptions(String)</code></a> method. |
| |
| This is intended for advance usage. All options will be passed unchanged to the java command line. Invalid |
| options could cause application not able to start.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - extra JVM options.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addJVMOptions-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addJVMOptions</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> addJVMOptions(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> options)</pre> |
| <div class="block">This methods adds extra JVM options that will be passed to the java command line for every runnable |
| of the application started through this <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> instance. |
| |
| This is intended for advance usage. All options will be passed unchanged to the java command line. Invalid |
| options could cause application not able to start.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>options</code> - extra JVM options.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="enableDebugging-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enableDebugging</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> enableDebugging(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... runnables)</pre> |
| <div class="block">Enable debugging for runnables, without suspending the virtual machine to wait for the debugger. |
| This replaces any previous debug settings.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnables</code> - the names of runnables to enable for debugging. If empty, it means all runnables.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="enableDebugging-boolean-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enableDebugging</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> enableDebugging(boolean doSuspend, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... runnables)</pre> |
| <div class="block">Enable debugging for runnables. This replaces any previous debug settings.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>doSuspend</code> - whether the virtual machines should be supended until the debugger connects. This |
| option allows to debug a container from the very beginning. Note that in that case, |
| the container cannot notify the controller of its debug port until the debugger is |
| attached - you must figure out where it is running using the YARN console or APIs.</dd> |
| <dd><code>runnables</code> - the names of runnables to enable for debugging. If empty, it means all runnables.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withApplicationArguments-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withApplicationArguments</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withApplicationArguments(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</pre> |
| <div class="block">Sets the list of arguments that will be passed to the application. The arguments can be retrieved |
| from <a href="../../../../org/apache/twill/api/TwillContext.html#getApplicationArguments--"><code>TwillContext.getApplicationArguments()</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - Array of arguments.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withApplicationArguments-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withApplicationArguments</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withApplicationArguments(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args)</pre> |
| <div class="block">Sets the list of arguments that will be passed to the application. The arguments can be retrieved |
| from <a href="../../../../org/apache/twill/api/TwillContext.html#getApplicationArguments--"><code>TwillContext.getApplicationArguments()</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - Iterable of arguments.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withArguments-java.lang.String-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withArguments</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withArguments(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</pre> |
| <div class="block">Sets the list of arguments that will be passed to the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> identified by the given name. |
| The arguments can be retrieved from <a href="../../../../org/apache/twill/api/TwillContext.html#getArguments--"><code>TwillContext.getArguments()</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnableName</code> - Name of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</dd> |
| <dd><code>args</code> - Array of arguments.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withArguments-java.lang.String-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withArguments</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withArguments(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> args)</pre> |
| <div class="block">Sets the list of arguments that will be passed to the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> identified by the given name. |
| The arguments can be retrieved from <a href="../../../../org/apache/twill/api/TwillContext.html#getArguments--"><code>TwillContext.getArguments()</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnableName</code> - Name of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</dd> |
| <dd><code>args</code> - Iterable of arguments.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withDependencies-java.lang.Class...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDependencies</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withDependencies(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>... classes)</pre> |
| <div class="block">Adds extra classes that the application is dependent on and is not traceable from the application itself.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/twill/api/TwillPreparer.html#withDependencies-java.lang.Iterable-"><code>withDependencies(Iterable)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withDependencies-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDependencies</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withDependencies(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?>> classes)</pre> |
| <div class="block">Adds extra classes that the application is dependent on and is not traceable from the application itself. |
| E.g. Class name used in <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#forName-java.lang.String-" title="class or interface in java.lang"><code>Class.forName(String)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classes</code> - set of classes to add to dependency list for generating the deployment jar.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withResources-java.net.URI...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withResources</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withResources(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>... resources)</pre> |
| <div class="block">Adds resources that will be available through the ClassLoader of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>runnables</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/twill/api/TwillPreparer.html#withResources-java.lang.Iterable-"><code>withResources(Iterable)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withResources-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withResources</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withResources(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a>> resources)</pre> |
| <div class="block">Adds resources that will be available through the ClassLoader of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>runnables</code></a>. |
| Useful for adding extra resource files or libraries that are not traceable from the application itself. |
| If the URI is a jar file, classes inside would be loadable by the ClassLoader. If the URI is a directory, |
| everything underneath would be available.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resources</code> - Set of URI to the resources.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withClassPaths-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withClassPaths</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withClassPaths(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... classPaths)</pre> |
| <div class="block">Adds the set of paths to the classpath on the target machine for all runnables.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/twill/api/TwillPreparer.html#withClassPaths-java.lang.Iterable-"><code>withClassPaths(Iterable)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withClassPaths-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withClassPaths</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withClassPaths(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> classPaths)</pre> |
| <div class="block">Adds the set of paths to the classpath on the target machine for all runnables. |
| Note that the paths would be just added without verification.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classPaths</code> - Set of classpaths</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withEnv-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withEnv</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withEnv(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env)</pre> |
| <div class="block">Adds the set of environment variables that will be set as container environment variables for all runnables.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>env</code> - set of environment variables</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withEnv-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withEnv</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withEnv(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> env)</pre> |
| <div class="block">Adds the set of environment variables that will be set as container environment variables for the given runnable. |
| Environment variables set through this method has higher precedence than the one set through <a href="../../../../org/apache/twill/api/TwillPreparer.html#withEnv-java.util.Map-"><code>withEnv(Map)</code></a> |
| if there is a key clash.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnableName</code> - Name of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</dd> |
| <dd><code>env</code> - set of environment variables</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withApplicationClassPaths-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withApplicationClassPaths</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withApplicationClassPaths(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... classPaths)</pre> |
| <div class="block">Adds the set of paths to the classpath on the target machine for ApplicationMaster and all runnables.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withApplicationClassPaths-java.lang.Iterable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withApplicationClassPaths</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withApplicationClassPaths(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> classPaths)</pre> |
| <div class="block">Adds the set of paths to the classpath on the target machine for ApplicationMaster and all runnables.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withBundlerClassAcceptor-org.apache.twill.api.ClassAcceptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withBundlerClassAcceptor</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withBundlerClassAcceptor(<a href="../../../../org/apache/twill/api/ClassAcceptor.html" title="class in org.apache.twill.api">ClassAcceptor</a> classAcceptor)</pre> |
| <div class="block">Uses <a href="../../../../org/apache/twill/api/ClassAcceptor.html" title="class in org.apache.twill.api"><code>ClassAcceptor</code></a> to determine the classes to include in the bundle jar for |
| ApplicationMaster and all runnables.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classAcceptor</code> - to specify which classes to include in the bundle jar</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withMaxRetries-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withMaxRetries</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> withMaxRetries(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| int maxRetries)</pre> |
| <div class="block">Sets the maximum number of times (per instance) a runnable will be retried if it exits without success. The default |
| behavior is to retry indefinitely.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnableName</code> - Name of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</dd> |
| <dd><code>maxRetries</code> - maximum number of retries per instance</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addSecureStore-org.apache.twill.api.SecureStore-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSecureStore</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> addSecureStore(<a href="../../../../org/apache/twill/api/SecureStore.html" title="interface in org.apache.twill.api">SecureStore</a> secureStore)</pre> |
| <div class="block">Adds security credentials for the runtime environment to gives application access to resources.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>secureStore</code> - Contains security token available for the runtime environment.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLogLevel-org.apache.twill.api.logging.LogEntry.Level-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLogLevel</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> setLogLevel(<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a> logLevel)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/twill/api/TwillPreparer.html#setLogLevels-java.util.Map-"><code>setLogLevels(Map)</code></a> with key <code>Logger.ROOT_LOGGER_NAME</code> instead.</span></div> |
| <div class="block">Set the root log level for Twill applications in all containers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>logLevel</code> - the <code>LogEntry.Level</code> that should be set. |
| The level match the <code>Logback</code> levels.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLogLevels-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLogLevels</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> setLogLevels(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a>> logLevels)</pre> |
| <div class="block">Set the log levels for requested logger names for Twill applications running in a container. The log level of any |
| logger cannot be <code>null</code>, if there is <code>null</code> value, a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>logLevels</code> - The <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> contains the requested logger names and log levels that need to be set.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLogLevels-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLogLevels</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> setLogLevels(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> runnableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/twill/api/logging/LogEntry.Level.html" title="enum in org.apache.twill.api.logging">LogEntry.Level</a>> logLevelsForRunnable)</pre> |
| <div class="block">Set the log levels for requested logger names for a <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>. The log level of any logger cannot be |
| <code>null</code>, if there is <code>null</code> value, a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>runnableName</code> - The name of the runnable to set the log level.</dd> |
| <dd><code>logLevelsForRunnable</code> - The <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> contains the requested logger names and log levels that need to be set.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setClassLoader-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setClassLoader</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> setClassLoader(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> classLoaderClassName)</pre> |
| <div class="block">Sets the class name of the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> to be used for loading twill and application classes for |
| all containers. The <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> class should have a public constructor that takes two parameters in the |
| form of <code>(URL[] urls, ClassLoader parentClassLoader)</code>. |
| The first parameter is an array of <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net"><code>URL</code></a> that contains the list of <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net"><code>URL</code></a> for loading classes and |
| resources; the second parameter is the parent <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classLoaderClassName</code> - name of the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang"><code>ClassLoader</code></a> class.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a> start()</pre> |
| <div class="block">Starts the application. It's the same as calling <a href="../../../../org/apache/twill/api/TwillPreparer.html#start-long-java.util.concurrent.TimeUnit-"><code>start(long, TimeUnit)</code></a> with timeout of 60 seconds.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> for controlling the running application.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a> start(long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeoutUnit)</pre> |
| <div class="block">Starts the application. The application must be started within the given timeout. An application may fail to start |
| within a given time if there is insufficient resources.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - maximum time to wait for the application to start</dd> |
| <dd><code>timeoutUnit</code> - unit for the timeout</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> for controlling the running application.</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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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/TwillPreparer.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/TwillController.html" title="interface in org.apache.twill.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/twill/api/TwillPreparer.html" target="_top">Frames</a></li> |
| <li><a href="TwillPreparer.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-2020 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
