org.apache.uima.ducc.cli

Class DuccServiceApi

java.lang.Object

org.apache.uima.ducc.cli.CliBase

org.apache.uima.ducc.cli.DuccServiceApi

All Implemented Interfaces:

org.apache.uima.ducc.cli.IUiOptions

public class DuccServiceApi
extends CliBase

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 theDUCC CLI reference.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.uima.ducc.cli.IUiOptions

org.apache.uima.ducc.cli.IUiOptions.UiOption

Field Summary

Fields

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

Fields inherited from class org.apache.uima.ducc.cli.CliBase

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

Fields inherited from interface org.apache.uima.ducc.cli.IUiOptions

help_width

Constructor Summary

Constructors

Constructor and Description
DuccServiceApi(IDuccCallback cb)

Method Summary

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)

Methods inherited from class org.apache.uima.ducc.cli.CliBase

check_heap_size, check_service_dependencies, consoleExits, extractReply, getCallback, getDuccId, getLogDirectory, getReturnCode, getWorkingDirectory, inhibitDefaults, init, init, init, initConsoleListener, isConsoleAttached, message, monitorExits, saveSpec, setDefaults, setOptions, setProperty, setUser, startConsoleListener, startMonitor, startMonitors, stopListeners, usage, waitForCompletion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

endpoint

String endpoint

callback

IDuccCallback callback

registration_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] registration_options

unregister_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] unregister_options

start_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] start_options

Service start arguments.

stop_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] stop_options

enable_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] enable_options

disable_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] disable_options

observe_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] observe_options

ignore_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] ignore_options

modify_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] modify_options

query_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] query_options

custom_only_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] custom_only_options

uimaas_only_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] uimaas_only_options

pinger_only_options

org.apache.uima.ducc.cli.IUiOptions.UiOption[] pinger_only_options

Constructor Detail

DuccServiceApi

public DuccServiceApi(IDuccCallback cb)

Method Detail

getModifyOptions

public org.apache.uima.ducc.cli.IUiOptions.UiOption[] getModifyOptions()

register

public IServiceReply register(String[] args)
                       throws Exception

The register API is used to register a service with the service manager.

Parameters:

args - String array of arguments as described in the Command Line Interface section of the DuccBook

Returns:

IServiceReply object with register status.

Throws:

Exception - if the request is invalid

unregister

public IServiceReply unregister(String[] args)
                         throws Exception

The unregister API is used to unregister a service. The service manager will stop all instances and remove the service registration.

Parameters:

args - String array of arguments as described in the Command Line Interface section of the DuccBook

Returns:

IServiceReply object with unregister reply status.

Throws:

Exception - if the request is invalid

start

public IServiceReply start(String[] args)
                    throws Exception

The start API is used to start one or more instances of a registered service.

Parameters:

args - String array of arguments as described in the Command Line Interface section of the DuccBook

Returns:

IServiceReply object with start reply status.

Throws:

Exception - if the request is invalid

stop

public IServiceReply stop(String[] args)
                   throws Exception

The stop API is used to stop one or more service instances.

Parameters:

args - String array of arguments as described in the Command Line Interface section of the DuccBook

Returns:

IServiceReply object with stop status.

Throws:

Exception - if the request is invalid

modify

public IServiceReply modify(String[] args)
                     throws Exception

The service 'modify' command is used to change various aspects of a registered service without the need to reregister it.

Parameters:

args - String array of arguments as described in the Command Line Interface section of the DuccBook

Returns:

IServiceReply object with modify status.

Throws:

Exception - if the request is invalid

modifyX

public IServiceReply modifyX(String[] args)
                      throws Exception

The service 'modify' command is used to change various aspects of a registered service without the need to reregister it.

Parameters:

args - String array of arguments as described in the Command Line Interface section of the DuccBook

Returns:

IServiceReply object with modify status.

Throws:

Exception - if the request is invalid

query

public IServiceReply query(String[] args)
                    throws Exception

The query API is used to query the status of services known to the service manager.

Parameters:

args - String array of arguments as described in the Command Line Interface section of the DuccBook

Returns:

IServiceReply object with query results status.

Throws:

Exception - if the request is invalid

observeReferences

public IServiceReply observeReferences(String[] args)
                                throws Exception

Throws:

Exception

ignoreReferences

public IServiceReply ignoreReferences(String[] args)
                               throws Exception

Throws:

Exception

enable

public IServiceReply enable(String[] args)
                     throws Exception

Throws:

Exception

disable

public IServiceReply disable(String[] args)
                      throws Exception

Throws:

Exception

help

void help()

execute

public boolean execute()

Description copied from class: CliBase

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.

Specified by:

execute in class CliBase

Returns:

Return true if execution works, and false otherwise.

format_reply

static boolean format_reply(org.apache.uima.ducc.cli.IUiOptions.UiOption verb,
                            IServiceReply reply)

Register

static boolean Register(String[] args)
                 throws Exception

Throws:

Exception

Unregister

static boolean Unregister(String[] args)
                   throws Exception

Throws:

Exception

Start

static boolean Start(String[] args)
              throws Exception

Throws:

Exception

Stop

static boolean Stop(String[] args)
             throws Exception

Throws:

Exception

Modify

static boolean Modify(String[] args)
               throws Exception

Throws:

Exception

Enable

static boolean Enable(String[] args)
               throws Exception

Throws:

Exception

Disable

static boolean Disable(String[] args)
                throws Exception

Throws:

Exception

ObserveReferences

static boolean ObserveReferences(String[] args)
                          throws Exception

Throws:

Exception

IgnoreReferences

static boolean IgnoreReferences(String[] args)
                         throws Exception

Throws:

Exception

Query

static boolean Query(String[] args)
              throws Exception

Throws:

Exception

Help

static void Help()

getVerb

static org.apache.uima.ducc.cli.IUiOptions.UiOption getVerb(String[] args)

main

public static void main(String[] args)

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.

Parameters:

args - arguments as described in the DUCC CLI reference.