org.apache.oozie.cli

Class OozieCLI

java.lang.Object

org.apache.oozie.cli.OozieCLI

public class OozieCLI
extends java.lang.Object

Oozie command line utility.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_OPTION
static java.lang.String	ADMIN_CMD
static java.lang.String	ALL_WORKFLOWS_FOR_COORD_ACTION
static java.lang.String	AUTH_OPTION
static java.lang.String	AVAILABLE_SERVERS_OPTION
static java.lang.String	BULK_OPTION
static java.lang.String	CHANGE_OPTION
static java.lang.String	CHANGE_VALUE_OPTION
static java.lang.String	CONFIG_CONTENT_OPTION
static java.lang.String	CONFIG_OPTION
static java.lang.String	DATE_OPTION
static java.lang.String	DEBUG_OPTION
static java.lang.String	DEFINITION_OPTION
static java.lang.String	DO_AS_OPTION
static java.lang.String	DRYRUN_OPTION
static java.lang.String	ENV_OOZIE_AUTH
static java.lang.String	ENV_OOZIE_DEBUG
static java.lang.String	ENV_OOZIE_TIME_ZONE
static java.lang.String	ENV_OOZIE_URL
static java.lang.String	FILTER_OPTION
static java.lang.String	HELP_CMD
static java.lang.String	HIVE_CMD
static java.lang.String	IGNORE_OPTION
static java.lang.String	INFO_CMD
static java.lang.String	INFO_OPTION
static java.lang.String	INFO_TIME_ZONES_OPTION
static java.lang.String	INSTRUMENTATION_OPTION
static java.lang.String	INTERVAL_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	LIST_SHARELIB_LIB_OPTION
static java.lang.String	LOCAL_TIME_OPTION
static java.lang.String	LOG_OPTION
static java.lang.String	METRICS_OPTION
static java.lang.String	MR_CMD
static java.lang.String	OFFSET_OPTION
static java.lang.String	OOZIE_OPTION
static java.lang.String	OOZIE_RETRY_COUNT
static java.lang.String	ORDER_OPTION
static java.lang.String	PIG_CMD
static java.lang.String	POLL_OPTION
static java.lang.String	QUEUE_DUMP_OPTION
static java.lang.String	RERUN_COORD_OPTION
static java.lang.String	RERUN_FAILED_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	SCRIPTFILE_OPTION
static java.lang.String	SERVER_CONFIGURATION_OPTION
static java.lang.String	SERVER_JAVA_SYSTEM_PROPERTIES_OPTION
static java.lang.String	SERVER_OS_ENV_OPTION
static java.lang.String	SHOWDIFF_OPTION
static java.lang.String	SLA_CMD
static java.lang.String	SQOOP_CMD
static java.lang.String	SQOOP_COMMAND_OPTION
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	TIME_ZONE_OPTION
static java.lang.String	TIMEOUT_OPTION
static java.lang.String	UPDATE_OPTION
static java.lang.String	UPDATE_SHARELIB_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

Constructors

Constructor and Description
OozieCLI() Create an Oozie CLI instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAuthOptions(org.apache.commons.cli.Options options) Add authentication specific options to oozie cli
protected void	addHeader(OozieClient wc)
protected org.apache.commons.cli.Options	createAdminOptions() Create option for command line option 'admin'
protected org.apache.commons.cli.Options	createInfoOptions() Create option for command line option 'info'
protected org.apache.commons.cli.Options	createJobOptions() Create option for command line option 'job'
protected org.apache.commons.cli.Options	createJobsOptions() Create option for command line option 'jobs'
protected org.apache.commons.cli.Options	createMROptions() Create option for command line option 'mapreduce'
protected OozieClient	createOozieClient(org.apache.commons.cli.CommandLine commandLine) Create a OozieClient.
protected org.apache.commons.cli.Options	createScriptLanguageOptions(java.lang.String jobType) Create option for command line option 'pig' or 'hive'
protected org.apache.commons.cli.Options	createSlaOptions() Create option for command line option 'sla'
protected org.apache.commons.cli.Options	createSqoopCLIOptions() Create option for command line option 'sqoop'
protected org.apache.commons.cli.Options	createValidateOptions() Create option for command line option 'validate'
protected XOozieClient	createXOozieClient(org.apache.commons.cli.CommandLine commandLine) Create a XOozieClient.
protected java.lang.String	getAuthOption(org.apache.commons.cli.CommandLine commandLine) Get auth option from command line
protected java.lang.String[]	getCLIHelp() Return Oozie CLI top help lines.
CLIParser	getCLIParser()
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.
void	processCommand(CLIParser parser, CLIParser.Command command)
int	run(java.lang.String[] args) Run a CLI programmatically.
protected void	setDebugMode(OozieClient wc, boolean debugOpt)
protected void	setRetryCount(OozieClient wc)

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

ENV_OOZIE_DEBUG

public static final java.lang.String ENV_OOZIE_DEBUG

See Also:

Constant Field Values

ENV_OOZIE_TIME_ZONE

public static final java.lang.String ENV_OOZIE_TIME_ZONE

See Also:

Constant Field Values

ENV_OOZIE_AUTH

public static final java.lang.String ENV_OOZIE_AUTH

See Also:

Constant Field Values

OOZIE_RETRY_COUNT

public static final java.lang.String OOZIE_RETRY_COUNT

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

HIVE_CMD

public static final java.lang.String HIVE_CMD

See Also:

Constant Field Values

SQOOP_CMD

public static final java.lang.String SQOOP_CMD

See Also:

Constant Field Values

MR_CMD

public static final java.lang.String MR_CMD

See Also:

Constant Field Values

INFO_CMD

public static final java.lang.String INFO_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

ACTION_OPTION

public static final java.lang.String ACTION_OPTION

See Also:

Constant Field Values

DEFINITION_OPTION

public static final java.lang.String DEFINITION_OPTION

See Also:

Constant Field Values

CONFIG_CONTENT_OPTION

public static final java.lang.String CONFIG_CONTENT_OPTION

See Also:

Constant Field Values

SQOOP_COMMAND_OPTION

public static final java.lang.String SQOOP_COMMAND_OPTION

See Also:

Constant Field Values

SHOWDIFF_OPTION

public static final java.lang.String SHOWDIFF_OPTION

See Also:

Constant Field Values

UPDATE_OPTION

public static final java.lang.String UPDATE_OPTION

See Also:

Constant Field Values

IGNORE_OPTION

public static final java.lang.String IGNORE_OPTION

See Also:

Constant Field Values

POLL_OPTION

public static final java.lang.String POLL_OPTION

See Also:

Constant Field Values

TIMEOUT_OPTION

public static final java.lang.String TIMEOUT_OPTION

See Also:

Constant Field Values

INTERVAL_OPTION

public static final java.lang.String INTERVAL_OPTION

See Also:

Constant Field Values

DO_AS_OPTION

public static final java.lang.String DO_AS_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

TIME_ZONE_OPTION

public static final java.lang.String TIME_ZONE_OPTION

See Also:

Constant Field Values

QUEUE_DUMP_OPTION

public static final java.lang.String QUEUE_DUMP_OPTION

See Also:

Constant Field Values

RERUN_COORD_OPTION

public static final java.lang.String RERUN_COORD_OPTION

See Also:

Constant Field Values

DATE_OPTION

public static final java.lang.String 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

RERUN_FAILED_OPTION

public static final java.lang.String RERUN_FAILED_OPTION

See Also:

Constant Field Values

ORDER_OPTION

public static final java.lang.String ORDER_OPTION

See Also:

Constant Field Values

UPDATE_SHARELIB_OPTION

public static final java.lang.String UPDATE_SHARELIB_OPTION

See Also:

Constant Field Values

LIST_SHARELIB_LIB_OPTION

public static final java.lang.String LIST_SHARELIB_LIB_OPTION

See Also:

Constant Field Values

SERVER_CONFIGURATION_OPTION

public static final java.lang.String SERVER_CONFIGURATION_OPTION

See Also:

Constant Field Values

SERVER_OS_ENV_OPTION

public static final java.lang.String SERVER_OS_ENV_OPTION

See Also:

Constant Field Values

SERVER_JAVA_SYSTEM_PROPERTIES_OPTION

public static final java.lang.String SERVER_JAVA_SYSTEM_PROPERTIES_OPTION

See Also:

Constant Field Values

METRICS_OPTION

public static final java.lang.String METRICS_OPTION

See Also:

Constant Field Values

INSTRUMENTATION_OPTION

public static final java.lang.String INSTRUMENTATION_OPTION

See Also:

Constant Field Values

AUTH_OPTION

public static final java.lang.String AUTH_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

DEBUG_OPTION

public static final java.lang.String DEBUG_OPTION

See Also:

Constant Field Values

SCRIPTFILE_OPTION

public static final java.lang.String SCRIPTFILE_OPTION

See Also:

Constant Field Values

INFO_TIME_ZONES_OPTION

public static final java.lang.String INFO_TIME_ZONES_OPTION

See Also:

Constant Field Values

BULK_OPTION

public static final java.lang.String BULK_OPTION

See Also:

Constant Field Values

AVAILABLE_SERVERS_OPTION

public static final java.lang.String AVAILABLE_SERVERS_OPTION

See Also:

Constant Field Values

ALL_WORKFLOWS_FOR_COORD_ACTION

public static final java.lang.String ALL_WORKFLOWS_FOR_COORD_ACTION

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.

addAuthOptions

protected void addAuthOptions(org.apache.commons.cli.Options options)

Add authentication specific options to oozie cli

Parameters:

options - the collection of options to add auth options

createAdminOptions

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

Create option for command line option 'admin'

Returns:

admin options

createJobOptions

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

Create option for command line option 'job'

Returns:

job options

createJobsOptions

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

Create option for command line option 'jobs'

Returns:

jobs options

createSlaOptions

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

Create option for command line option 'sla'

Returns:

sla options

createValidateOptions

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

Create option for command line option 'validate'

Returns:

validate options

createScriptLanguageOptions

protected org.apache.commons.cli.Options createScriptLanguageOptions(java.lang.String jobType)

Create option for command line option 'pig' or 'hive'

Returns:

pig or hive options

createSqoopCLIOptions

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

Create option for command line option 'sqoop'

Returns:

sqoop options

createInfoOptions

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

Create option for command line option 'info'

Returns:

info options

createMROptions

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

Create option for command line option 'mapreduce'

Returns:

mapreduce options

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).

getCLIParser

public CLIParser getCLIParser()

processCommand

public void processCommand(CLIParser parser,
                  CLIParser.Command command)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getOozieUrl

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

addHeader

protected void addHeader(OozieClient wc)

getAuthOption

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

Get auth option from command line

Parameters:

commandLine - the command line object

Returns:

auth option

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.

setDebugMode

protected void setDebugMode(OozieClient wc,
                boolean debugOpt)

setRetryCount

protected void setRetryCount(OozieClient wc)