Google Git
Sign in
apache / twill / refs/heads/site / . / src / site / resources / apidocs-0.14.0 / org / apache / twill / api / package-summary.html
blob: 3fc2eb1c09f0f85893ede11dbe2e114782ee5acd [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:01 PST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.twill.api (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="org.apache.twill.api (Apache Twill 0.14.0 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>Prev&nbsp;Package</li>
<li><a href="../../../../org/apache/twill/api/logging/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/twill/api/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.twill.api</h1>
<div class="docSummary">
<div class="block">Classes in this package provides core functionality of the Twill library.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/Command.html" title="interface in org.apache.twill.api">Command</a></td>
<td class="colLast">
<div class="block">Represents command objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/ElectionHandler.html" title="interface in org.apache.twill.api">ElectionHandler</a></td>
<td class="colLast">
<div class="block">Handles events of election/un-election of leader.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/EventHandlerContext.html" title="interface in org.apache.twill.api">EventHandlerContext</a></td>
<td class="colLast">
<div class="block">Represents runtime context for <a href="../../../../org/apache/twill/api/EventHandler.html" title="class in org.apache.twill.api"><code>EventHandler</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/EventHandlerSpecification.html" title="interface in org.apache.twill.api">EventHandlerSpecification</a></td>
<td class="colLast">
<div class="block">Specification for <a href="../../../../org/apache/twill/api/EventHandler.html" title="class in org.apache.twill.api"><code>EventHandler</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/LocalFile.html" title="interface in org.apache.twill.api">LocalFile</a></td>
<td class="colLast">
<div class="block">This interface represents a local file that will be available for the container running a <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/ResourceReport.html" title="interface in org.apache.twill.api">ResourceReport</a></td>
<td class="colLast">
<div class="block">This interface provides a snapshot of the resources an application is using
broken down by each runnable.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/ResourceSpecification.html" title="interface in org.apache.twill.api">ResourceSpecification</a></td>
<td class="colLast">
<div class="block">This interface provides specifications for resource requirements including set and get methods
for number of cores, amount of memory, and number of instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/RunId.html" title="interface in org.apache.twill.api">RunId</a></td>
<td class="colLast">
<div class="block">Represents the unique ID of a particular execution.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/RuntimeSpecification.html" title="interface in org.apache.twill.api">RuntimeSpecification</a></td>
<td class="colLast">
<div class="block">Specifications for runtime requirements.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/SecureStore.html" title="interface in org.apache.twill.api">SecureStore</a></td>
<td class="colLast">
<div class="block">Represents storage of secure tokens.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/SecureStoreUpdater.html" title="interface in org.apache.twill.api">SecureStoreUpdater</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">This class doesn't handle user correctly, use <a href="../../../../org/apache/twill/api/security/SecureStoreRenewer.html" title="class in org.apache.twill.api.security"><code>SecureStoreRenewer</code></a> instead</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/ServiceAnnouncer.html" title="interface in org.apache.twill.api">ServiceAnnouncer</a></td>
<td class="colLast">
<div class="block">This interface provides a way to announce the availability of a service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api">ServiceController</a></td>
<td class="colLast">
<div class="block">This interface is for controlling a remote running service.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api">TwillApplication</a></td>
<td class="colLast">
<div class="block">Represents a application that can be launched by Twill.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillContext.html" title="interface in org.apache.twill.api">TwillContext</a></td>
<td class="colLast">
<div class="block">Represents the runtime context of a <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api">TwillController</a></td>
<td class="colLast">
<div class="block">For controlling a running application.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillPreparer.html" title="interface in org.apache.twill.api">TwillPreparer</a></td>
<td class="colLast">
<div class="block">This interface exposes methods to set up the Twill runtime environment and start a Twill application.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api">TwillRunnable</a></td>
<td class="colLast">
<div class="block">The <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> interface should be implemented by any
class whose instances are intended to be executed in a Twill cluster.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillRunnableSpecification.html" title="interface in org.apache.twill.api">TwillRunnableSpecification</a></td>
<td class="colLast">
<div class="block">Represents a specification of a <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api">TwillRunner</a></td>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillRunner.LiveInfo.html" title="interface in org.apache.twill.api">TwillRunner.LiveInfo</a></td>
<td class="colLast">
<div class="block">Interface to represents information of a live application.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillRunnerService.html" title="interface in org.apache.twill.api">TwillRunnerService</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/twill/api/TwillRunner.html" title="interface in org.apache.twill.api"><code>TwillRunner</code></a> that provides lifecycle management functions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillRunResources.html" title="interface in org.apache.twill.api">TwillRunResources</a></td>
<td class="colLast">
<div class="block">Information about the container the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>
is running in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.html" title="interface in org.apache.twill.api">TwillSpecification</a></td>
<td class="colLast">
<div class="block">Represents specification of a <a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api"><code>TwillApplication</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.Builder.AfterOrder.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.AfterOrder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.Builder.AfterPlacementPolicy.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.AfterPlacementPolicy</a></td>
<td class="colLast">
<div class="block">Interface to define execution order after adding placement policies.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.Builder.AfterRunnable.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.AfterRunnable</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.Builder.FirstOrder.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.FirstOrder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.Builder.LocalFileAdder.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.LocalFileAdder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.Builder.MorePlacementPolicies.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.MorePlacementPolicies</a></td>
<td class="colLast">
<div class="block">Interface to add placement policies to the application.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.Builder.MoreRunnable.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.MoreRunnable</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.Builder.NextOrder.html" title="interface in org.apache.twill.api">TwillSpecification.Builder.NextOrder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.Order.html" title="interface in org.apache.twill.api">TwillSpecification.Order</a></td>
<td class="colLast">
<div class="block">Defines execution order.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.PlacementPolicy.html" title="interface in org.apache.twill.api">TwillSpecification.PlacementPolicy</a></td>
<td class="colLast">
<div class="block">Defines a container placement policy.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/AbstractTwillRunnable.html" title="class in org.apache.twill.api">AbstractTwillRunnable</a></td>
<td class="colLast">
<div class="block">This abstract class provides default implementation of the <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/ClassAcceptor.html" title="class in org.apache.twill.api">ClassAcceptor</a></td>
<td class="colLast">
<div class="block">Class that can be used to determine if class can be accepted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/Command.Builder.html" title="class in org.apache.twill.api">Command.Builder</a></td>
<td class="colLast">
<div class="block">Builder for creating <a href="../../../../org/apache/twill/api/Command.html" title="interface in org.apache.twill.api"><code>Command</code></a> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/Configs.html" title="class in org.apache.twill.api">Configs</a></td>
<td class="colLast">
<div class="block">Defines keys and default values constants being used for configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/Configs.Defaults.html" title="class in org.apache.twill.api">Configs.Defaults</a></td>
<td class="colLast">
<div class="block">Defines default configuration values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/Configs.Keys.html" title="class in org.apache.twill.api">Configs.Keys</a></td>
<td class="colLast">
<div class="block">Defines keys being used in configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/EventHandler.html" title="class in org.apache.twill.api">EventHandler</a></td>
<td class="colLast">
<div class="block">A callback handler for acting on application events related to <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a> lifecycle events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/EventHandler.TimeoutAction.html" title="class in org.apache.twill.api">EventHandler.TimeoutAction</a></td>
<td class="colLast">
<div class="block">Represents action to act upon runnable launch timeout.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/EventHandler.TimeoutEvent.html" title="class in org.apache.twill.api">EventHandler.TimeoutEvent</a></td>
<td class="colLast">
<div class="block">This class holds information about a launch timeout event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/Hosts.html" title="class in org.apache.twill.api">Hosts</a></td>
<td class="colLast">
<div class="block">Represents a list of hosts.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/Racks.html" title="class in org.apache.twill.api">Racks</a></td>
<td class="colLast">
<div class="block">Represents a list of Racks.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/ResourceSpecification.Builder.html" title="class in org.apache.twill.api">ResourceSpecification.Builder</a></td>
<td class="colLast">
<div class="block">Builder for creating <a href="../../../../org/apache/twill/api/ResourceSpecification.html" title="interface in org.apache.twill.api"><code>ResourceSpecification</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillRunnableSpecification.Builder.html" title="class in org.apache.twill.api">TwillRunnableSpecification.Builder</a></td>
<td class="colLast">
<div class="block">Builder for constructing <a href="../../../../org/apache/twill/api/TwillRunnableSpecification.html" title="interface in org.apache.twill.api"><code>TwillRunnableSpecification</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.Builder.html" title="class in org.apache.twill.api">TwillSpecification.Builder</a></td>
<td class="colLast">
<div class="block">Builder for constructing instance of <a href="../../../../org/apache/twill/api/TwillSpecification.html" title="interface in org.apache.twill.api"><code>TwillSpecification</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/ResourceSpecification.SizeUnit.html" title="enum in org.apache.twill.api">ResourceSpecification.SizeUnit</a></td>
<td class="colLast">
<div class="block">Unit for specifying memory size.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/ServiceController.TerminationStatus.html" title="enum in org.apache.twill.api">ServiceController.TerminationStatus</a></td>
<td class="colLast">
<div class="block">Enum to represent termination status of the application when it completed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.Order.Type.html" title="enum in org.apache.twill.api">TwillSpecification.Order.Type</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/api/TwillSpecification.PlacementPolicy.Type.html" title="enum in org.apache.twill.api">TwillSpecification.PlacementPolicy.Type</a></td>
<td class="colLast">
<div class="block">Lists different types of Placement Policies available.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.twill.api Description">Package org.apache.twill.api Description</h2>
<div class="block">Classes in this package provides core functionality of the Twill library.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>Prev&nbsp;Package</li>
<li><a href="../../../../org/apache/twill/api/logging/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/twill/api/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>