org.apache.uima.ducc.cli

Class DuccReservationSubmit

java.lang.Object

org.apache.uima.ducc.cli.CliBase

org.apache.uima.ducc.cli.DuccReservationSubmit

All Implemented Interfaces:

org.apache.uima.ducc.cli.IUiOptions

public class DuccReservationSubmit
extends CliBase

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

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

Method Summary

Modifier and Type	Method and Description
boolean	execute() Execute collects the parameters for the reservation and sends them to the DUCC Orchestrator to schedule the reservation.
String	getHost() If the reservation is granted, this method returns the reserved host
String[]	getHosts() Deprecated.
String	getHostsAsString() Deprecated.
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

resCB

IDuccCallback resCB

opts

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

Constructor Detail

DuccReservationSubmit

public DuccReservationSubmit(String[] args)
                      throws Exception

Parameters:

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

Throws:

Exception - if request fails

DuccReservationSubmit

public DuccReservationSubmit(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 request fails

DuccReservationSubmit

public DuccReservationSubmit(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

execute

public boolean execute()
                throws Exception

Execute collects the parameters for the reservation and sends them to the DUCC Orchestrator to schedule the reservation. This method blocks until either the reservation is granted, or it fails. Failure is always do to lack of resources, in some form or another. Reservations must be from one of the 'reserve' classes i.e for a whole machine.

Specified by:

execute in class CliBase

Returns:

True if the DUCC grants the reservation.

Throws:

Exception - if request fails

getHost

public String getHost()

If the reservation is granted, this method returns the reserved host

Returns:

Name of host where the reservation is granted.

getHosts

@Deprecated
public String[] getHosts()

Deprecated.

If the reservation is granted, this method returns the set of hosts containing the reservation.

Returns:

String array of hosts where the reservation is granted.

getHostsAsString

@Deprecated
public String getHostsAsString()

Deprecated.

If the reservation is granted, this method returns the set of hosts containing the reservation as a single blank-delimited string.

Returns:

Blank-delimited string of hosts where the reservation is granted.

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.