| <!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>TwillRunner (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="TwillRunner (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/TwillRunner.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/TwillRunnableSpecification.Builder.NameSetter.html" title="class in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.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/TwillRunner.html" target="_top">Frames</a></li> |
| <li><a href="TwillRunner.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><a href="#nested_class_summary">Nested</a> | </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 TwillRunner" class="title">Interface TwillRunner</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/twill/api/TwillRunnerService.html" title="interface in org.apache.twill.api">TwillRunnerService</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">TwillRunner</span></pre> |
| <div class="block">This interface prepares execution of <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> and <a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api"><code>TwillApplication</code></a>.</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> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api">TwillRunner.LiveInfo</a></strong></code> |
| <div class="block">Interface to represents information of a live application.</div> |
| </td> |
| </tr> |
| </table> |
| </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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunner.html#lookup(java.lang.String)">lookup</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationName)</code> |
| <div class="block">Gets an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> of <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> for all running instances of the given application.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../org/apache/twill/api/TwillRunner.html#lookup(java.lang.String,%20org.apache.twill.api.RunId)">lookup</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationName, |
| <a href="../../../../org/apache/twill/api/RunId.html" title="interface in org.apache.twill.api">RunId</a> runId)</code> |
| <div class="block">Gets a <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> for the given application and runId.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api">TwillRunner.LiveInfo</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunner.html#lookupLive()">lookupLive</a></strong>()</code> |
| <div class="block">Gets an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> of <a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api"><code>TwillRunner.LiveInfo</code></a>.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../org/apache/twill/api/TwillRunner.html#prepare(org.apache.twill.api.TwillApplication)">prepare</a></strong>(<a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api">TwillApplication</a> application)</code> |
| <div class="block">Prepares to run the given <a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api"><code>TwillApplication</code></a> as specified by the application.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../org/apache/twill/api/TwillRunner.html#prepare(org.apache.twill.api.TwillRunnable)">prepare</a></strong>(<a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a> runnable)</code> |
| <div class="block">Prepares to run the given <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> with <a href="../../../../org/apache/twill/api/ResourceSpecification.html#BASIC"><code>ResourceSpecification.BASIC</code></a> resource specification.</div> |
| </td> |
| </tr> |
| <tr 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><strong><a href="../../../../org/apache/twill/api/TwillRunner.html#prepare(org.apache.twill.api.TwillRunnable,%20org.apache.twill.api.ResourceSpecification)">prepare</a></strong>(<a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a> runnable, |
| <a href="../../../../org/apache/twill/api/ResourceSpecification.html" title="interface in org.apache.twill.api">ResourceSpecification</a> resourceSpecification)</code> |
| <div class="block">Prepares to run the given <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> with the given resource specification.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common">Cancellable</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunner.html#scheduleSecureStoreUpdate(org.apache.twill.api.SecureStoreUpdater,%20long,%20long,%20java.util.concurrent.TimeUnit)">scheduleSecureStoreUpdate</a></strong>(<a href="../../../../org/apache/twill/api/SecureStoreUpdater.html" title="interface in org.apache.twill.api">SecureStoreUpdater</a> updater, |
| long initialDelay, |
| long delay, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>Use <a href="../../../../org/apache/twill/api/TwillRunner.html#setSecureStoreRenewer(org.apache.twill.api.security.SecureStoreRenewer,%20long,%20long,%20long,%20java.util.concurrent.TimeUnit)"><code>setSecureStoreRenewer(SecureStoreRenewer, long, long, long, TimeUnit)</code></a> instead.</i></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common">Cancellable</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/twill/api/TwillRunner.html#setSecureStoreRenewer(org.apache.twill.api.security.SecureStoreRenewer,%20long,%20long,%20long,%20java.util.concurrent.TimeUnit)">setSecureStoreRenewer</a></strong>(<a href="../../../../org/apache/twill/api/security/SecureStoreRenewer.html" title="class in org.apache.twill.api.security">SecureStoreRenewer</a> renewer, |
| long initialDelay, |
| long delay, |
| long retryDelay, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> |
| <div class="block">Sets and schedules a periodic renewal of <a href="../../../../org/apache/twill/api/SecureStore.html" title="interface in org.apache.twill.api"><code>SecureStore</code></a> using a given <a href="../../../../org/apache/twill/api/security/SecureStoreRenewer.html" title="class in org.apache.twill.api.security"><code>SecureStoreRenewer</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="prepare(org.apache.twill.api.TwillRunnable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> prepare(<a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a> runnable)</pre> |
| <div class="block">Prepares to run the given <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> with <a href="../../../../org/apache/twill/api/ResourceSpecification.html#BASIC"><code>ResourceSpecification.BASIC</code></a> resource specification. |
| The name for the runnable will be defaulted to <code>runnable.getClass().getSimpleName()</code></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>runnable</code> - The runnable to run through Twill when <a href="../../../../org/apache/twill/api/TwillPreparer.html#start()"><code>TwillPreparer.start()</code></a> is called.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> for setting up runtime options.</dd></dl> |
| </li> |
| </ul> |
| <a name="prepare(org.apache.twill.api.TwillRunnable, org.apache.twill.api.ResourceSpecification)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> prepare(<a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a> runnable, |
| <a href="../../../../org/apache/twill/api/ResourceSpecification.html" title="interface in org.apache.twill.api">ResourceSpecification</a> resourceSpecification)</pre> |
| <div class="block">Prepares to run the given <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> with the given resource specification. The name for the runnable |
| will be defaulted to <code>runnable.getClass().getSimpleName()</code></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>runnable</code> - The runnable to run through Twill when <a href="../../../../org/apache/twill/api/TwillPreparer.html#start()"><code>TwillPreparer.start()</code></a> is called.</dd><dd><code>resourceSpecification</code> - The resource specification for running the runnable.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> for setting up runtime options.</dd></dl> |
| </li> |
| </ul> |
| <a name="prepare(org.apache.twill.api.TwillApplication)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a> prepare(<a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api">TwillApplication</a> application)</pre> |
| <div class="block">Prepares to run the given <a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api"><code>TwillApplication</code></a> as specified by the application.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>application</code> - The application to run through Twill when <a href="../../../../org/apache/twill/api/TwillPreparer.html#start()"><code>TwillPreparer.start()</code></a> is called.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api"><code>TwillPreparer</code></a> for setting up runtime options.</dd></dl> |
| </li> |
| </ul> |
| <a name="lookup(java.lang.String, org.apache.twill.api.RunId)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lookup</h4> |
| <pre><a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a> lookup(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationName, |
| <a href="../../../../org/apache/twill/api/RunId.html" title="interface in org.apache.twill.api">RunId</a> runId)</pre> |
| <div class="block">Gets a <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> for the given application and runId.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>applicationName</code> - Name of the application.</dd><dd><code>runId</code> - The runId of the running application.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> to interact with the application or null if no such runId is found.</dd></dl> |
| </li> |
| </ul> |
| <a name="lookup(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lookup</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a>> lookup(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> applicationName)</pre> |
| <div class="block">Gets an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> of <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> for all running instances of the given application.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>applicationName</code> - Name of the application.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>A live <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> that gives the latest <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> set for all running |
| instances of the application when <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang"><code>Iterable.iterator()</code></a> is invoked.</dd></dl> |
| </li> |
| </ul> |
| <a name="lookupLive()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lookupLive</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><<a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api">TwillRunner.LiveInfo</a>> lookupLive()</pre> |
| <div class="block">Gets an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> of <a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api"><code>TwillRunner.LiveInfo</code></a>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>A live <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a> that gives the latest information on the set of applications that |
| have running instances when <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang"><code>Iterable.iterator()</code></a>} is invoked.</dd></dl> |
| </li> |
| </ul> |
| <a name="scheduleSecureStoreUpdate(org.apache.twill.api.SecureStoreUpdater, long, long, java.util.concurrent.TimeUnit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scheduleSecureStoreUpdate</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| <a href="../../../../org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common">Cancellable</a> scheduleSecureStoreUpdate(<a href="../../../../org/apache/twill/api/SecureStoreUpdater.html" title="interface in org.apache.twill.api">SecureStoreUpdater</a> updater, |
| long initialDelay, |
| long delay, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i>Use <a href="../../../../org/apache/twill/api/TwillRunner.html#setSecureStoreRenewer(org.apache.twill.api.security.SecureStoreRenewer,%20long,%20long,%20long,%20java.util.concurrent.TimeUnit)"><code>setSecureStoreRenewer(SecureStoreRenewer, long, long, long, TimeUnit)</code></a> instead.</i></div> |
| <div class="block">Schedules a periodic update of SecureStore. The first call to the given <a href="../../../../org/apache/twill/api/SecureStoreUpdater.html" title="interface in org.apache.twill.api"><code>SecureStoreUpdater</code></a> will be made |
| after <code>initialDelay</code>, and subsequently with the given <code>delay</code> between completion of one update |
| and starting of the next. If exception is thrown on call |
| <a href="../../../../org/apache/twill/api/SecureStoreUpdater.html#update(java.lang.String,%20org.apache.twill.api.RunId)"><code>SecureStoreUpdater.update(String, RunId)</code></a>, the exception will only get logged |
| and won't suppress the next update call.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>updater</code> - A <a href="../../../../org/apache/twill/api/SecureStoreUpdater.html" title="interface in org.apache.twill.api"><code>SecureStoreUpdater</code></a> for creating new SecureStore.</dd><dd><code>initialDelay</code> - Delay before the first call to update method.</dd><dd><code>delay</code> - Delay between completion of one update call to the next one.</dd><dd><code>unit</code> - time unit for the initialDelay and delay.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>A <a href="../../../../org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common"><code>Cancellable</code></a> for cancelling the scheduled update.</dd></dl> |
| </li> |
| </ul> |
| <a name="setSecureStoreRenewer(org.apache.twill.api.security.SecureStoreRenewer, long, long, long, java.util.concurrent.TimeUnit)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setSecureStoreRenewer</h4> |
| <pre><a href="../../../../org/apache/twill/common/Cancellable.html" title="interface in org.apache.twill.common">Cancellable</a> setSecureStoreRenewer(<a href="../../../../org/apache/twill/api/security/SecureStoreRenewer.html" title="class in org.apache.twill.api.security">SecureStoreRenewer</a> renewer, |
| long initialDelay, |
| long delay, |
| long retryDelay, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> |
| <div class="block">Sets and schedules a periodic renewal of <a href="../../../../org/apache/twill/api/SecureStore.html" title="interface in org.apache.twill.api"><code>SecureStore</code></a> using a given <a href="../../../../org/apache/twill/api/security/SecureStoreRenewer.html" title="class in org.apache.twill.api.security"><code>SecureStoreRenewer</code></a>. |
| There is always only one active <a href="../../../../org/apache/twill/api/security/SecureStoreRenewer.html" title="class in org.apache.twill.api.security"><code>SecureStoreRenewer</code></a>. Setting a new renewer will replace the old one |
| and setting up a new schedule.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>renewer</code> - a <a href="../../../../org/apache/twill/api/security/SecureStoreRenewer.html" title="class in org.apache.twill.api.security"><code>SecureStoreRenewer</code></a> for renewing <a href="../../../../org/apache/twill/api/SecureStore.html" title="interface in org.apache.twill.api"><code>SecureStore</code></a> for all applications.</dd><dd><code>initialDelay</code> - delay before the first call to renew method.</dd><dd><code>delay</code> - the delay between successful completion of one renew call to the next one.</dd><dd><code>retryDelay</code> - the delay before the retrying the renewal if the call |
| to <a href="../../../../org/apache/twill/api/security/SecureStoreRenewer.html#renew(java.lang.String,%20org.apache.twill.api.RunId,%20org.apache.twill.api.security.SecureStoreWriter)"><code>SecureStoreRenewer.renew(String, RunId, SecureStoreWriter)</code></a> raised exception.</dd><dd><code>unit</code> - time unit for the initialDelay and period.</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/TwillRunner.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/TwillRunnableSpecification.Builder.NameSetter.html" title="class in org.apache.twill.api"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.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/TwillRunner.html" target="_top">Frames</a></li> |
| <li><a href="TwillRunner.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><a href="#nested_class_summary">Nested</a> | </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> |