org.apache.uima.ducc.cli

Class DuccJobCancel

java.lang.Object

org.apache.uima.ducc.cli.CliBase

org.apache.uima.ducc.cli.DuccJobCancel

All Implemented Interfaces:

org.apache.uima.ducc.cli.IUiOptions

public class DuccJobCancel
extends CliBase

Cancel a DUCC job

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) long	canceledPid
(package private) org.apache.uima.ducc.transport.event.cli.JobRequestProperties	jobRequestProperties
(package private) org.apache.uima.ducc.cli.IUiOptions.UiOption[]	opts
(package private) String	responseMessage

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
DuccJobCancel(List<String> args) Cancel a job
DuccJobCancel(Properties props) Cancel a job
DuccJobCancel(String[] args) Cancel a job

Method Summary

Modifier and Type	Method and Description
boolean	execute() Execute collects the parameters for job cancelation and sends them to the DUCC Orchestrator to effect the cancelation.
long	getCanceledPid() If a specific process, rather than the entire job, is canceled.
String	getResponseMessage() Return the DUCC Orchestrator message, if any, pertaining to the cancelation.
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

jobRequestProperties

org.apache.uima.ducc.transport.event.cli.JobRequestProperties jobRequestProperties

canceledPid

long canceledPid

responseMessage

String responseMessage

opts

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

Constructor Detail

DuccJobCancel

public DuccJobCancel(String[] args)
              throws Exception

Cancel a job

Parameters:

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

Throws:

Exception - if request fails

DuccJobCancel

public DuccJobCancel(List<String> args)
              throws Exception

Cancel a job

Parameters:

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

Throws:

Exception - if request fails

DuccJobCancel

public DuccJobCancel(Properties props)
              throws Exception

Cancel a job

Parameters:

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

Throws:

Exception - if request fails

Method Detail

getCanceledPid

public long getCanceledPid()

If a specific process, rather than the entire job, is canceled. this returns the canceled DUCC id of the process, as confirmation.

Returns:

The DUCC numeric id of the canceled process.

getResponseMessage

public String getResponseMessage()

Return the DUCC Orchestrator message, if any, pertaining to the cancelation.

Returns:

Return any message associated with the cancelation.

execute

public boolean execute()
                throws Exception

Execute collects the parameters for job cancelation and sends them to the DUCC Orchestrator to effect the cancelation.

Specified by:

execute in class CliBase

Returns:

True if the orchestrator accepts the job cancelation.

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.