Added:
uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/CliBase.html
URL:
http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/CliBase.html?rev=1858151&view=auto
==============================================================================
---
uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/CliBase.html
(added)
+++
uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/CliBase.html
Thu Apr 25 17:32:43 2019
@@ -0,0 +1,1102 @@
+<!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 -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>CliBase (Apache UIMA DUCC Java SDK 3.0.0
User-Level API Documentation)</title>
+<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="CliBase (Apache UIMA DUCC Java SDK 3.0.0
\t\t\t\t\t\t\t\tUser-Level API Documentation)";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods =
{"i0":10,"i1":10,"i2":10,"i3":6,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance
Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div role="navigation" title ="TOP_Navigation" aria-label ="Top Navigation
Bar"/>
+<div class="topNav"><a name="navbar.top">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation
links">Skip navigation links</a></div>
+<a name="navbar.top.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/CliBase.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/uima/ducc/cli/AServicePing.html"
title="class in org.apache.uima.ducc.cli"><span
class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/ducc/cli/DuccJobCancel.html"
title="class in org.apache.uima.ducc.cli"><span
class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/ducc/cli/CliBase.html"
target="_top">Frames</a></li>
+<li><a href="CliBase.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div role="main" title ="CliBase" aria-labelledby ="Header1"/>
+<div class="header">
+<div class="subTitle">org.apache.uima.ducc.cli</div>
+<h2 title="Class CliBase" class="title" id="Header1">Class CliBase</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">java.lang.Object</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.uima.ducc.cli.CliBase</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd>org.apache.uima.ducc.cli.IUiOptions</dd>
+</dl>
+<dl>
+<dt>Direct Known Subclasses:</dt>
+<dd><a href="../../../../../org/apache/uima/ducc/cli/DuccJobCancel.html"
title="class in org.apache.uima.ducc.cli">DuccJobCancel</a>, <a
href="../../../../../org/apache/uima/ducc/cli/DuccJobSubmit.html" title="class
in org.apache.uima.ducc.cli">DuccJobSubmit</a>, <a
href="../../../../../org/apache/uima/ducc/cli/DuccManagedReservationCancel.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationCancel</a>, <a
href="../../../../../org/apache/uima/ducc/cli/DuccManagedReservationSubmit.html"
title="class in org.apache.uima.ducc.cli">DuccManagedReservationSubmit</a>, <a
href="../../../../../org/apache/uima/ducc/cli/DuccReservationCancel.html"
title="class in org.apache.uima.ducc.cli">DuccReservationCancel</a>, <a
href="../../../../../org/apache/uima/ducc/cli/DuccReservationSubmit.html"
title="class in org.apache.uima.ducc.cli">DuccReservationSubmit</a>, <a
href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html" title="class
in org.apache.uima.ducc.cli">DuccServi
ceApi</a>, <a
href="../../../../../org/apache/uima/ducc/cli/DuccServiceCancel.html"
title="class in org.apache.uima.ducc.cli">DuccServiceCancel</a>, <a
href="../../../../../org/apache/uima/ducc/cli/DuccServiceSubmit.html"
title="class in org.apache.uima.ducc.cli">DuccServiceSubmit</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public abstract class <span class="typeNameLabel">CliBase</span>
+extends <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a>
+implements org.apache.uima.ducc.cli.IUiOptions</pre>
+<div class="block">Define common methods and data used by all the DUCC API and
CLI.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="nested.class.summary">
+<!-- -->
+</a>
+<h3>Nested Class Summary</h3>
+<ul class="blockList">
+<li class="blockList"><a
name="nested.classes.inherited.from.class.org.apache.uima.ducc.cli.IUiOptions">
+<!-- -->
+</a>
+<h3>Nested classes/interfaces inherited from
interface org.apache.uima.ducc.cli.IUiOptions</h3>
+<code>org.apache.uima.ducc.cli.IUiOptions.UiOption</code></li>
+</ul>
+</li>
+</ul>
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0"
summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected
org.apache.uima.ducc.common.utils.DuccProperties</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#cli_props">cli_props</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected
org.apache.uima.ducc.cli.CommandLine</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#commandLine">commandLine</a></span></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#console_attach">console_attach</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected
org.apache.uima.ducc.cli.ConsoleListener</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#console_listener">console_listener</a></span></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected <a
href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html"
title="interface in org.apache.uima.ducc.cli">IDuccCallback</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#consoleCb">consoleCb</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#debug">debug</a></span></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected
org.apache.uima.ducc.transport.dispatcher.IDuccEventDispatcher</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#dispatcher">dispatcher</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#ducc_home">ducc_home</a></span></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true";
title="class or interface in java.util">ArrayList</a><<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#errors">errors</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected long</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#friendlyId">friendlyId</a></span></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#host_address">host_address</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true";
title="class or interface in java.util">ArrayList</a><<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#messages">messages</a></span></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected
org.apache.uima.ducc.cli.MonitorListener</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#monitor_listener">monitor_listener</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#returnCode">returnCode</a></span></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#suppress_console_log">suppress_console_log</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true";
title="class or interface in java.util">Properties</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#userSpecifiedProperties">userSpecifiedProperties</a></span></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CountDownLatch.html?is-external=true";
title="class or interface in
java.util.concurrent">CountDownLatch</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#waiter">waiter</a></span></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true";
title="class or interface in java.util">ArrayList</a><<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#warnings">warnings</a></span></code> </td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a
name="fields.inherited.from.class.org.apache.uima.ducc.cli.IUiOptions">
+<!-- -->
+</a>
+<h3>Fields inherited from
interface org.apache.uima.ducc.cli.IUiOptions</h3>
+<code>help_width</code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0"
summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#CliBase--">CliBase</a></span>()</code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0"
summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span
class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a
href="javascript:show(2);">Instance Methods</a></span><span
class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a
href="javascript:show(4);">Abstract Methods</a></span><span
class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a
href="javascript:show(8);">Concrete Methods</a></span><span
class="tabEnd"> </span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>(package private) void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#check_heap_size-java.lang.String-">check_heap_size</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in
java.lang">String</a> argsOption)</code> </td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>(package private) boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#check_service_dependencies-java.lang.String-">check_service_dependencies</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in
java.lang">String</a> endpoint)</code> </td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>(package private) void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#consoleExits--">consoleExits</a></span>()</code> </td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>abstract boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#execute--">execute</a></span>()</code>
+<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>
+</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code>(package private) boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#extractReply-org.apache.uima.ducc.transport.event.AbstractDuccOrchestratorEvent-">extractReply</a></span>(org.apache.uima.ducc.transport.event.AbstractDuccOrchestratorEvent reply)</code>
+<div class="block">Extract messages and job pid from reply.</div>
+</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>protected <a
href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html"
title="interface in org.apache.uima.ducc.cli">IDuccCallback</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getCallback--">getCallback</a></span>()</code> </td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getDuccId--">getDuccId</a></span>()</code>
+<div class="block">This returns the unique numeric id for the requested
work.</div>
+</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code>(package private) <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getLogDirectory-java.lang.String-">getLogDirectory</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in
java.lang">String</a> working_directory)</code> </td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getReturnCode--">getReturnCode</a></span>()</code>
+<div class="block">This returns the return code from the execution of the
requested work.</div>
+</td>
+</tr>
+<tr id="i9" class="rowColor">
+<td class="colFirst"><code>(package private) <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getWorkingDirectory--">getWorkingDirectory</a></span>()</code> </td>
+</tr>
+<tr id="i10" class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#inhibitDefaults--">inhibitDefaults</a></span>()</code> </td>
+</tr>
+<tr id="i11" class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init-java.lang.String-org.apache.uima.ducc.cli.IUiOption:A-java.lang.String:A-java.util.Properties-org.apache.uima.ducc.common.utils.DuccProperties-org.apache.uima.ducc.cli.IDuccCallback-java.lang.String-">init</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> myClassName,
+ org.apache.uima.ducc.cli.IUiOption[] uiOpts,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>[] args,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true";
title="class or interface in java.util">Properties</a> props,
+ org.apache.uima.ducc.common.utils.DuccProperties cli_props,
+ <a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html"
title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in
java.lang">String</a> servlet)</code> </td>
+</tr>
+<tr id="i12" class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init-java.lang.String-org.apache.uima.ducc.cli.IUiOptions.UiOption:A-java.util.Properties-org.apache.uima.ducc.common.utils.DuccProperties-org.apache.uima.ducc.cli.IDuccCallback-">init</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> myClassName,
+ org.apache.uima.ducc.cli.IUiOptions.UiOption[] opts,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true";
title="class or interface in java.util">Properties</a> props,
+ org.apache.uima.ducc.common.utils.DuccProperties cli_props,
+ <a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html"
title="interface in
org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb)</code> </td>
+</tr>
+<tr id="i13" class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init-java.lang.String-org.apache.uima.ducc.cli.IUiOptions.UiOption:A-java.lang.String:A-org.apache.uima.ducc.common.utils.DuccProperties-org.apache.uima.ducc.cli.IDuccCallback-">init</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> myClassName,
+ org.apache.uima.ducc.cli.IUiOptions.UiOption[] opts,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>[] args,
+ org.apache.uima.ducc.common.utils.DuccProperties cli_props,
+ <a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html"
title="interface in
org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb)</code> </td>
+</tr>
+<tr id="i14" class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#initConsoleListener--">initConsoleListener</a></span>()</code> </td>
+</tr>
+<tr id="i15" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#isConsoleAttached--">isConsoleAttached</a></span>()</code>
+<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>
+</td>
+</tr>
+<tr id="i16" class="altColor">
+<td class="colFirst"><code>(package private) void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#message-java.lang.String...-">message</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>... e)</code> </td>
+</tr>
+<tr id="i17" class="rowColor">
+<td class="colFirst"><code>(package private) void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#monitorExits-int-">monitorExits</a></span>(int rc)</code> </td>
+</tr>
+<tr id="i18" class="altColor">
+<td class="colFirst"><code>(package private) void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#saveSpec-java.lang.String-org.apache.uima.ducc.common.utils.DuccProperties-">saveSpec</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
+
org.apache.uima.ducc.common.utils.DuccProperties props)</code> </td>
+</tr>
+<tr id="i19" class="rowColor">
+<td class="colFirst"><code>(package private) void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setDefaults-org.apache.uima.ducc.cli.IUiOption:A-boolean-">setDefaults</a></span>(org.apache.uima.ducc.cli.IUiOption[] uiOpts,
+ boolean suppress_console)</code> </td>
+</tr>
+<tr id="i20" class="altColor">
+<td class="colFirst"><code>(package private) void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setOptions-org.apache.uima.ducc.cli.IUiOption:A-">setOptions</a></span>(org.apache.uima.ducc.cli.IUiOption[] uiOpts)</code> </td>
+</tr>
+<tr id="i21" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setProperty-java.lang.String-java.lang.String-">setProperty</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> key,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> value)</code>
+<div class="block">Set a property via the API.</div>
+</td>
+</tr>
+<tr id="i22" class="altColor">
+<td class="colFirst"><code>(package private) void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setUser--">setUser</a></span>()</code> </td>
+</tr>
+<tr id="i23" class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startConsoleListener-boolean-">startConsoleListener</a></span>(boolean start_stdin)</code> </td>
+</tr>
+<tr id="i24" class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startMonitor-org.apache.uima.ducc.transport.event.IDuccContext.DuccContext-">startMonitor</a></span>(org.apache.uima.ducc.transport.event.IDuccContext.DuccContext context)</code> </td>
+</tr>
+<tr id="i25" class="rowColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startMonitors-boolean-org.apache.uima.ducc.transport.event.IDuccContext.DuccContext-">startMonitors</a></span>(boolean start_stdin,
+
org.apache.uima.ducc.transport.event.IDuccContext.DuccContext context)</code> </td>
+</tr>
+<tr id="i26" class="altColor">
+<td class="colFirst"><code>protected void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#stopListeners--">stopListeners</a></span>()</code> </td>
+</tr>
+<tr id="i27" class="rowColor">
+<td class="colFirst"><code>(package private) void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#usage-java.lang.String-">usage</a></span>(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in
java.lang">String</a> message)</code> </td>
+</tr>
+<tr id="i28" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/uima/ducc/cli/CliBase.html#waitForCompletion--">waitForCompletion</a></span>()</code>
+<div class="block">Wait for the listeners - maybe a console listener, maybe a
job listener, maybe both.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class java.lang.<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true";
title="class or interface in java.lang">Object</a></h3>
+<code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--";
title="class or interface in java.lang">clone</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-";
title="class or interface in java.lang">equals</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--";
title="class or interface in java.lang">finalize</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--";
title="class or interface in java.lang">getClass</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--";
title="class or interface in java.lang">hashCode</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--";
title="class or interface in java.lang">notify</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang
/Object.html?is-external=true#notifyAll--" title="class or interface in
java.lang">notifyAll</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--";
title="class or interface in java.lang">toString</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--";
title="class or interface in java.lang">wait</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-";
title="class or interface in java.lang">wait</a>, <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-";
title="class or interface in java.lang">wait</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field.detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="ducc_home">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>ducc_home</h4>
+<pre>protected <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> ducc_home</pre>
+</li>
+</ul>
+<a name="dispatcher">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>dispatcher</h4>
+<pre>protected org.apache.uima.ducc.transport.dispatcher.IDuccEventDispatcher
dispatcher</pre>
+</li>
+</ul>
+<a name="commandLine">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>commandLine</h4>
+<pre>protected org.apache.uima.ducc.cli.CommandLine commandLine</pre>
+</li>
+</ul>
+<a name="friendlyId">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>friendlyId</h4>
+<pre>protected long friendlyId</pre>
+</li>
+</ul>
+<a name="returnCode">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>returnCode</h4>
+<pre>protected int returnCode</pre>
+</li>
+</ul>
+<a name="cli_props">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>cli_props</h4>
+<pre>protected org.apache.uima.ducc.common.utils.DuccProperties
cli_props</pre>
+</li>
+</ul>
+<a name="errors">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>errors</h4>
+<pre>protected <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true";
title="class or interface in java.util">ArrayList</a><<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>> errors</pre>
+</li>
+</ul>
+<a name="warnings">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>warnings</h4>
+<pre>protected <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true";
title="class or interface in java.util">ArrayList</a><<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>> warnings</pre>
+</li>
+</ul>
+<a name="messages">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>messages</h4>
+<pre>protected <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true";
title="class or interface in java.util">ArrayList</a><<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>> messages</pre>
+</li>
+</ul>
+<a name="debug">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>debug</h4>
+<pre>protected boolean debug</pre>
+</li>
+</ul>
+<a name="console_listener">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>console_listener</h4>
+<pre>protected org.apache.uima.ducc.cli.ConsoleListener
console_listener</pre>
+</li>
+</ul>
+<a name="suppress_console_log">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>suppress_console_log</h4>
+<pre>protected boolean suppress_console_log</pre>
+</li>
+</ul>
+<a name="host_address">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>host_address</h4>
+<pre>protected <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> host_address</pre>
+</li>
+</ul>
+<a name="console_attach">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>console_attach</h4>
+<pre>protected boolean console_attach</pre>
+</li>
+</ul>
+<a name="consoleCb">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>consoleCb</h4>
+<pre>protected <a
href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html"
title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb</pre>
+</li>
+</ul>
+<a name="monitor_listener">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>monitor_listener</h4>
+<pre>protected org.apache.uima.ducc.cli.MonitorListener
monitor_listener</pre>
+</li>
+</ul>
+<a name="waiter">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>waiter</h4>
+<pre><a
href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CountDownLatch.html?is-external=true";
title="class or interface in java.util.concurrent">CountDownLatch</a>
waiter</pre>
+</li>
+</ul>
+<a name="userSpecifiedProperties">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>userSpecifiedProperties</h4>
+<pre>protected <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true";
title="class or interface in java.util">Properties</a>
userSpecifiedProperties</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor.detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="CliBase--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>CliBase</h4>
+<pre>public CliBase()</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="execute--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>execute</h4>
+<pre>public abstract boolean execute()
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></pre>
+<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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>Return true if execution works, and false otherwise.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></code> - The specific
exception is a function of the implementor.</dd>
+</dl>
+</li>
+</ul>
+<a name="inhibitDefaults--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>inhibitDefaults</h4>
+<pre>protected void inhibitDefaults()</pre>
+</li>
+</ul>
+<a name="getLogDirectory-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getLogDirectory</h4>
+<pre><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> getLogDirectory(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> working_directory)
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true";
title="class or interface in java.io">IOException</a></pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true";
title="class or interface in java.io">IOException</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="getWorkingDirectory--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getWorkingDirectory</h4>
+<pre><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> getWorkingDirectory()
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true";
title="class or interface in java.io">IOException</a></pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true";
title="class or interface in java.io">IOException</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="check_service_dependencies-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>check_service_dependencies</h4>
+<pre>boolean check_service_dependencies(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> endpoint)</pre>
+</li>
+</ul>
+<a name="check_heap_size-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>check_heap_size</h4>
+<pre>void check_heap_size(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> argsOption)</pre>
+</li>
+</ul>
+<a name="setUser--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setUser</h4>
+<pre>void setUser()
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></code></dd>
+</dl>
+</li>
+</ul>
+<a
name="init-java.lang.String-org.apache.uima.ducc.cli.IUiOptions.UiOption:A-java.lang.String:A-org.apache.uima.ducc.common.utils.DuccProperties-org.apache.uima.ducc.cli.IDuccCallback-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>init</h4>
+<pre>protected void init(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> myClassName,
+ org.apache.uima.ducc.cli.IUiOptions.UiOption[] opts,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>[] args,
+
org.apache.uima.ducc.common.utils.DuccProperties cli_props,
+ <a
href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html"
title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb)
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></code></dd>
+</dl>
+</li>
+</ul>
+<a
name="init-java.lang.String-org.apache.uima.ducc.cli.IUiOptions.UiOption:A-java.util.Properties-org.apache.uima.ducc.common.utils.DuccProperties-org.apache.uima.ducc.cli.IDuccCallback-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>init</h4>
+<pre>protected void init(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> myClassName,
+ org.apache.uima.ducc.cli.IUiOptions.UiOption[] opts,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true";
title="class or interface in java.util">Properties</a> props,
+
org.apache.uima.ducc.common.utils.DuccProperties cli_props,
+ <a
href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html"
title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb)
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></code></dd>
+</dl>
+</li>
+</ul>
+<a
name="init-java.lang.String-org.apache.uima.ducc.cli.IUiOption:A-java.lang.String:A-java.util.Properties-org.apache.uima.ducc.common.utils.DuccProperties-org.apache.uima.ducc.cli.IDuccCallback-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>init</h4>
+<pre>protected void init(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> myClassName,
+ org.apache.uima.ducc.cli.IUiOption[] uiOpts,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>[] args,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true";
title="class or interface in java.util">Properties</a> props,
+
org.apache.uima.ducc.common.utils.DuccProperties cli_props,
+ <a
href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html"
title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> consoleCb,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> servlet)
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>myClassName</code> - Name of the class invoking me, for help
string</dd>
+<dd><code>uiOpts</code> - Array of IUioptions permitted for this command</dd>
+<dd><code>args</code> - Arguments from the command line (or null)</dd>
+<dd><code>props</code> - Properties passed in from the API (or null)</dd>
+<dd><code>cli_props</code> - (Initially) empty properties file to be filled
in</dd>
+<dd><code>consoleCb</code> - Console callback object (optional)</dd>
+<dd><code>servlet</code> - The name of the http servlet that will serve this
request</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></code> - If
initialization fails, e.g. invalid arguments or properties</dd>
+</dl>
+</li>
+</ul>
+<a name="setOptions-org.apache.uima.ducc.cli.IUiOption:A-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setOptions</h4>
+<pre>void setOptions(org.apache.uima.ducc.cli.IUiOption[] uiOpts)
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="setDefaults-org.apache.uima.ducc.cli.IUiOption:A-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setDefaults</h4>
+<pre>void setDefaults(org.apache.uima.ducc.cli.IUiOption[] uiOpts,
+ boolean suppress_console)
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true";
title="class or interface in java.io">IOException</a></pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true";
title="class or interface in java.io">IOException</a></code></dd>
+</dl>
+</li>
+</ul>
+<a
name="saveSpec-java.lang.String-org.apache.uima.ducc.common.utils.DuccProperties-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>saveSpec</h4>
+<pre>void saveSpec(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> name,
+ org.apache.uima.ducc.common.utils.DuccProperties props)
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></code></dd>
+</dl>
+</li>
+</ul>
+<a
name="extractReply-org.apache.uima.ducc.transport.event.AbstractDuccOrchestratorEvent-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>extractReply</h4>
+<pre>boolean extractReply(org.apache.uima.ducc.transport.event.AbstractDuccOrchestratorEvent reply)</pre>
+<div class="block">Extract messages and job pid from reply. This sets
messages and errors into the appropriate
+ structures for the API, and extracts the numeric id of the [job, ducclet,
reservation, service]
+ returned by the Orchestrator.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>reply</code> - - an Orchestrator reply event</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the action succeeded and false otherwise. The action in this
case, is whatever
+ the Orchestrator was asked to do: submit something, cancel
something, etc.</dd>
+</dl>
+</li>
+</ul>
+<a name="usage-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>usage</h4>
+<pre>void usage(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> message)</pre>
+</li>
+</ul>
+<a name="setProperty-java.lang.String-java.lang.String-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setProperty</h4>
+<pre>public boolean setProperty(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> key,
+ <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a> value)</pre>
+<div class="block">Set a property via the API. This method allows the API user
to
+ build up or override properties after the initial API object is
constructed.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>key</code> - This is the property name.</dd>
+<dd><code>value</code> - This is the value of the property.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the property is set. Returns false if the property is not legal
for this API.</dd>
+</dl>
+</li>
+</ul>
+<a name="getCallback--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCallback</h4>
+<pre>protected <a
href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html"
title="interface in
org.apache.uima.ducc.cli">IDuccCallback</a> getCallback()</pre>
+</li>
+</ul>
+<a name="message-java.lang.String...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>message</h4>
+<pre>void message(<a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
title="class or interface in java.lang">String</a>... e)</pre>
+</li>
+</ul>
+<a name="getReturnCode--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getReturnCode</h4>
+<pre>public int getReturnCode()</pre>
+<div class="block">This returns the return code from the execution of the
requested work. Return code is only
+ available when the monitor wait completes ... if not waiting then assume
success.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The exit code of the job, process, etc.</dd>
+</dl>
+</li>
+</ul>
+<a name="getDuccId--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getDuccId</h4>
+<pre>public long getDuccId()</pre>
+<div class="block">This returns the unique numeric id for the requested work.
For submissions (job, reservation, etc)
+ this is the newly assigned id.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>The unique numeric id of the job, reservation, etc.</dd>
+</dl>
+</li>
+</ul>
+<a name="consoleExits--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>consoleExits</h4>
+<pre>void consoleExits()</pre>
+</li>
+</ul>
+<a name="monitorExits-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>monitorExits</h4>
+<pre>void monitorExits(int rc)</pre>
+</li>
+</ul>
+<a
name="startMonitors-boolean-org.apache.uima.ducc.transport.event.IDuccContext.DuccContext-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>startMonitors</h4>
+<pre>protected void startMonitors(boolean start_stdin,
+
org.apache.uima.ducc.transport.event.IDuccContext.DuccContext context)
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></code></dd>
+</dl>
+</li>
+</ul>
+<a
name="startMonitor-org.apache.uima.ducc.transport.event.IDuccContext.DuccContext-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>startMonitor</h4>
+<pre>protected void startMonitor(org.apache.uima.ducc.transport.event.IDuccContext.DuccContext context)</pre>
+</li>
+</ul>
+<a name="initConsoleListener--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>initConsoleListener</h4>
+<pre>protected void initConsoleListener()
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="startConsoleListener-boolean-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>startConsoleListener</h4>
+<pre>protected void startConsoleListener(boolean start_stdin)
+ throws <a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></pre>
+<dl>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true";
title="class or interface in java.lang">Exception</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="stopListeners--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>stopListeners</h4>
+<pre>protected void stopListeners()</pre>
+</li>
+</ul>
+<a name="isConsoleAttached--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isConsoleAttached</h4>
+<pre>public boolean isConsoleAttached()</pre>
+<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>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>True if the console is still attached to the remote process, false
otherwise.</dd>
+</dl>
+</li>
+</ul>
+<a name="waitForCompletion--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>waitForCompletion</h4>
+<pre>public boolean waitForCompletion()</pre>
+<div class="block">Wait for the listeners - maybe a console listener, maybe a
job listener, maybe both.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if a monitor wait was done, false otherwise. A monitor wait
+ results in a return code from the process. In all other cases
+ the return code is spurious.</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom
Navigation Bar"/>
+<div class="bottomNav"><a name="navbar.bottom">
+<!-- -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation
links">Skip navigation links</a></div>
+<a name="navbar.bottom.firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/CliBase.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/uima/ducc/cli/AServicePing.html"
title="class in org.apache.uima.ducc.cli"><span
class="typeNameLink">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/ducc/cli/DuccJobCancel.html"
title="class in org.apache.uima.ducc.cli"><span
class="typeNameLink">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/ducc/cli/CliBase.html"
target="_top">Frames</a></li>
+<li><a href="CliBase.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li><a href="#field.summary">Field</a> | </li>
+<li><a href="#constructor.summary">Constr</a> | </li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field.detail">Field</a> | </li>
+<li><a href="#constructor.detail">Constr</a> | </li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<div role="contentinfo" title ="contentinfo_title" aria-label ="Contains
footer note"/>
+<p class="legalCopy"><small>Copyright © 2012–2019 <a
href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights
reserved.</small></p>
+</body>
+</html>
Propchange:
uima/site/trunk/uima-website/docs/d/uima-ducc-3.0.0/api/org/apache/uima/ducc/cli/CliBase.html
------------------------------------------------------------------------------
svn:eol-style = native
