Google Git
Sign in
apache / twill / refs/heads/site / . / src / site / resources / apidocs-0.14.0 / org / apache / twill / internal / package-summary.html
blob: 28a3882459a6a4599f30a81c5e71934ab94a6966 [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.internal (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.internal (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><a href="../../../../org/apache/twill/filesystem/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/twill/kafka/client/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/twill/internal/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.internal</h1>
<div class="docSummary">
<div class="block">This package provides internal classes for Twill.</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/internal/ContainerInfo.html" title="interface in org.apache.twill.internal">ContainerInfo</a></td>
<td class="colLast">
<div class="block">Represents information of the container that the processing is/will be running in.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/ProcessController.html" title="interface in org.apache.twill.internal">ProcessController</a>&lt;R&gt;</td>
<td class="colLast">
<div class="block">For controlling a launch yarn process.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/ProcessLauncher.html" title="interface in org.apache.twill.internal">ProcessLauncher</a>&lt;T extends <a href="../../../../org/apache/twill/internal/ResourceCapability.html" title="interface in org.apache.twill.internal">ResourceCapability</a>&gt;</td>
<td class="colLast">
<div class="block">Class for launching container process.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/ProcessLauncher.PrepareLaunchContext.html" title="interface in org.apache.twill.internal">ProcessLauncher.PrepareLaunchContext</a></td>
<td class="colLast">
<div class="block">For setting up the launcher.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/ResourceCapability.html" title="interface in org.apache.twill.internal">ResourceCapability</a></td>
<td class="colLast">
<div class="block">Represents information about compute resources capability.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/TwillContainerController.html" title="interface in org.apache.twill.internal">TwillContainerController</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api"><code>ServiceController</code></a> that allows sending a message directly.</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/internal/AbstractExecutionServiceController.html" title="class in org.apache.twill.internal">AbstractExecutionServiceController</a></td>
<td class="colLast">
<div class="block">An abstract base class for implementing <a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api"><code>ServiceController</code></a> that deal with Service state transition and
listener callback.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/AbstractTwillController.html" title="class in org.apache.twill.internal">AbstractTwillController</a></td>
<td class="colLast">
<div class="block">A abstract base class for <a href="../../../../org/apache/twill/api/TwillController.html" title="interface in org.apache.twill.api"><code>TwillController</code></a> implementation that uses Zookeeper to controller a
running twill application.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/AbstractTwillService.html" title="class in org.apache.twill.internal">AbstractTwillService</a></td>
<td class="colLast">
<div class="block">A base implementation of <code>Service</code> that uses ZooKeeper to transmit states and messages.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/AbstractZKServiceController.html" title="class in org.apache.twill.internal">AbstractZKServiceController</a></td>
<td class="colLast">
<div class="block">An abstract base class for implementing a <a href="../../../../org/apache/twill/api/ServiceController.html" title="interface in org.apache.twill.api"><code>ServiceController</code></a> using ZooKeeper as a means for
communicating with the remote service.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/ApplicationBundler.html" title="class in org.apache.twill.internal">ApplicationBundler</a></td>
<td class="colLast">
<div class="block">This class builds jar files based on class dependencies.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/Arguments.html" title="class in org.apache.twill.internal">Arguments</a></td>
<td class="colLast">
<div class="block">Class that encapsulate application arguments and per runnable arguments.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/BasicTwillContext.html" title="class in org.apache.twill.internal">BasicTwillContext</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../org/apache/twill/api/TwillContext.html" title="interface in org.apache.twill.api"><code>TwillContext</code></a> that provides the basic runtime information 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/internal/CompositeService.html" title="class in org.apache.twill.internal">CompositeService</a></td>
<td class="colLast">
<div class="block">A <code>Service</code> that starts/stops list of services in order.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/Constants.html" title="class in org.apache.twill.internal">Constants</a></td>
<td class="colLast">
<div class="block">This class contains collection of common constants used in Twill.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/Constants.Files.html" title="class in org.apache.twill.internal">Constants.Files</a></td>
<td class="colLast">
<div class="block">Constants for names of internal files that are shared between client, AM and containers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/ContainerExitCodes.html" title="class in org.apache.twill.internal">ContainerExitCodes</a></td>
<td class="colLast">
<div class="block">Collection of known exit code.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/ContainerLiveNodeData.html" title="class in org.apache.twill.internal">ContainerLiveNodeData</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/DefaultEventHandlerSpecification.html" title="class in org.apache.twill.internal">DefaultEventHandlerSpecification</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/DefaultLocalFile.html" title="class in org.apache.twill.internal">DefaultLocalFile</a></td>
<td class="colLast">
<div class="block">A straightforward implementation of <a href="../../../../org/apache/twill/api/LocalFile.html" title="interface in org.apache.twill.api"><code>LocalFile</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/DefaultResourceReport.html" title="class in org.apache.twill.internal">DefaultResourceReport</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../org/apache/twill/api/ResourceReport.html" title="interface in org.apache.twill.api"><code>ResourceReport</code></a> with some
additional methods for maintaining the report.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/DefaultResourceSpecification.html" title="class in org.apache.twill.internal">DefaultResourceSpecification</a></td>
<td class="colLast">
<div class="block">Straightforward implementation of <a href="../../../../org/apache/twill/api/ResourceSpecification.html" title="interface in org.apache.twill.api"><code>ResourceSpecification</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/DefaultRuntimeSpecification.html" title="class in org.apache.twill.internal">DefaultRuntimeSpecification</a></td>
<td class="colLast">
<div class="block">Straightforward implementation of <a href="../../../../org/apache/twill/api/RuntimeSpecification.html" title="interface in org.apache.twill.api"><code>RuntimeSpecification</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/DefaultTwillRunnableSpecification.html" title="class in org.apache.twill.internal">DefaultTwillRunnableSpecification</a></td>
<td class="colLast">
<div class="block">Straightforward implementation of <a href="../../../../org/apache/twill/api/TwillRunnableSpecification.html" title="interface in org.apache.twill.api"><code>TwillRunnableSpecification</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/DefaultTwillRunResources.html" title="class in org.apache.twill.internal">DefaultTwillRunResources</a></td>
<td class="colLast">
<div class="block">Straightforward implementation of <a href="../../../../org/apache/twill/api/TwillRunResources.html" title="interface in org.apache.twill.api"><code>TwillRunResources</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/DefaultTwillSpecification.html" title="class in org.apache.twill.internal">DefaultTwillSpecification</a></td>
<td class="colLast">
<div class="block">Straightforward implementation of <a href="../../../../org/apache/twill/api/TwillSpecification.html" title="interface in org.apache.twill.api"><code>TwillSpecification</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/DefaultTwillSpecification.DefaultOrder.html" title="class in org.apache.twill.internal">DefaultTwillSpecification.DefaultOrder</a></td>
<td class="colLast">
<div class="block">Straightforward implementation of <code>Order</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/DefaultTwillSpecification.DefaultPlacementPolicy.html" title="class in org.apache.twill.internal">DefaultTwillSpecification.DefaultPlacementPolicy</a></td>
<td class="colLast">
<div class="block">Straightforward implementation of <a href="../../../../org/apache/twill/api/TwillSpecification.PlacementPolicy.html" title="interface in org.apache.twill.api"><code>TwillSpecification.PlacementPolicy</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/ElectionRegistry.html" title="class in org.apache.twill.internal">ElectionRegistry</a></td>
<td class="colLast">
<div class="block">Tracks currently active leader elections within the Twill container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/EnvContainerInfo.html" title="class in org.apache.twill.internal">EnvContainerInfo</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../org/apache/twill/internal/ContainerInfo.html" title="interface in org.apache.twill.internal"><code>ContainerInfo</code></a> based on information on the environment.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/EnvKeys.html" title="class in org.apache.twill.internal">EnvKeys</a></td>
<td class="colLast">
<div class="block">Places for define common environment keys.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/JvmOptions.html" title="class in org.apache.twill.internal">JvmOptions</a></td>
<td class="colLast">
<div class="block">A class that encapsulates the different options for starting Java in containers.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/JvmOptions.DebugOptions.html" title="class in org.apache.twill.internal">JvmOptions.DebugOptions</a></td>
<td class="colLast">
<div class="block">Represents the debugging options of the JVM.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/LogOnlyEventHandler.html" title="class in org.apache.twill.internal">LogOnlyEventHandler</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/RunIds.html" title="class in org.apache.twill.internal">RunIds</a></td>
<td class="colLast">
<div class="block">Factory class for creating instance of <a href="../../../../org/apache/twill/api/RunId.html" title="interface in org.apache.twill.api"><code>RunId</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/ServiceListenerAdapter.html" title="class in org.apache.twill.internal">ServiceListenerAdapter</a></td>
<td class="colLast">
<div class="block">An adapter for implementing <code>Service.Listener</code> with all method default to no-op.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/ServiceMain.html" title="class in org.apache.twill.internal">ServiceMain</a></td>
<td class="colLast">
<div class="block">Class for main method that starts a service.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/ServiceMain.TwillZKPathService.html" title="class in org.apache.twill.internal">ServiceMain.TwillZKPathService</a></td>
<td class="colLast">
<div class="block">A simple service for creating/remove ZK paths needed for <a href="../../../../org/apache/twill/internal/AbstractTwillService.html" title="class in org.apache.twill.internal"><code>AbstractTwillService</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/Services.html" title="class in org.apache.twill.internal">Services</a></td>
<td class="colLast">
<div class="block">Utility methods for help dealing with <code>Service</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/SingleRunnableApplication.html" title="class in org.apache.twill.internal">SingleRunnableApplication</a></td>
<td class="colLast">
<div class="block">A simple <a href="../../../../org/apache/twill/api/TwillApplication.html" title="interface in org.apache.twill.api"><code>TwillApplication</code></a> that contains only one <a href="../../../../org/apache/twill/api/TwillRunnable.html" title="interface in org.apache.twill.api"><code>TwillRunnable</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/TwillContainerLauncher.html" title="class in org.apache.twill.internal">TwillContainerLauncher</a></td>
<td class="colLast">
<div class="block">This class helps launching a container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/twill/internal/TwillRuntimeSpecification.html" title="class in org.apache.twill.internal">TwillRuntimeSpecification</a></td>
<td class="colLast">
<div class="block">Represents runtime 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/internal/ZKMessages.html" title="class in org.apache.twill.internal">ZKMessages</a></td>
<td class="colLast">
<div class="block">Helper class to send messages to remote instances using Apache Zookeeper watch mechanism.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.twill.internal Description">Package org.apache.twill.internal Description</h2>
<div class="block">This package provides internal classes for Twill.</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><a href="../../../../org/apache/twill/filesystem/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/twill/kafka/client/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/twill/internal/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>