Added: uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/index-all.html
URL:
http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/index-all.html?rev=1784198&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/index-all.html
(added)
+++ uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/index-all.html Thu
Feb 23 19:30:22 2017
@@ -0,0 +1,1536 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>Index (Apache UIMA DUCC Java SDK 2.2.0
User-Level API Documentation)</title>
+<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="Index (Apache UIMA DUCC Java SDK 2.2.0
\t\t\t\t\t\t\t\tUser-Level API Documentation)";
+ }
+//-->
+</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="skip"><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>Package</li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="./overview-tree.html">Tree</a></li>
+<li><a href="./deprecated-list.html">Deprecated</a></li>
+<li class="navBarCell1Rev">Index</li>
+<li><a href="./help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="./index.html?index-all.html" target="_top">Frames</a></li>
+<li><a href="index-all.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>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="contentContainer"><a href="#_A_">A</a> <a
href="#_B_">B</a> <a href="#_C_">C</a> <a href="#_D_">D</a> <a
href="#_E_">E</a> <a href="#_F_">F</a> <a href="#_G_">G</a> <a
href="#_H_">H</a> <a href="#_I_">I</a> <a href="#_J_">J</a> <a
href="#_L_">L</a> <a href="#_M_">M</a> <a href="#_N_">N</a> <a
href="#_O_">O</a> <a href="#_P_">P</a> <a href="#_Q_">Q</a> <a
href="#_R_">R</a> <a href="#_S_">S</a> <a href="#_T_">T</a> <a
href="#_U_">U</a> <a href="#_V_">V</a> <a href="#_W_">W</a> <a
name="_A_">
+<!-- -->
+</a>
+<h2 class="title">A</h2>
+<dl>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQLoadReply.html#addClass(org.apache.uima.ducc.common.admin.event.RmQueriedClass)">addClass(RmQueriedClass)</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQLoadReply.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmAdminQLoadReply</a></dt>
+<dd>
+<div class="block">RM only, other use produces incorrect results.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#addDependency(java.lang.String,%20java.lang.String)">addDependency(String,
String)</a></span> - Method in interface
org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd>
+<div class="block">Internal to DUCC.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQOccupancyReply.html#addMachine(org.apache.uima.ducc.common.admin.event.RmQueriedMachine)">addMachine(RmQueriedMachine)</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQOccupancyReply.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmAdminQOccupancyReply</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQLoadReply.html#addNodepool(org.apache.uima.ducc.common.admin.event.RmQueriedNodepool)">addNodepool(RmQueriedNodepool)</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQLoadReply.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmAdminQLoadReply</a></dt>
+<dd>
+<div class="block">RM only, other use produces incorrect results.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#addShare(org.apache.uima.ducc.common.admin.event.RmQueriedShare)">addShare(RmQueriedShare)</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedMachine</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli"><span class="strong">AServicePing</span></a> - Class
in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd>
+<div class="block">Abstraction for service pinger.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#AServicePing()">AServicePing()</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#autostart_enabled">autostart_enabled</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">This indicates whether the service's autostart flag is
enabled or disabled.</div>
+</dd>
+</dl>
+<a name="_B_">
+<!-- -->
+</a>
+<h2 class="title">B</h2>
+<dl>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#blacklisted">blacklisted</a></span>
- Variable in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedMachine</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#blacklisted">blacklisted</a></span>
- Variable in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a></dt>
+<dd> </dd>
+</dl>
+<a name="_C_">
+<!-- -->
+</a>
+<h2 class="title">C</h2>
+<dl>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#callback">callback</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/IDuccMonitor.html#cancel()">cancel()</a></span>
- Method in interface org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/IDuccMonitor.html" title="interface in
org.apache.uima.ducc.cli">IDuccMonitor</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html#canceledPid">canceledPid</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html" title="class in
org.apache.uima.ducc.cli">DuccJobCancel</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html#canceledPid">canceledPid</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationCancel</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationCancel.html#canceledPid">canceledPid</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationCancel.html" title="class in
org.apache.uima.ducc.cli">DuccReservationCancel</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceCancel.html#canceledPid">canceledPid</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceCancel.html" title="class in
org.apache.uima.ducc.cli">DuccServiceCancel</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#check_heap_size(java.lang.String)">check_heap_size(String)</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#check_service_dependencies(java.lang.String)">check_service_dependencies(String)</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#cli_props">cli_props</a></span> -
Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli"><span class="strong">CliBase</span></a> - Class in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd>
+<div class="block">Define common methods and data used by all the DUCC API and
CLI.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#CliBase()">CliBase()</a></span> -
Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#commandLine">commandLine</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQOccupancyReply.MachineByMemorySorter.html#compare(org.apache.uima.ducc.common.admin.event.RmQueriedMachine,%20org.apache.uima.ducc.common.admin.event.RmQueriedMachine)">compare(RmQueriedMachine,
RmQueriedMachine)</a></span> - Method in class
org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQOccupancyReply.MachineByMemorySorter.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmAdminQOccupancyReply.MachineByMemorySorter</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/IDuccCallback.html#console(int,%20java.lang.String)">console(int,
String)</a></span> - Method in interface org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/IDuccCallback.html" title="interface in
org.apache.uima.ducc.cli">IDuccCallback</a></dt>
+<dd>
+<div class="block">This method is called by relevant parts of the API with
messages redirected from the remote
+ process.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#console_attach">console_attach</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#console_listener">console_listener</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#consoleCb">consoleCb</a></span> -
Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#consoleExits()">consoleExits()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#custom_only_options">custom_only_options</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/main/DuccRmAdmin.html#cypheredMessage">cypheredMessage</a></span>
- Variable in class org.apache.uima.ducc.common.main.<a
href="./org/apache/uima/ducc/common/main/DuccRmAdmin.html" title="class in
org.apache.uima.ducc.common.main">DuccRmAdmin</a></dt>
+<dd> </dd>
+</dl>
+<a name="_D_">
+<!-- -->
+</a>
+<h2 class="title">D</h2>
+<dl>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#debug">debug</a></span> -
Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#disable(java.lang.String[])">disable(String[])</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#Disable(java.lang.String[])">Disable(String[])</a></span>
- Static method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#disable_options">disable_options</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#dispatcher">dispatcher</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#doLog(java.lang.String,%20java.lang.Object...)">doLog(String,
Object...)</a></span> - Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">This is a convenience method for logging which enforces the
use of the calling
+ method name and permits use of commas to separate fields in the message.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#ducc_home">ducc_home</a></span> -
Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/uima/ducc/common/admin/event/DuccAdminEvent.html"
title="class in org.apache.uima.ducc.common.admin.event"><span
class="strong">DuccAdminEvent</span></a> - Class in <a
href="./org/apache/uima/ducc/common/admin/event/package-summary.html">org.apache.uima.ducc.common.admin.event</a></dt>
+<dd>
+<div class="block">This class provides the abstraction for requests to DUCC's
administrative interface.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/DuccAdminEvent.html#DuccAdminEvent(java.lang.String,%20byte[])">DuccAdminEvent(String,
byte[])</a></span> - Constructor for class
org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/DuccAdminEvent.html"
title="class in org.apache.uima.ducc.common.admin.event">DuccAdminEvent</a></dt>
+<dd>
+<div class="block">Create a request to send to DUCC.</div>
+</dd>
+<dt><a href="./org/apache/uima/ducc/cli/DuccJobCancel.html" title="class in
org.apache.uima.ducc.cli"><span class="strong">DuccJobCancel</span></a> - Class
in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd>
+<div class="block">Cancel a DUCC job</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html#DuccJobCancel(java.lang.String[])">DuccJobCancel(String[])</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html" title="class in
org.apache.uima.ducc.cli">DuccJobCancel</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html#DuccJobCancel(java.util.List)">DuccJobCancel(List<String>)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html" title="class in
org.apache.uima.ducc.cli">DuccJobCancel</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html#DuccJobCancel(java.util.Properties)">DuccJobCancel(Properties)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html" title="class in
org.apache.uima.ducc.cli">DuccJobCancel</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/uima/ducc/cli/DuccJobSubmit.html" title="class in
org.apache.uima.ducc.cli"><span class="strong">DuccJobSubmit</span></a> - Class
in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd>
+<div class="block">Submit a DUCC job</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html#DuccJobSubmit(java.lang.String[])">DuccJobSubmit(String[])</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccJobSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html#DuccJobSubmit(java.util.ArrayList)">DuccJobSubmit(ArrayList<String>)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccJobSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html#DuccJobSubmit(java.util.Properties)">DuccJobSubmit(Properties)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccJobSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html#DuccJobSubmit(java.util.ArrayList,%20org.apache.uima.ducc.cli.IDuccCallback)">DuccJobSubmit(ArrayList<String>,
IDuccCallback)</a></span> - Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccJobSubmit</a></dt>
+<dd>
+<div class="block">This form of the constructor allows the API user to capture
+ messages, rather than directing them to stdout.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html#DuccJobSubmit(java.lang.String[],%20org.apache.uima.ducc.cli.IDuccCallback)">DuccJobSubmit(String[],
IDuccCallback)</a></span> - Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccJobSubmit</a></dt>
+<dd>
+<div class="block">This form of the constructor allows the API user to capture
+ messages, rather than directing them to stdout.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html#DuccJobSubmit(java.util.Properties,%20org.apache.uima.ducc.cli.IDuccCallback)">DuccJobSubmit(Properties,
IDuccCallback)</a></span> - Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccJobSubmit</a></dt>
+<dd>
+<div class="block">This form of the constructor allows the API user to capture
+ messages, rather than directing them to stdout.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#duccLogger">duccLogger</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">When the pinger is run as a thread inside the SM, this
logger is used to
+ join the ping log with the SM log.</div>
+</dd>
+<dt><a href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html"
title="class in org.apache.uima.ducc.cli"><span
class="strong">DuccManagedReservationCancel</span></a> - Class in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd>
+<div class="block">Cancel a DUCC Managed Reservation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html#DuccManagedReservationCancel(java.lang.String[])">DuccManagedReservationCancel(String[])</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationCancel</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html#DuccManagedReservationCancel(java.util.List)">DuccManagedReservationCancel(List<String>)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationCancel</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html#DuccManagedReservationCancel(java.util.Properties)">DuccManagedReservationCancel(Properties)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationCancel</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html"
title="class in org.apache.uima.ducc.cli"><span
class="strong">DuccManagedReservationSubmit</span></a> - Class in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd>
+<div class="block">Submit a DUCC Managed Reservation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#DuccManagedReservationSubmit(java.lang.String[])">DuccManagedReservationSubmit(String[])</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#DuccManagedReservationSubmit(java.util.ArrayList)">DuccManagedReservationSubmit(ArrayList<String>)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#DuccManagedReservationSubmit(java.util.Properties)">DuccManagedReservationSubmit(Properties)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#DuccManagedReservationSubmit(java.lang.String[],%20org.apache.uima.ducc.cli.IDuccCallback)">DuccManagedReservationSubmit(String[],
IDuccCallback)</a></span> - Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationSubmit</a></dt>
+<dd>
+<div class="block">This form of the constructor allows the API user to capture
+ messages, rather than directing them to stdout.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#DuccManagedReservationSubmit(java.util.ArrayList,%20org.apache.uima.ducc.cli.IDuccCallback)">DuccManagedReservationSubmit(ArrayList<String>,
IDuccCallback)</a></span> - Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationSubmit</a></dt>
+<dd>
+<div class="block">This form of the constructor allows the API user to capture
+ messages, rather than directing them to stdout.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#DuccManagedReservationSubmit(java.util.Properties,%20org.apache.uima.ducc.cli.IDuccCallback)">DuccManagedReservationSubmit(Properties,
IDuccCallback)</a></span> - Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationSubmit</a></dt>
+<dd>
+<div class="block">This form of the constructor allows the API user to capture
+ messages, rather than directing them to stdout.</div>
+</dd>
+<dt><a href="./org/apache/uima/ducc/cli/DuccReservationCancel.html"
title="class in org.apache.uima.ducc.cli"><span
class="strong">DuccReservationCancel</span></a> - Class in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd>
+<div class="block">Cancel a DUCC reservation</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationCancel.html#DuccReservationCancel(java.lang.String[])">DuccReservationCancel(String[])</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationCancel.html" title="class in
org.apache.uima.ducc.cli">DuccReservationCancel</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationCancel.html#DuccReservationCancel(java.util.List)">DuccReservationCancel(List<String>)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationCancel.html" title="class in
org.apache.uima.ducc.cli">DuccReservationCancel</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationCancel.html#DuccReservationCancel(java.util.Properties)">DuccReservationCancel(Properties)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationCancel.html" title="class in
org.apache.uima.ducc.cli">DuccReservationCancel</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html"
title="class in org.apache.uima.ducc.cli"><span
class="strong">DuccReservationSubmit</span></a> - Class in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd>
+<div class="block">Submit a DUCC reservation</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html#DuccReservationSubmit(java.lang.String[])">DuccReservationSubmit(String[])</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccReservationSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html#DuccReservationSubmit(java.util.ArrayList)">DuccReservationSubmit(ArrayList<String>)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccReservationSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html#DuccReservationSubmit(java.util.Properties)">DuccReservationSubmit(Properties)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccReservationSubmit</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/uima/ducc/common/main/DuccRmAdmin.html" title="class
in org.apache.uima.ducc.common.main"><span
class="strong">DuccRmAdmin</span></a> - Class in <a
href="./org/apache/uima/ducc/common/main/package-summary.html">org.apache.uima.ducc.common.main</a></dt>
+<dd>
+<div class="block">This class provides the API and CLI to the Resource
Managager administrative functions.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/main/DuccRmAdmin.html#DuccRmAdmin(org.apache.camel.CamelContext,%20java.lang.String)">DuccRmAdmin(CamelContext,
String)</a></span> - Constructor for class org.apache.uima.ducc.common.main.<a
href="./org/apache/uima/ducc/common/main/DuccRmAdmin.html" title="class in
org.apache.uima.ducc.common.main">DuccRmAdmin</a></dt>
+<dd>
+<div class="block">Creates a new instance of the RM administrative
interface.</div>
+</dd>
+<dt><a href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli"><span class="strong">DuccServiceApi</span></a> -
Class in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd>
+<div class="block">Handle registered services.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#DuccServiceApi(org.apache.uima.ducc.cli.IDuccCallback)">DuccServiceApi(IDuccCallback)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/uima/ducc/cli/DuccServiceCancel.html" title="class
in org.apache.uima.ducc.cli"><span class="strong">DuccServiceCancel</span></a>
- Class in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd>
+<div class="block">Cancel a DUCC service instance.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceCancel.html#DuccServiceCancel(java.lang.String[])">DuccServiceCancel(String[])</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceCancel.html" title="class in
org.apache.uima.ducc.cli">DuccServiceCancel</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceCancel.html#DuccServiceCancel(java.util.List)">DuccServiceCancel(List<String>)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceCancel.html" title="class in
org.apache.uima.ducc.cli">DuccServiceCancel</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceCancel.html#DuccServiceCancel(java.util.Properties)">DuccServiceCancel(Properties)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceCancel.html" title="class in
org.apache.uima.ducc.cli">DuccServiceCancel</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/uima/ducc/cli/DuccServiceSubmit.html" title="class
in org.apache.uima.ducc.cli"><span class="strong">DuccServiceSubmit</span></a>
- Class in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd>
+<div class="block">Submit a DUCC service.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceSubmit.html#DuccServiceSubmit(java.lang.String[])">DuccServiceSubmit(String[])</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccServiceSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceSubmit.html#DuccServiceSubmit(java.util.ArrayList)">DuccServiceSubmit(ArrayList<String>)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccServiceSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceSubmit.html#DuccServiceSubmit(java.util.Properties)">DuccServiceSubmit(Properties)</a></span>
- Constructor for class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccServiceSubmit</a></dt>
+<dd> </dd>
+</dl>
+<a name="_E_">
+<!-- -->
+</a>
+<h2 class="title">E</h2>
+<dl>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#enable(java.lang.String[])">enable(String[])</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#Enable(java.lang.String[])">Enable(String[])</a></span>
- Static method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#enable_options">enable_options</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#endpoint">endpoint</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html#enrich_parameters_for_debug(java.util.Properties)">enrich_parameters_for_debug(Properties)</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccJobSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceSubmit.html#enrich_parameters_for_debug(java.util.Properties)">enrich_parameters_for_debug(Properties)</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccServiceSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#errors">errors</a></span> -
Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#evicted">evicted</a></span>
- Variable in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#execute()">execute()</a></span> -
Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd>
+<div class="block">All extenders must implement execute - this method does
whatever processing on the input
+ is needed and passes the CLI request to the internal DUCC processes.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html#execute()">execute()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html" title="class in
org.apache.uima.ducc.cli">DuccJobCancel</a></dt>
+<dd>
+<div class="block">Execute collects the parameters for job cancelation and
sends them to the DUCC Orchestrator
+ to effect the cancelation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html#execute()">execute()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccJobSubmit</a></dt>
+<dd>
+<div class="block">Execute collects the job parameters, does basic error and
correctness checking, and sends
+ the job properties to the DUCC orchestrator for execution.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html#execute()">execute()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationCancel</a></dt>
+<dd>
+<div class="block">Execute collects the parameters for job cancellation and
sends them to the DUCC Orchestrator
+ to effect the cancellation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html#execute()">execute()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationSubmit</a></dt>
+<dd>
+<div class="block">Execute collects the job parameters, does basic error and
correctness checking, and sends
+ the job properties to the DUCC orchestrator for execution.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationCancel.html#execute()">execute()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationCancel.html" title="class in
org.apache.uima.ducc.cli">DuccReservationCancel</a></dt>
+<dd>
+<div class="block">Execute collects the parameters for reservation cancelation
and sends them to the DUCC Orchestrator
+ to effect the cancelation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html#execute()">execute()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccReservationSubmit</a></dt>
+<dd>
+<div class="block">Execute collects the parameters for the reservation and
sends them to the DUCC Orchestrator
+ to schedule the reservation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#execute()">execute()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceCancel.html#execute()">execute()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceCancel.html" title="class in
org.apache.uima.ducc.cli">DuccServiceCancel</a></dt>
+<dd>
+<div class="block">Execute collects the parameters for job cancelation and
sends them to the DUCC Orchestrator
+ to effect the cancelation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceSubmit.html#execute()">execute()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccServiceSubmit</a></dt>
+<dd>
+<div class="block">Execute collects the service parameters, does basic error
and correctness checking, and sends
+ the job properties to the DUCC orchestrator for execution.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#extractReply(org.apache.uima.ducc.transport.event.AbstractDuccOrchestratorEvent)">extractReply(AbstractDuccOrchestratorEvent)</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd>
+<div class="block">Extract messages and job pid from reply.</div>
+</dd>
+</dl>
+<a name="_F_">
+<!-- -->
+</a>
+<h2 class="title">F</h2>
+<dl>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#failure_cursor">failure_cursor</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#failure_max">failure_max</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">This is the total number of instance failures allowed
within the failure window.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#failure_window">failure_window</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#failure_window_period">failure_window_period</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">This is the time, in minutes, over which the failure window
is implemented.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#failure_window_size">failure_window_size</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/main/DuccRmAdmin.html#FileSeparator">FileSeparator</a></span>
- Static variable in class org.apache.uima.ducc.common.main.<a
href="./org/apache/uima/ducc/common/main/DuccRmAdmin.html" title="class in
org.apache.uima.ducc.common.main">DuccRmAdmin</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#fixed">fixed</a></span>
- Variable in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#format_reply(org.apache.uima.ducc.cli.IUiOptions.UiOption,%20org.apache.uima.ducc.transport.event.sm.IServiceReply)">format_reply(IUiOptions.UiOption,
IServiceReply)</a></span> - Static method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#friendlyId">friendlyId</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+</dl>
+<a name="_G_">
+<!-- -->
+</a>
+<h2 class="title">G</h2>
+<dl>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#getAdditions()">getAdditions()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">
+ Called by the service manager to query the number of additional needed
service instances.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getAllMachines()">getAllMachines()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedNodepool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/DuccAdminEvent.html#getAuthBlock()">getAuthBlock()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/DuccAdminEvent.html"
title="class in org.apache.uima.ducc.common.admin.event">DuccAdminEvent</a></dt>
+<dd>
+<div class="block">Return the authentication block for the request.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedClass.html#getAwarded()">getAwarded()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedClass.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedClass</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getBroker()">getBroker()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#getCallback()">getCallback()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html#getCanceledPid()">getCanceledPid()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html" title="class in
org.apache.uima.ducc.cli">DuccJobCancel</a></dt>
+<dd>
+<div class="block">If a specific process, rather than the entire job, is
canceled.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQLoadReply.html#getClasses()">getClasses()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQLoadReply.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmAdminQLoadReply</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getDead()">getDead()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedNodepool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#getDeletions()">getDeletions()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">
+ Called by the service manager to retrieve the specific service instances
+ to stop.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedClass.html#getDemanded()">getDemanded()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedClass.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedClass</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getDependencies()">getDependencies()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getDisableReason()">getDisableReason()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#getDuccId()">getDuccId()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd>
+<div class="block">This returns the unique numeric id for the requested
work.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html#getDuccId()">getDuccId()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccJobSubmit</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getEndpoint()">getEndpoint()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceReply.html#getEndpoint()">getEndpoint()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceReply.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceReply</a></dt>
+<dd>
+<div class="block">This returns the service endpoint that was operated
upon.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getErrorString()">getErrorString()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getFreeMachines()">getFreeMachines()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedNodepool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html#getHost()">getHost()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccReservationSubmit</a></dt>
+<dd>
+<div class="block">If the reservation is granted, this method returns the
reserved host</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html#getHosts()">getHosts()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccReservationSubmit</a></dt>
+<dd>
+<div class="block"><span class="strong">Deprecated.</span></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html#getHostsAsString()">getHostsAsString()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccReservationSubmit</a></dt>
+<dd>
+<div class="block"><span class="strong">Deprecated.</span></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#getId()">getId()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedMachine</a></dt>
+<dd>
+<div class="block">Returns the name of the machin.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#getId()">getId()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getId()">getId()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd>
+<div class="block">This returns the Unique ID of the service as assigned by
DUCC.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceReply.html#getId()">getId()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceReply.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceReply</a></dt>
+<dd>
+<div class="block">Return the uniqud numeric ID assigned by the service
manager for this service.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getImplementors()">getImplementors()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd>
+<div class="block">This returns the set of DUCC Ids for all the service
instances which
+ implement this service.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/IServiceStatistics.html#getInfo()">getInfo()</a></span>
- Method in interface org.apache.uima.ducc.common.<a
href="./org/apache/uima/ducc/common/IServiceStatistics.html" title="interface
in org.apache.uima.ducc.common">IServiceStatistics</a></dt>
+<dd>
+<div class="block">Return service statistics, if any.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getInstanceIds()">getInstanceIds()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd>
+<div class="block">This returns the list of contant instance ids for
multi-instance services.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getInstances()">getInstances()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd>
+<div class="block">Internal to DUCC.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#getInvestmentInit()">getInvestmentInit()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#getInvestmentRt()">getInvestmentRt()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#getJobId()">getJobId()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getJobState()">getJobState()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getLastPing()">getLastPing()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getLastPingString()">getLastPingString()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getLastRunnable()">getLastRunnable()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getLastRunnableString()">getLastRunnableString()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#getLastUse()">getLastUse()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">
+ Pingers may track when a service was last used.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getLastUse()">getLastUse()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getLastUseString()">getLastUseString()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getLinger()">getLinger()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd>
+<div class="block">Internal to DUCC.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#getLogDirectory()">getLogDirectory()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/main/DuccRmAdmin.html#getLogger()">getLogger()</a></span>
- Method in class org.apache.uima.ducc.common.main.<a
href="./org/apache/uima/ducc/common/main/DuccRmAdmin.html" title="class in
org.apache.uima.ducc.common.main">DuccRmAdmin</a></dt>
+<dd>
+<div class="block">This provides direct access to the logger for the
class.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQOccupancyReply.html#getMachines()">getMachines()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQOccupancyReply.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmAdminQOccupancyReply</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#getMemory()">getMemory()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedMachine</a></dt>
+<dd>
+<div class="block">Returns the amount of RAM in KB (kilobytes) on the
machine.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmAdminReply.html#getMessage()">getMessage()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmAdminReply.html" title="class
in org.apache.uima.ducc.common.admin.event">RmAdminReply</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceReply.html#getMessage()">getMessage()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceReply.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceReply</a></dt>
+<dd>
+<div class="block">If there was an informational or error message associated
with the action, this
+ method is used to return it.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#getModifyOptions()">getModifyOptions()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedClass.html#getName()">getName()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedClass.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedClass</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getName()">getName()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedNodepool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQLoadReply.html#getNodepools()">getNodepools()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQLoadReply.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmAdminQLoadReply</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmAdminVaryOff.html#getNodes()">getNodes()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmAdminVaryOff.html"
title="class in org.apache.uima.ducc.common.admin.event">RmAdminVaryOff</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmAdminVaryOn.html#getNodes()">getNodes()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmAdminVaryOn.html"
title="class in org.apache.uima.ducc.common.admin.event">RmAdminVaryOn</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getOffline()">getOffline()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedNodepool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getOnline()">getOnline()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedNodepool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getOnlineMachines()">getOnlineMachines()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedNodepool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedClass.html#getPolicy()">getPolicy()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedClass.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedClass</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getQstats()">getQstats()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getQueueStatistics()">getQueueStatistics()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmAdminReply.html#getRc()">getRc()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmAdminReply.html" title="class
in org.apache.uima.ducc.common.admin.event">RmAdminReply</a></dt>
+<dd>
+<div class="block">Returns success or failure status.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getReferences()">getReferences()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getRegistrationDate()">getRegistrationDate()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html#getResponseMessage()">getResponseMessage()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobCancel.html" title="class in
org.apache.uima.ducc.cli">DuccJobCancel</a></dt>
+<dd>
+<div class="block">Return the DUCC Orchestrator message, if any, pertaining to
the cancelation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html#getResponseMessage()">getResponseMessage()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccManagedReservationCancel.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationCancel</a></dt>
+<dd>
+<div class="block">Return the DUCC Orchestrator message, if any, pertaining to
the cancelation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccReservationCancel.html#getResponseMessage()">getResponseMessage()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccReservationCancel.html" title="class in
org.apache.uima.ducc.cli">DuccReservationCancel</a></dt>
+<dd>
+<div class="block">Return the DUCC Orchestrator message, if any, pertaining to
the cancelation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceCancel.html#getResponseMessage()">getResponseMessage()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceCancel.html" title="class in
org.apache.uima.ducc.cli">DuccServiceCancel</a></dt>
+<dd>
+<div class="block">Return the DUCC Orchestrator message, if any, pertaining to
the cancelation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#getReturnCode()">getReturnCode()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd>
+<div class="block">This returns the return code from the execution of the
requested work.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html#getReturnCode()">getReturnCode()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccJobSubmit.html" title="class in
org.apache.uima.ducc.cli">DuccJobSubmit</a></dt>
+<dd>
+<div class="block">Return appropriate rc when job has completed.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceReply.html#getReturnCode()">getReturnCode()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceReply.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceReply</a></dt>
+<dd>
+<div class="block">This method indicates whether the associated services verb
was successful.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceReply.html#getServiceDescriptions()">getServiceDescriptions()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceReply.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceReply</a></dt>
+<dd>
+<div class="block">This returns null for non-query events.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getServiceState()">getServiceState()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#getShareOrder()">getShareOrder()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedMachine</a></dt>
+<dd>
+<div class="block">Returns the share order of the machine.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#getShareOrder()">getShareOrder()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQLoadReply.html#getShareQuantum()">getShareQuantum()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmAdminQLoadReply.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmAdminQLoadReply</a></dt>
+<dd>
+<div class="block">Return the share quantum currently being used by RM.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#getShares()">getShares()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedMachine</a></dt>
+<dd>
+<div class="block">Return the list of shares scheduled to this host.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getSharesAvailable()">getSharesAvailable()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedNodepool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getSharesFree()">getSharesFree()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedNodepool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#getSmState()">getSmState()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">
+ Getter of the service state; Implementors may just access it directly if
they want.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#getStatistics()">getStatistics()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">Returns the object with application-derived health and
statistics.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getSubclass()">getSubclass()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getType()">getType()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/IDuccMonitor.html#getUrl(java.lang.String)">getUrl(String)</a></span>
- Method in interface org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/IDuccMonitor.html" title="interface in
org.apache.uima.ducc.cli">IDuccMonitor</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/DuccAdminEvent.html#getUser()">getUser()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/DuccAdminEvent.html"
title="class in org.apache.uima.ducc.common.admin.event">DuccAdminEvent</a></dt>
+<dd>
+<div class="block">Return the id of the user making the request.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#getUser()">getUser()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd>
+<div class="block">Get the owner of the service</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#getVerb(java.lang.String[])">getVerb(String[])</a></span>
- Static method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html#getVirtualMachines()">getVirtualMachines()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedNodepool.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedNodepool</a></dt>
+<dd> </dd>
+</dl>
+<a name="_H_">
+<!-- -->
+</a>
+<h2 class="title">H</h2>
+<dl>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#help()">help()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#Help()">Help()</a></span>
- Static method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#host_address">host_address</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+</dl>
+<a name="_I_">
+<!-- -->
+</a>
+<h2 class="title">I</h2>
+<dl>
+<dt><a href="./org/apache/uima/ducc/cli/IDuccCallback.html" title="interface
in org.apache.uima.ducc.cli"><span class="strong">IDuccCallback</span></a> -
Interface in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/uima/ducc/cli/IDuccMonitor.html" title="interface in
org.apache.uima.ducc.cli"><span class="strong">IDuccMonitor</span></a> -
Interface in <a
href="./org/apache/uima/ducc/cli/package-summary.html">org.apache.uima.ducc.cli</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#ignore_options">ignore_options</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#ignoreReferences(java.lang.String[])">ignoreReferences(String[])</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html#IgnoreReferences(java.lang.String[])">IgnoreReferences(String[])</a></span>
- Static method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/DuccServiceApi.html" title="class in
org.apache.uima.ducc.cli">DuccServiceApi</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#inhibitDefaults()">inhibitDefaults()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#init(java.lang.String,%20java.lang.String)">init(String,
String)</a></span> - Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">Called by the ping driver, to pass in useful things the
pinger may want.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#init(java.lang.String,%20java.lang.String,%20java.util.Map)">init(String,
String, Map<String, Object>)</a></span> - Method in class
org.apache.uima.ducc.cli.<a href="./org/apache/uima/ducc/cli/AServicePing.html"
title="class in org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">
+ Called by the ping driver to initialize static information about the service
and
+ pinger.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String,%20org.apache.uima.ducc.cli.IUiOptions.UiOption[],%20java.lang.String[],%20org.apache.uima.ducc.common.utils.DuccProperties,%20org.apache.uima.ducc.cli.IDuccCallback)">init(String,
IUiOptions.UiOption[], String[], DuccProperties, IDuccCallback)</a></span> -
Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd>
+<div class="block">Standard init for all except the Service calls that are
sent to the SM</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String,%20org.apache.uima.ducc.cli.IUiOptions.UiOption[],%20java.util.Properties,%20org.apache.uima.ducc.common.utils.DuccProperties,%20org.apache.uima.ducc.cli.IDuccCallback)">init(String,
IUiOptions.UiOption[], Properties, DuccProperties, IDuccCallback)</a></span> -
Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String,%20org.apache.uima.ducc.cli.IUiOption[],%20java.lang.String[],%20java.util.Properties,%20org.apache.uima.ducc.common.utils.DuccProperties,%20org.apache.uima.ducc.cli.IDuccCallback,%20java.lang.String)">init(String,
IUiOption[], String[], Properties, DuccProperties, IDuccCallback,
String)</a></span> - Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#initConsoleListener()">initConsoleListener()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd>
+<div class="block">Needs to be done before submitting the job because the job
needs the ports.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#initializationState">initializationState</a></span>
- Variable in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">This is a map containing the initialization state for the
service, passed in only
+ once, during pinger initialization.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#initialized">initialized</a></span>
- Variable in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#investmentInit">investmentInit</a></span>
- Variable in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html#investmentRt">investmentRt</a></span>
- Variable in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedShare.html"
title="class in org.apache.uima.ducc.common.admin.event">RmQueriedShare</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#isActive()">isActive()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/IServiceStatistics.html#isAlive()">isAlive()</a></span>
- Method in interface org.apache.uima.ducc.common.<a
href="./org/apache/uima/ducc/common/IServiceStatistics.html" title="interface
in org.apache.uima.ducc.common">IServiceStatistics</a></dt>
+<dd>
+<div class="block">Query whether the service is alive.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/AServicePing.html#isAutostart()">isAutostart()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/AServicePing.html" title="class in
org.apache.uima.ducc.cli">AServicePing</a></dt>
+<dd>
+<div class="block">
+ The SM queries the ping/monitors autostart on return from each ping.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html#isAutostart()">isAutostart()</a></span>
- Method in interface org.apache.uima.ducc.transport.event.sm.<a
href="./org/apache/uima/ducc/transport/event/sm/IServiceDescription.html"
title="interface in
org.apache.uima.ducc.transport.event.sm">IServiceDescription</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html#isBlacklisted()">isBlacklisted()</a></span>
- Method in class org.apache.uima.ducc.common.admin.event.<a
href="./org/apache/uima/ducc/common/admin/event/RmQueriedMachine.html"
title="class in
org.apache.uima.ducc.common.admin.event">RmQueriedMachine</a></dt>
+<dd>
+<div class="block">Returns whether the machine is blacklisted.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/uima/ducc/cli/CliBase.html#isConsoleAttached()">isConsoleAttached()</a></span>
- Method in class org.apache.uima.ducc.cli.<a
href="./org/apache/uima/ducc/cli/CliBase.html" title="class in
org.apache.uima.ducc.cli">CliBase</a></dt>
+<dd>
+<div class="block">This is used to find if the remote console is redirected to
the local process, and if so, is it still
+ active.</div>
+</dd>
[... 773 lines stripped ...]
Propchange:
uima/site/trunk/uima-website/docs/d/uima-ducc-2.2.0/api/index-all.html
------------------------------------------------------------------------------
svn:eol-style = native
