org.apache.uima.ducc.cli

Class DuccServiceSubmit

java.lang.Object

org.apache.uima.ducc.cli.CliBase

org.apache.uima.ducc.cli.DuccServiceSubmit

All Implemented Interfaces:

org.apache.uima.ducc.cli.IUiOptions

public class DuccServiceSubmit
extends CliBase

Submit a DUCC service. This is usually called by the DUCC Service Manager but is made public to enable developer-driven management and testing of services without formal service registration.

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) org.apache.uima.ducc.cli.IUiOptions.UiOption[]	opts
(package private) org.apache.uima.ducc.transport.event.cli.ServiceRequestProperties	requestProperties

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
DuccServiceSubmit(ArrayList<String> args)
DuccServiceSubmit(Properties props)
DuccServiceSubmit(String[] args)

Method Summary

Modifier and Type	Method and Description
protected void	enrich_parameters_for_debug(Properties props)
boolean	execute() Execute collects the service parameters, does basic error and correctness checking, and sends the job properties to the DUCC orchestrator for execution.
static void	main(String[] args) Main method, as used by the executable jar or direct java invocation.

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

requestProperties

org.apache.uima.ducc.transport.event.cli.ServiceRequestProperties requestProperties

opts

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

Constructor Detail

DuccServiceSubmit

public DuccServiceSubmit(String[] args)
                  throws Exception

Parameters:

args - Array of string arguments as described in the Command Line Interface section of the DuccBook

Throws:

Exception - if the request is invalid

DuccServiceSubmit

public DuccServiceSubmit(ArrayList<String> args)
                  throws Exception

Parameters:

args - List of string arguments as described in the Command Line Interface section of the DuccBook

Throws:

Exception - if the request is invalid

DuccServiceSubmit

public DuccServiceSubmit(Properties props)
                  throws Exception

Parameters:

props - Properties file of arguments, as described in the Command Line Interface section of the DuccBook

Throws:

Exception - if the request is invalid

Method Detail

enrich_parameters_for_debug

protected void enrich_parameters_for_debug(Properties props)
                                    throws Exception

Throws:

Exception

execute

public boolean execute()
                throws Exception

Execute collects the service parameters, does basic error and correctness checking, and sends the job properties to the DUCC orchestrator for execution.

Specified by:

execute in class CliBase

Returns:

True if the orchestrator accepts the service; false otherwise.

Throws:

Exception - The specific exception is a function of the implementor.

main

public static void main(String[] args)

Main method, as used by the executable jar or direct java invocation.

Parameters:

args - arguments as described in the DUCC CLI reference.