blob: 1dfa1bc9daf0ef50b45691327a7448c2d9542441 [file] [log] [blame]
<!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>TwillRunner (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="TwillRunner (Apache Twill 0.14.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":38,"i7":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/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="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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="typeNameLabel">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="memberSummary" 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">&nbsp;</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&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api">TwillRunner.LiveInfo</a></span></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="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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillRunner.html#lookup-java.lang.String-">lookup</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>&nbsp;applicationName)</code>
<div class="block">Gets an <a href="https://docs.oracle.com/javase/8/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 id="i1" 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/TwillRunner.html#lookup-java.lang.String-org.apache.twill.api.RunId-">lookup</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>&nbsp;applicationName,
<a href="../../../../org/apache/twill/api/RunId.html" title="interface in org.apache.twill.api">RunId</a>&nbsp;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 id="i2" class="altColor">
<td class="colFirst"><code><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>&lt;<a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api">TwillRunner.LiveInfo</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillRunner.html#lookupLive--">lookupLive</a></span>()</code>
<div class="block">Gets an <a href="https://docs.oracle.com/javase/8/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 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/TwillRunner.html#prepare-org.apache.twill.api.TwillApplication-">prepare</a></span>(<a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api">TwillApplication</a>&nbsp;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 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/TwillRunner.html#prepare-org.apache.twill.api.TwillRunnable-">prepare</a></span>(<a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a>&nbsp;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 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/TwillRunner.html#prepare-org.apache.twill.api.TwillRunnable-org.apache.twill.api.ResourceSpecification-">prepare</a></span>(<a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a>&nbsp;runnable,
<a href="../../../../org/apache/twill/api/ResourceSpecification.html" title="interface in org.apache.twill.api">ResourceSpecification</a>&nbsp;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 id="i6" 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><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillRunner.html#scheduleSecureStoreUpdate-org.apache.twill.api.SecureStoreUpdater-long-long-java.util.concurrent.TimeUnit-">scheduleSecureStoreUpdate</a></span>(<a href="../../../../org/apache/twill/api/SecureStoreUpdater.html" title="interface in org.apache.twill.api">SecureStoreUpdater</a>&nbsp;updater,
long&nbsp;initialDelay,
long&nbsp;delay,
<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>&nbsp;unit)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/twill/api/TwillRunner.html#setSecureStoreRenewer-org.apache.twill.api.security.SecureStoreRenewer-long-long-long-java.util.concurrent.TimeUnit-"><code>setSecureStoreRenewer(SecureStoreRenewer, long, long, long, TimeUnit)</code></a> instead.</span></div>
</div>
</td>
</tr>
<tr id="i7" 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><span class="memberNameLink"><a href="../../../../org/apache/twill/api/TwillRunner.html#setSecureStoreRenewer-org.apache.twill.api.security.SecureStoreRenewer-long-long-long-java.util.concurrent.TimeUnit-">setSecureStoreRenewer</a></span>(<a href="../../../../org/apache/twill/api/security/SecureStoreRenewer.html" title="class in org.apache.twill.api.security">SecureStoreRenewer</a>&nbsp;renewer,
long&nbsp;initialDelay,
long&nbsp;delay,
long&nbsp;retryDelay,
<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>&nbsp;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>&nbsp;prepare(<a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a>&nbsp;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="paramLabel">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="returnLabel">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>&nbsp;prepare(<a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a>&nbsp;runnable,
<a href="../../../../org/apache/twill/api/ResourceSpecification.html" title="interface in org.apache.twill.api">ResourceSpecification</a>&nbsp;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="paramLabel">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="returnLabel">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>&nbsp;prepare(<a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api">TwillApplication</a>&nbsp;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="paramLabel">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="returnLabel">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>&nbsp;lookup(<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>&nbsp;applicationName,
<a href="../../../../org/apache/twill/api/RunId.html" title="interface in org.apache.twill.api">RunId</a>&nbsp;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="paramLabel">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="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> 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="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a>&gt;&nbsp;lookup(<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>&nbsp;applicationName)</pre>
<div class="block">Gets an <a href="https://docs.oracle.com/javase/8/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="paramLabel">Parameters:</span></dt>
<dd><code>applicationName</code> - Name of the application.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A live <a href="https://docs.oracle.com/javase/8/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="https://docs.oracle.com/javase/8/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="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a>&lt;<a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api">TwillRunner.LiveInfo</a>&gt;&nbsp;lookupLive()</pre>
<div class="block">Gets an <a href="https://docs.oracle.com/javase/8/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="returnLabel">Returns:</span></dt>
<dd>A live <a href="https://docs.oracle.com/javase/8/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="https://docs.oracle.com/javase/8/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="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/common/Cancellable.html" title="interface in org.apache.twill.common">Cancellable</a>&nbsp;scheduleSecureStoreUpdate(<a href="../../../../org/apache/twill/api/SecureStoreUpdater.html" title="interface in org.apache.twill.api">SecureStoreUpdater</a>&nbsp;updater,
long&nbsp;initialDelay,
long&nbsp;delay,
<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>&nbsp;unit)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../../org/apache/twill/api/TwillRunner.html#setSecureStoreRenewer-org.apache.twill.api.security.SecureStoreRenewer-long-long-long-java.util.concurrent.TimeUnit-"><code>setSecureStoreRenewer(SecureStoreRenewer, long, long, long, TimeUnit)</code></a> instead.</span></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-org.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="paramLabel">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="returnLabel">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>&nbsp;setSecureStoreRenewer(<a href="../../../../org/apache/twill/api/security/SecureStoreRenewer.html" title="class in org.apache.twill.api.security">SecureStoreRenewer</a>&nbsp;renewer,
long&nbsp;initialDelay,
long&nbsp;delay,
long&nbsp;retryDelay,
<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>&nbsp;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="paramLabel">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-org.apache.twill.api.RunId-org.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>
<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/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="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api"><span class="typeNameLink">Next&nbsp;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&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2013-2020 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>