org.apache.uima.ducc.cli

Class DuccReservationCancel

java.lang.Object

org.apache.uima.ducc.cli.CliBase

org.apache.uima.ducc.cli.DuccReservationCancel

All Implemented Interfaces:

org.apache.uima.ducc.cli.IUiOptions

public class DuccReservationCancel
extends CliBase

Cancel a DUCC reservation

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.cli.IUiOptions.UiOption[]	opts
(package private) org.apache.uima.ducc.transport.event.cli.ReservationRequestProperties	requestProperties
(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
DuccReservationCancel(List<String> args)
DuccReservationCancel(Properties props)
DuccReservationCancel(String[] args)

Method Summary

Modifier and Type	Method and Description
boolean	execute() Execute collects the parameters for reservation cancellation and sends them to the DUCC Orchestrator to effect the cancellation.
String	getResponseMessage() Return the DUCC Orchestrator message, if any, pertaining to the cancellation.
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.ReservationRequestProperties requestProperties

canceledPid

long canceledPid

responseMessage

String responseMessage

opts

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

Constructor Detail

DuccReservationCancel

public DuccReservationCancel(String[] args)
                      throws Exception

Parameters:

args - Array of string arguments as described in the

Throws:

Exception - if request fails

DuccReservationCancel

public DuccReservationCancel(List<String> args)
                      throws Exception

Parameters:

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

Throws:

Exception - if request fails

DuccReservationCancel

public DuccReservationCancel(Properties props)
                      throws Exception

Parameters:

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

Throws:

Exception - if request fails

Method Detail

getResponseMessage

public String getResponseMessage()

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

Returns:

Return any message associated with the cancellation.

execute

public boolean execute()
                throws Exception

Execute collects the parameters for reservation cancellation and sends them to the DUCC Orchestrator to effect the cancellation.

Specified by:

execute in class CliBase

Returns:

True if the orchestrator accepts the reservation cancellation.

Throws:

Exception - if request fails

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.