public class DuccServiceApi extends CliBase
Modifier and Type | Field and Description |
---|---|
(package private) IDuccCallback |
callback |
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
custom_only_options |
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
disable_options |
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
enable_options |
(package private) String |
endpoint |
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
ignore_options |
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
modify_options |
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
observe_options |
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
pinger_only_options |
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
query_options |
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
registration_options |
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
start_options
Service start arguments.
|
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
stop_options |
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
uimaas_only_options |
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
unregister_options |
cli_props, commandLine, console_attach, console_listener, consoleCb, debug, dispatcher, ducc_home, errors, friendlyId, host_address, messages, monitor_listener, returnCode, suppress_console_log, userSpecifiedProperties, waiter, warnings
Constructor and Description |
---|
DuccServiceApi(IDuccCallback cb) |
Modifier and Type | Method and Description |
---|---|
IServiceReply |
disable(String[] args) |
(package private) static boolean |
Disable(String[] args) |
IServiceReply |
enable(String[] args) |
(package private) static boolean |
Enable(String[] args) |
boolean |
execute()
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.
|
(package private) static boolean |
format_reply(org.apache.uima.ducc.cli.IUiOptions.UiOption verb,
IServiceReply reply) |
org.apache.uima.ducc.cli.IUiOptions.UiOption[] |
getModifyOptions() |
(package private) static org.apache.uima.ducc.cli.IUiOptions.UiOption |
getVerb(String[] args) |
(package private) void |
help() |
(package private) static void |
Help() |
IServiceReply |
ignoreReferences(String[] args) |
(package private) static boolean |
IgnoreReferences(String[] args) |
static void |
main(String[] args)
This is the main entrypoint, used by the executable jars and callable directly from the command line.
|
IServiceReply |
modify(String[] args)
The service 'modify' command is used to change various aspects of a registered service
without the need to reregister it.
|
(package private) static boolean |
Modify(String[] args) |
IServiceReply |
modifyX(String[] args)
The service 'modify' command is used to change various aspects of a registered service
without the need to reregister it.
|
IServiceReply |
observeReferences(String[] args) |
(package private) static boolean |
ObserveReferences(String[] args) |
IServiceReply |
query(String[] args)
The query API is used to query the status of services known to the service manager.
|
(package private) static boolean |
Query(String[] args) |
IServiceReply |
register(String[] args)
The register API is used to register a service with the service manager.
|
(package private) static boolean |
Register(String[] args) |
IServiceReply |
start(String[] args)
The start API is used to start one or more instances of a registered service.
|
(package private) static boolean |
Start(String[] args) |
IServiceReply |
stop(String[] args)
The stop API is used to stop one or more service instances.
|
(package private) static boolean |
Stop(String[] args) |
IServiceReply |
unregister(String[] args)
The unregister API is used to unregister a service.
|
(package private) static boolean |
Unregister(String[] args) |
check_service_dependencies, consoleExits, extractReply, getCallback, getDuccId, getLogDirectory, getReturnCode, inhibitDefaults, init, init, init, initConsoleListener, isConsoleAttached, message, monitorExits, saveSpec, setDefaults, setOptions, setProperty, setUser, setWorkingDirectory, startConsoleListener, startMonitor, startMonitors, stopListeners, usage, waitForCompletion
String endpoint
IDuccCallback callback
org.apache.uima.ducc.cli.IUiOptions.UiOption[] registration_options
org.apache.uima.ducc.cli.IUiOptions.UiOption[] unregister_options
org.apache.uima.ducc.cli.IUiOptions.UiOption[] start_options
org.apache.uima.ducc.cli.IUiOptions.UiOption[] stop_options
org.apache.uima.ducc.cli.IUiOptions.UiOption[] enable_options
org.apache.uima.ducc.cli.IUiOptions.UiOption[] disable_options
org.apache.uima.ducc.cli.IUiOptions.UiOption[] observe_options
org.apache.uima.ducc.cli.IUiOptions.UiOption[] ignore_options
org.apache.uima.ducc.cli.IUiOptions.UiOption[] modify_options
org.apache.uima.ducc.cli.IUiOptions.UiOption[] query_options
org.apache.uima.ducc.cli.IUiOptions.UiOption[] custom_only_options
org.apache.uima.ducc.cli.IUiOptions.UiOption[] uimaas_only_options
org.apache.uima.ducc.cli.IUiOptions.UiOption[] pinger_only_options
public DuccServiceApi(IDuccCallback cb)
public org.apache.uima.ducc.cli.IUiOptions.UiOption[] getModifyOptions()
public IServiceReply register(String[] args) throws Exception
args
- String rray of arguments as described in the DUCC CLI reference.IServiceReply
object with register status.Exception
public IServiceReply unregister(String[] args) throws Exception
args
- String array of arguments as described in the DUCC CLI reference.IServiceReply
object with unregister reply status.Exception
public IServiceReply start(String[] args) throws Exception
args
- String array of arguments as described in the DUCC CLI reference.IServiceReply
object with start reply status.Exception
public IServiceReply stop(String[] args) throws Exception
args
- String array of arguments as described in the DUCC CLI reference.IServiceReply
object with stop status.Exception
public IServiceReply modify(String[] args) throws Exception
args
- String array of arguments as described in the DUCC CLI reference.IServiceReply
object with modify status.Exception
public IServiceReply modifyX(String[] args) throws Exception
args
- String array of arguments as described in the DUCC CLI reference.IServiceReply
object with modify status.Exception
public IServiceReply query(String[] args) throws Exception
args
- String array of arguments as described in the DUCC CLI reference.IServiceReply
object with query results status.Exception
public IServiceReply observeReferences(String[] args) throws Exception
Exception
public IServiceReply ignoreReferences(String[] args) throws Exception
Exception
public IServiceReply enable(String[] args) throws Exception
Exception
public IServiceReply disable(String[] args) throws Exception
Exception
void help()
public boolean execute()
CliBase
static boolean format_reply(org.apache.uima.ducc.cli.IUiOptions.UiOption verb, IServiceReply reply)
static boolean ObserveReferences(String[] args) throws Exception
Exception
static void Help()
static org.apache.uima.ducc.cli.IUiOptions.UiOption getVerb(String[] args)
public static void main(String[] args)
args
- arguments as described in the DUCC CLI reference.Copyright © 2012–2015 The Apache Software Foundation. All rights reserved.