org.apache.uima.ducc.cli
Class DuccServiceCancel

java.lang.Object
  extended by org.apache.uima.ducc.cli.CliBase
      extended by org.apache.uima.ducc.cli.DuccServiceCancel
All Implemented Interfaces:
org.apache.uima.ducc.cli.IUiOptions

public class DuccServiceCancel
extends CliBase

Cancel a DUCC service instance.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.uima.ducc.cli.IUiOptions
org.apache.uima.ducc.cli.IUiOptions.ClasspathOrderParms, org.apache.uima.ducc.cli.IUiOptions.UiOption
 
Field Summary
 
Fields inherited from interface org.apache.uima.ducc.cli.IUiOptions
help_width
 
Constructor Summary
DuccServiceCancel(List<String> args)
           
DuccServiceCancel(Properties props)
           
DuccServiceCancel(String[] args)
           
 
Method Summary
 boolean execute()
          Execute collects the parameters for job cancelation and sends them to the DUCC Orchestrator to effect the cancelation.
 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
getDuccId, getReturnCode, isConsoleAttached, makeOptions, setProperty, waitForCompletion
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DuccServiceCancel

public DuccServiceCancel(String[] args)
                  throws Exception
Parameters:
args - Array of string arguments as described in the DUCC CLI reference.
Throws:
Exception

DuccServiceCancel

public DuccServiceCancel(List<String> args)
                  throws Exception
Parameters:
args - List of string arguments as described in the DUCC CLI reference.
Throws:
Exception

DuccServiceCancel

public DuccServiceCancel(Properties props)
                  throws Exception
Parameters:
props - Properties file of arguments, as described in the DUCC CLI reference.
Throws:
Exception
Method Detail

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.


Copyright © 2012–2014 The Apache Software Foundation. All rights reserved.