You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by cw...@apache.org on 2016/08/08 19:58:35 UTC
svn commit: r1755532 [8/24] - in
/uima/site/trunk/uima-website/docs/d/uima-ducc-2.1.0: ./ api/ api/org/
api/org/apache/ api/org/apache/uima/ api/org/apache/uima/ducc/
api/org/apache/uima/ducc/cli/ api/org/apache/uima/ducc/cli/class-use/
api/org/apache/...
Added: uima/site/trunk/uima-website/docs/d/uima-ducc-2.1.0/api/org/apache/uima/ducc/cli/DuccServiceApi.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/d/uima-ducc-2.1.0/api/org/apache/uima/ducc/cli/DuccServiceApi.html?rev=1755532&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/d/uima-ducc-2.1.0/api/org/apache/uima/ducc/cli/DuccServiceApi.html (added)
+++ uima/site/trunk/uima-website/docs/d/uima-ducc-2.1.0/api/org/apache/uima/ducc/cli/DuccServiceApi.html Mon Aug 8 19:58:33 2016
@@ -0,0 +1,1002 @@
+<!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>DuccServiceApi (Apache UIMA DUCC Java SDK 2.1.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="DuccServiceApi (Apache UIMA DUCC Java SDK 2.1.0 User-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><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/DuccServiceApi.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/DuccReservationSubmit.html" title="class in org.apache.uima.ducc.cli"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceCancel.html" title="class in org.apache.uima.ducc.cli"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/ducc/cli/DuccServiceApi.html" target="_top">Frames</a></li>
+<li><a href="DuccServiceApi.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 class="header">
+<div class="subTitle">org.apache.uima.ducc.cli</div>
+<h2 title="Class DuccServiceApi" class="title">Class DuccServiceApi</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/7/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><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">org.apache.uima.ducc.cli.CliBase</a></li>
+<li>
+<ul class="inheritance">
+<li>org.apache.uima.ducc.cli.DuccServiceApi</li>
+</ul>
+</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>
+<hr>
+<br>
+<pre>public class <span class="strong">DuccServiceApi</span>
+extends <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></pre>
+<div class="block">Handle registered services. This class is also the implementation of the
+ DUCC service CLI which internally uses its API to implement itself. Details on the
+ DUCC service CLI are found in the<a href="/doc/duccbook.html#DUCC_CLI_SERVICES">DUCC CLI reference.</a></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="nested_class_summary">
+<!-- -->
+</a>
+<h3>Nested Class Summary</h3>
+<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="overviewSummary" 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>(package private) <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><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#callback">callback</a></strong></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#custom_only_options">custom_only_options</a></strong></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#disable_options">disable_options</a></strong></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#enable_options">enable_options</a></strong></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#endpoint">endpoint</a></strong></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#ignore_options">ignore_options</a></strong></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#modify_options">modify_options</a></strong></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#observe_options">observe_options</a></strong></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#pinger_only_options">pinger_only_options</a></strong></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#query_options">query_options</a></strong></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#registration_options">registration_options</a></strong></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#start_options">start_options</a></strong></code>
+<div class="block">Service start arguments.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#stop_options">stop_options</a></strong></code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#uimaas_only_options">uimaas_only_options</a></strong></code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#unregister_options">unregister_options</a></strong></code> </td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_org.apache.uima.ducc.cli.CliBase">
+<!-- -->
+</a>
+<h3>Fields inherited from 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></h3>
+<code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#cli_props">cli_props</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#commandLine">commandLine</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#console_attach">console_attach</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#console_listener">console_listener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#consoleCb">consoleCb</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#debug">debug</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#dispatcher">dispatcher</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#ducc_home">ducc_home</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#errors">errors</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#friendlyId">friendlyId</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#host_address">host_address</a>,
<a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#messages">messages</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#monitor_listener">monitor_listener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#returnCode">returnCode</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#suppress_console_log">suppress_console_log</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#userSpecifiedProperties">userSpecifiedProperties</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#waiter">waiter</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#warnings">warnings</a></code></li>
+</ul>
+<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="overviewSummary" 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><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#DuccServiceApi(org.apache.uima.ducc.cli.IDuccCallback)">DuccServiceApi</a></strong>(<a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html" title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> cb)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#disable(java.lang.String[])">disable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#Disable(java.lang.String[])">Disable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#enable(java.lang.String[])">enable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#Enable(java.lang.String[])">Enable</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#execute()">execute</a></strong>()</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 class="rowColor">
+<td class="colFirst"><code>(package private) static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#format_reply(org.apache.uima.ducc.cli.IUiOptions.UiOption, org.apache.uima.ducc.transport.event.sm.IServiceReply)">format_reply</a></strong>(org.apache.uima.ducc.cli.IUiOptions.UiOption verb,
+ <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> reply)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>org.apache.uima.ducc.cli.IUiOptions.UiOption[]</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#getModifyOptions()">getModifyOptions</a></strong>()</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) static org.apache.uima.ducc.cli.IUiOptions.UiOption</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#getVerb(java.lang.String[])">getVerb</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#help()">help</a></strong>()</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) static void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#Help()">Help</a></strong>()</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#ignoreReferences(java.lang.String[])">ignoreReferences</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#IgnoreReferences(java.lang.String[])">IgnoreReferences</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#main(java.lang.String[])">main</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code>
+<div class="block">This is the main entrypoint, used by the executable jars and callable directly from the command line.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#modify(java.lang.String[])">modify</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code>
+<div class="block">The service 'modify' command is used to change various aspects of a registered service
+ without the need to reregister it.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>(package private) static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#Modify(java.lang.String[])">Modify</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#modifyX(java.lang.String[])">modifyX</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code>
+<div class="block">The service 'modify' command is used to change various aspects of a registered service
+ without the need to reregister it.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#observeReferences(java.lang.String[])">observeReferences</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#ObserveReferences(java.lang.String[])">ObserveReferences</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#query(java.lang.String[])">query</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code>
+<div class="block">The query API is used to query the status of services known to the service manager.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#Query(java.lang.String[])">Query</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#register(java.lang.String[])">register</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code>
+<div class="block">The register API is used to register a service with the service manager.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#Register(java.lang.String[])">Register</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#start(java.lang.String[])">start</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code>
+<div class="block">The start API is used to start one or more instances of a registered service.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#Start(java.lang.String[])">Start</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#stop(java.lang.String[])">stop</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code>
+<div class="block">The stop API is used to stop one or more service instances.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#Stop(java.lang.String[])">Stop</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#unregister(java.lang.String[])">unregister</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code>
+<div class="block">The unregister API is used to unregister a service.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>(package private) static boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceApi.html#Unregister(java.lang.String[])">Unregister</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> </td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.uima.ducc.cli.CliBase">
+<!-- -->
+</a>
+<h3>Methods inherited from 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></h3>
+<code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#check_heap_size(java.lang.String)">check_heap_size</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#check_service_dependencies(java.lang.String)">check_service_dependencies</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#consoleExits()">consoleExits</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#extractReply(org.apache.uima.ducc.transport.event.AbstractDuccOrchestratorEvent)">extractReply</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getCallback()">getCallback</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getDuccId()">getDuccId</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getLogDirectory()">getLogDirectory</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#getReturnCode()">getReturnCode</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#inhibitDefaults()">inhibitDef
aults</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String, org.apache.uima.ducc.cli.IUiOption[], java.lang.String[], java.util.Properties, org.apache.uima.ducc.common.utils.DuccProperties, org.apache.uima.ducc.cli.IDuccCallback, java.lang.String)">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String, org.apache.uima.ducc.cli.IUiOptions.UiOption[], java.util.Properties, org.apache.uima.ducc.common.utils.DuccProperties, org.apache.uima.ducc.cli.IDuccCallback)">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#init(java.lang.String, org.apache.uima.ducc.cli.IUiOptions.UiOption[], java.lang.String[], org.apache.uima.ducc.common.utils.DuccProperties, org.apache.uima.ducc.cli.IDuccCallback)">init</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#initConsoleListener()">initConsoleListener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#isConsoleAttached()"
>isConsoleAttached</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#message(java.lang.String...)">message</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#monitorExits(int)">monitorExits</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#saveSpec(java.lang.String, org.apache.uima.ducc.common.utils.DuccProperties)">saveSpec</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setDefaults(org.apache.uima.ducc.cli.IUiOption[], boolean)">setDefaults</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setOptions(org.apache.uima.ducc.cli.IUiOption[])">setOptions</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setProperty(java.lang.String, java.lang.String)">setProperty</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setUser()">setUser</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#setWorkingDirectory()">setWorkingDirectory</a>, <a href="../../../../../
org/apache/uima/ducc/cli/CliBase.html#startConsoleListener(boolean)">startConsoleListener</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startMonitor(org.apache.uima.ducc.transport.event.IDuccContext.DuccContext)">startMonitor</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#startMonitors(boolean, org.apache.uima.ducc.transport.event.IDuccContext.DuccContext)">startMonitors</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#stopListeners()">stopListeners</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#usage(java.lang.String)">usage</a>, <a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#waitForCompletion()">waitForCompletion</a></code></li>
+</ul>
+<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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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="endpoint">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>endpoint</h4>
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> endpoint</pre>
+</li>
+</ul>
+<a name="callback">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>callback</h4>
+<pre><a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html" title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> callback</pre>
+</li>
+</ul>
+<a name="registration_options">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>registration_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] registration_options</pre>
+</li>
+</ul>
+<a name="unregister_options">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>unregister_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] unregister_options</pre>
+</li>
+</ul>
+<a name="start_options">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>start_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] start_options</pre>
+<div class="block">Service start arguments.</div>
+</li>
+</ul>
+<a name="stop_options">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>stop_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] stop_options</pre>
+</li>
+</ul>
+<a name="enable_options">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>enable_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] enable_options</pre>
+</li>
+</ul>
+<a name="disable_options">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>disable_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] disable_options</pre>
+</li>
+</ul>
+<a name="observe_options">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>observe_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] observe_options</pre>
+</li>
+</ul>
+<a name="ignore_options">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>ignore_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] ignore_options</pre>
+</li>
+</ul>
+<a name="modify_options">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>modify_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] modify_options</pre>
+</li>
+</ul>
+<a name="query_options">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>query_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] query_options</pre>
+</li>
+</ul>
+<a name="custom_only_options">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>custom_only_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] custom_only_options</pre>
+</li>
+</ul>
+<a name="uimaas_only_options">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>uimaas_only_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] uimaas_only_options</pre>
+</li>
+</ul>
+<a name="pinger_only_options">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>pinger_only_options</h4>
+<pre>org.apache.uima.ducc.cli.IUiOptions.UiOption[] pinger_only_options</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="DuccServiceApi(org.apache.uima.ducc.cli.IDuccCallback)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>DuccServiceApi</h4>
+<pre>public DuccServiceApi(<a href="../../../../../org/apache/uima/ducc/cli/IDuccCallback.html" title="interface in org.apache.uima.ducc.cli">IDuccCallback</a> cb)</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getModifyOptions()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getModifyOptions</h4>
+<pre>public org.apache.uima.ducc.cli.IUiOptions.UiOption[] getModifyOptions()</pre>
+</li>
+</ul>
+<a name="register(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>register</h4>
+<pre>public <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> register(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">The register API is used to register a service with the service manager.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - String rray of arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_SERVICES">DUCC CLI reference.</a></dd>
+<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm"><code>IServiceReply</code></a> object with register status.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="unregister(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>unregister</h4>
+<pre>public <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> unregister(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">The unregister API is used to unregister a service. The service manager will stop all instances and
+ remove the service registration.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - String array of arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_SERVICES">DUCC CLI reference.</a></dd>
+<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm"><code>IServiceReply</code></a> object with unregister reply status.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="start(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>start</h4>
+<pre>public <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> start(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">The start API is used to start one or more instances of a registered service.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - String array of arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_SERVICES">DUCC CLI reference.</a></dd>
+<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm"><code>IServiceReply</code></a> object with start reply status.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="stop(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>stop</h4>
+<pre>public <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> stop(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">The stop API is used to stop one or more service instances.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - String array of arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_SERVICES">DUCC CLI reference.</a></dd>
+<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm"><code>IServiceReply</code></a> object with stop status.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="modify(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>modify</h4>
+<pre>public <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> modify(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">The service 'modify' command is used to change various aspects of a registered service
+ without the need to reregister it.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - String array of arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_SERVICES">DUCC CLI reference.</a></dd>
+<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm"><code>IServiceReply</code></a> object with modify status.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="modifyX(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>modifyX</h4>
+<pre>public <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> modifyX(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">The service 'modify' command is used to change various aspects of a registered service
+ without the need to reregister it.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - String array of arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_SERVICES">DUCC CLI reference.</a></dd>
+<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm"><code>IServiceReply</code></a> object with modify status.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="query(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>query</h4>
+<pre>public <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> query(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">The query API is used to query the status of services known to the service manager.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - String array of arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_SERVICES">DUCC CLI reference.</a></dd>
+<dt><span class="strong">Returns:</span></dt><dd><a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm"><code>IServiceReply</code></a> object with query results status.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="observeReferences(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>observeReferences</h4>
+<pre>public <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> observeReferences(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="ignoreReferences(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>ignoreReferences</h4>
+<pre>public <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> ignoreReferences(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="enable(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>enable</h4>
+<pre>public <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> enable(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="disable(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>disable</h4>
+<pre>public <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> disable(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="help()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>help</h4>
+<pre>void help()</pre>
+</li>
+</ul>
+<a name="execute()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>execute</h4>
+<pre>public boolean execute()</pre>
+<div class="block"><span class="strong">Description copied from class: <code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#execute()">CliBase</a></code></span></div>
+<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><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html#execute()">execute</a></code> in class <code><a href="../../../../../org/apache/uima/ducc/cli/CliBase.html" title="class in org.apache.uima.ducc.cli">CliBase</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>Return true if execution works, and false otherwise.</dd></dl>
+</li>
+</ul>
+<a name="format_reply(org.apache.uima.ducc.cli.IUiOptions.UiOption, org.apache.uima.ducc.transport.event.sm.IServiceReply)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>format_reply</h4>
+<pre>static boolean format_reply(org.apache.uima.ducc.cli.IUiOptions.UiOption verb,
+ <a href="../../../../../org/apache/uima/ducc/transport/event/sm/IServiceReply.html" title="interface in org.apache.uima.ducc.transport.event.sm">IServiceReply</a> reply)</pre>
+</li>
+</ul>
+<a name="Register(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>Register</h4>
+<pre>static boolean Register(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="Unregister(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>Unregister</h4>
+<pre>static boolean Unregister(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="Start(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>Start</h4>
+<pre>static boolean Start(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="Stop(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>Stop</h4>
+<pre>static boolean Stop(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="Modify(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>Modify</h4>
+<pre>static boolean Modify(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="Enable(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>Enable</h4>
+<pre>static boolean Enable(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="Disable(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>Disable</h4>
+<pre>static boolean Disable(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="ObserveReferences(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>ObserveReferences</h4>
+<pre>static boolean ObserveReferences(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="IgnoreReferences(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>IgnoreReferences</h4>
+<pre>static boolean IgnoreReferences(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="Query(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>Query</h4>
+<pre>static boolean Query(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/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="Help()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>Help</h4>
+<pre>static void Help()</pre>
+</li>
+</ul>
+<a name="getVerb(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getVerb</h4>
+<pre>static org.apache.uima.ducc.cli.IUiOptions.UiOption getVerb(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</pre>
+</li>
+</ul>
+<a name="main(java.lang.String[])">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>main</h4>
+<pre>public static void main(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</pre>
+<div class="block">This is the main entrypoint, used by the executable jars and callable directly from the command line.
+
+ If the invocation is successful, the process exits with return code 0. Otherwise, it exit
+ with return code 1.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - arguments as described in the <a href="/doc/duccbook.html#DUCC_CLI_SERVICES">DUCC CLI reference.</a></dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!-- -->
+</a>
+<div class="skip"><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/DuccServiceApi.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/DuccReservationSubmit.html" title="class in org.apache.uima.ducc.cli"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/uima/ducc/cli/DuccServiceCancel.html" title="class in org.apache.uima.ducc.cli"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/uima/ducc/cli/DuccServiceApi.html" target="_top">Frames</a></li>
+<li><a href="DuccServiceApi.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 ======= -->
+<p class="legalCopy"><small>Copyright © 2012–2016 <a href="http://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-2.1.0/api/org/apache/uima/ducc/cli/DuccServiceApi.html
------------------------------------------------------------------------------
svn:eol-style = native