org.apache.oozie.cli
Class OozieCLI

java.lang.Object
  extended by org.apache.oozie.cli.OozieCLI

public class OozieCLI
extends java.lang.Object

Oozie command line utility.


Field Summary
static java.lang.String ADMIN_CMD
           
static java.lang.String CHANGE_OPTION
           
static java.lang.String CHANGE_VALUE_OPTION
           
static java.lang.String CONFIG_OPTION
           
static java.lang.String DEFINITION_OPTION
           
static java.lang.String DRYRUN_OPTION
           
static java.lang.String ENV_OOZIE_URL
           
static java.lang.String FILTER_OPTION
           
static java.lang.String HELP_CMD
           
static java.lang.String INFO_OPTION
           
static java.lang.String JOB_CMD
           
static java.lang.String JOBS_CMD
           
static java.lang.String JOBTYPE_OPTION
           
static java.lang.String KILL_OPTION
           
static java.lang.String LEN_OPTION
           
static java.lang.String LOCAL_TIME_OPTION
           
static java.lang.String LOG_OPTION
           
static java.lang.String OFFSET_OPTION
           
static java.lang.String OOZIE_OPTION
           
static java.lang.String PIG_CMD
           
static java.lang.String PIGFILE_OPTION
           
static java.lang.String QUEUE_DUMP_OPTION
           
static java.lang.String RERUN_ACTION_OPTION
           
static java.lang.String RERUN_DATE_OPTION
           
static java.lang.String RERUN_NOCLEANUP_OPTION
           
static java.lang.String RERUN_OPTION
           
static java.lang.String RERUN_REFRESH_OPTION
           
static java.lang.String RESUME_OPTION
           
static java.lang.String RUN_OPTION
           
static java.lang.String SLA_CMD
           
static java.lang.String START_OPTION
           
static java.lang.String STATUS_OPTION
           
static java.lang.String SUBMIT_OPTION
           
static java.lang.String SUSPEND_OPTION
           
static java.lang.String SYSTEM_MODE_OPTION
           
static java.lang.String VALIDATE_CMD
           
static java.lang.String VERBOSE_DELIMITER
           
static java.lang.String VERBOSE_OPTION
           
static java.lang.String VERSION_CMD
           
static java.lang.String VERSION_OPTION
           
static java.lang.String WS_HEADER_PREFIX
           
 
Constructor Summary
OozieCLI()
          Create an Oozie CLI instance.
 
Method Summary
protected  org.apache.commons.cli.Options createAdminOptions()
           
protected  org.apache.commons.cli.Options createJobOptions()
           
protected  org.apache.commons.cli.Options createJobsOptions()
           
protected  OozieClient createOozieClient(org.apache.commons.cli.CommandLine commandLine)
          Create a OozieClient.
protected  org.apache.commons.cli.Options createPigOptions()
           
protected  org.apache.commons.cli.Options createSlaOptions()
           
protected  XOozieClient createXOozieClient(org.apache.commons.cli.CommandLine commandLine)
          Create a XOozieClient.
protected  java.lang.String[] getCLIHelp()
          Return Oozie CLI top help lines.
protected  java.lang.String getOozieUrl(org.apache.commons.cli.CommandLine commandLine)
           
static void main(java.lang.String[] args)
          Entry point for the Oozie CLI when invoked from the command line.
 int run(java.lang.String[] args)
          Run a CLI programmatically.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ENV_OOZIE_URL

public static final java.lang.String ENV_OOZIE_URL
See Also:
Constant Field Values

WS_HEADER_PREFIX

public static final java.lang.String WS_HEADER_PREFIX
See Also:
Constant Field Values

HELP_CMD

public static final java.lang.String HELP_CMD
See Also:
Constant Field Values

VERSION_CMD

public static final java.lang.String VERSION_CMD
See Also:
Constant Field Values

JOB_CMD

public static final java.lang.String JOB_CMD
See Also:
Constant Field Values

JOBS_CMD

public static final java.lang.String JOBS_CMD
See Also:
Constant Field Values

ADMIN_CMD

public static final java.lang.String ADMIN_CMD
See Also:
Constant Field Values

VALIDATE_CMD

public static final java.lang.String VALIDATE_CMD
See Also:
Constant Field Values

SLA_CMD

public static final java.lang.String SLA_CMD
See Also:
Constant Field Values

PIG_CMD

public static final java.lang.String PIG_CMD
See Also:
Constant Field Values

OOZIE_OPTION

public static final java.lang.String OOZIE_OPTION
See Also:
Constant Field Values

CONFIG_OPTION

public static final java.lang.String CONFIG_OPTION
See Also:
Constant Field Values

SUBMIT_OPTION

public static final java.lang.String SUBMIT_OPTION
See Also:
Constant Field Values

OFFSET_OPTION

public static final java.lang.String OFFSET_OPTION
See Also:
Constant Field Values

START_OPTION

public static final java.lang.String START_OPTION
See Also:
Constant Field Values

RUN_OPTION

public static final java.lang.String RUN_OPTION
See Also:
Constant Field Values

DRYRUN_OPTION

public static final java.lang.String DRYRUN_OPTION
See Also:
Constant Field Values

SUSPEND_OPTION

public static final java.lang.String SUSPEND_OPTION
See Also:
Constant Field Values

RESUME_OPTION

public static final java.lang.String RESUME_OPTION
See Also:
Constant Field Values

KILL_OPTION

public static final java.lang.String KILL_OPTION
See Also:
Constant Field Values

CHANGE_OPTION

public static final java.lang.String CHANGE_OPTION
See Also:
Constant Field Values

CHANGE_VALUE_OPTION

public static final java.lang.String CHANGE_VALUE_OPTION
See Also:
Constant Field Values

RERUN_OPTION

public static final java.lang.String RERUN_OPTION
See Also:
Constant Field Values

INFO_OPTION

public static final java.lang.String INFO_OPTION
See Also:
Constant Field Values

LOG_OPTION

public static final java.lang.String LOG_OPTION
See Also:
Constant Field Values

DEFINITION_OPTION

public static final java.lang.String DEFINITION_OPTION
See Also:
Constant Field Values

LEN_OPTION

public static final java.lang.String LEN_OPTION
See Also:
Constant Field Values

FILTER_OPTION

public static final java.lang.String FILTER_OPTION
See Also:
Constant Field Values

JOBTYPE_OPTION

public static final java.lang.String JOBTYPE_OPTION
See Also:
Constant Field Values

SYSTEM_MODE_OPTION

public static final java.lang.String SYSTEM_MODE_OPTION
See Also:
Constant Field Values

VERSION_OPTION

public static final java.lang.String VERSION_OPTION
See Also:
Constant Field Values

STATUS_OPTION

public static final java.lang.String STATUS_OPTION
See Also:
Constant Field Values

LOCAL_TIME_OPTION

public static final java.lang.String LOCAL_TIME_OPTION
See Also:
Constant Field Values

QUEUE_DUMP_OPTION

public static final java.lang.String QUEUE_DUMP_OPTION
See Also:
Constant Field Values

RERUN_ACTION_OPTION

public static final java.lang.String RERUN_ACTION_OPTION
See Also:
Constant Field Values

RERUN_DATE_OPTION

public static final java.lang.String RERUN_DATE_OPTION
See Also:
Constant Field Values

RERUN_REFRESH_OPTION

public static final java.lang.String RERUN_REFRESH_OPTION
See Also:
Constant Field Values

RERUN_NOCLEANUP_OPTION

public static final java.lang.String RERUN_NOCLEANUP_OPTION
See Also:
Constant Field Values

VERBOSE_OPTION

public static final java.lang.String VERBOSE_OPTION
See Also:
Constant Field Values

VERBOSE_DELIMITER

public static final java.lang.String VERBOSE_DELIMITER
See Also:
Constant Field Values

PIGFILE_OPTION

public static final java.lang.String PIGFILE_OPTION
See Also:
Constant Field Values
Constructor Detail

OozieCLI

public OozieCLI()
Create an Oozie CLI instance.

Method Detail

main

public static void main(java.lang.String[] args)
Entry point for the Oozie CLI when invoked from the command line.

Upon completion this method exits the JVM with '0' (success) or '-1' (failure).

Parameters:
args - options and arguments for the Oozie CLI.

getCLIHelp

protected java.lang.String[] getCLIHelp()
Return Oozie CLI top help lines.

Returns:
help lines.

createAdminOptions

protected org.apache.commons.cli.Options createAdminOptions()

createJobOptions

protected org.apache.commons.cli.Options createJobOptions()

createJobsOptions

protected org.apache.commons.cli.Options createJobsOptions()

createSlaOptions

protected org.apache.commons.cli.Options createSlaOptions()

createPigOptions

protected org.apache.commons.cli.Options createPigOptions()

run

public int run(java.lang.String[] args)
Run a CLI programmatically.

It does not exit the JVM.

A CLI instance can be used only once.

Parameters:
args - options and arguments for the Oozie CLI.
Returns:
'0' (success), '-1' (failure).

getOozieUrl

protected java.lang.String getOozieUrl(org.apache.commons.cli.CommandLine commandLine)

createOozieClient

protected OozieClient createOozieClient(org.apache.commons.cli.CommandLine commandLine)
                                 throws OozieCLIException
Create a OozieClient.

It injects any '-Dheader:' as header to the the OozieClient.

Parameters:
commandLine - the parsed command line options.
Returns:
a pre configured eXtended workflow client.
Throws:
OozieCLIException - thrown if the OozieClient could not be configured.

createXOozieClient

protected XOozieClient createXOozieClient(org.apache.commons.cli.CommandLine commandLine)
                                   throws OozieCLIException
Create a XOozieClient.

It injects any '-Dheader:' as header to the the OozieClient.

Parameters:
commandLine - the parsed command line options.
Returns:
a pre configured eXtended workflow client.
Throws:
OozieCLIException - thrown if the XOozieClient could not be configured.


Copyright © 2010 Yahoo. All Rights Reserved.