org.apache.oozie.client

Class XOozieClient

java.lang.Object

org.apache.oozie.client.OozieClient

org.apache.oozie.client.XOozieClient

Direct Known Subclasses:

AuthOozieClient

public class XOozieClient
extends OozieClient

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.oozie.client.OozieClient

OozieClient.ClientCallable<T>, OozieClient.Instrumentation, OozieClient.MapClientCallable, OozieClient.Metrics, OozieClient.SORT_BY, OozieClient.SYSTEM_MODE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARCHIVES
static java.lang.String	FILES
static java.lang.String	HIVE_OPTIONS
static java.lang.String	HIVE_SCRIPT
static java.lang.String	HIVE_SCRIPT_PARAMS
static java.lang.String	IS_PROXY_SUBMISSION
static java.lang.String	JT
static java.lang.String	JT_2
static java.lang.String	JT_PRINCIPAL Deprecated.
static java.lang.String	NN
static java.lang.String	NN_2
static java.lang.String	NN_PRINCIPAL Deprecated.
static java.lang.String	PIG_OPTIONS
static java.lang.String	PIG_SCRIPT
static java.lang.String	PIG_SCRIPT_PARAMS
static java.lang.String	SQOOP_COMMAND
static java.lang.String	SQOOP_OPTIONS

Fields inherited from class org.apache.oozie.client.OozieClient

ACTION_MAX_RETRIES, ACTION_NOTIFICATION_URL, ACTION_RETRY_INTERVAL, APP_PATH, BUNDLE_APP_PATH, BUNDLE_ID, CHANGE_VALUE_CONCURRENCY, CHANGE_VALUE_ENDTIME, CHANGE_VALUE_PAUSETIME, CHANGE_VALUE_STATUS, COORD_ACTION_NOTIFICATION_PROXY, COORD_ACTION_NOTIFICATION_URL, COORDINATOR_APP_PATH, debugMode, EXTERNAL_ID, FILTER_APPNAME, FILTER_CREATED_TIME_END, FILTER_CREATED_TIME_START, FILTER_FREQUENCY, FILTER_GROUP, FILTER_ID, FILTER_JOBID, FILTER_NAME, FILTER_NOMINAL_TIME, FILTER_SLA_APPNAME, FILTER_SLA_EVENT_STATUS, FILTER_SLA_ID, FILTER_SLA_NOMINAL_END, FILTER_SLA_NOMINAL_START, FILTER_SLA_PARENT_ID, FILTER_SORT_BY, FILTER_STATUS, FILTER_TEXT, FILTER_UNIT, FILTER_USER, GROUP_NAME, JOB_ACL, LIBPATH, LOG_TOKEN, OOZIE_SUSPEND_ON_NODES, RERUN_FAIL_NODES, RERUN_SKIP_NODES, USE_SYSTEM_LIBPATH, USER_NAME, WORKFLOW_NOTIFICATION_PROXY, WORKFLOW_NOTIFICATION_URL, WS_PROTOCOL_VERSION, WS_PROTOCOL_VERSION_0, WS_PROTOCOL_VERSION_1

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XOozieClient()
	XOozieClient(java.lang.String oozieUrl) Create an eXtended Workflow client instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addArchive(java.util.Properties conf, java.lang.String file) The equivalent to tag in oozie's workflow xml.
void	addFile(java.util.Properties conf, java.lang.String file) The equivalent to tag in oozie's workflow xml.
void	setLib(java.util.Properties conf, java.lang.String pathStr) set LIBPATH for HTTP submission job.
java.lang.String	submitMapReduce(java.util.Properties conf) Submit a Map/Reduce job via HTTP.
java.lang.String	submitPig(java.util.Properties conf, java.lang.String pigScriptFile, java.lang.String[] pigArgs) Deprecated.
java.lang.String	submitScriptLanguage(java.util.Properties conf, java.lang.String scriptFile, java.lang.String[] args, java.lang.String jobType) Submit a Pig or Hive job via HTTP.
java.lang.String	submitScriptLanguage(java.util.Properties conf, java.lang.String scriptFile, java.lang.String[] args, java.lang.String[] params, java.lang.String jobType) Submit a Pig or Hive job via HTTP.
java.lang.String	submitSqoop(java.util.Properties conf, java.lang.String[] command, java.lang.String[] args) Submit a Sqoop job via HTTP.

Methods inherited from class org.apache.oozie.client.OozieClient

bulkModifyJobs, change, createConfiguration, createConnection, createRetryableConnection, doAs, dryrun, getAvailableOozieServers, getBulkInfo, getBundleJobInfo, getBundleJobsInfo, getClientBuildVersion, getCoordActionInfo, getCoordJobInfo, getCoordJobInfo, getCoordJobInfo, getCoordJobsInfo, getDebugMode, getHeader, getHeaderNames, getHeaders, getInstrumentation, getJavaSystemProperties, getJMSConnectionInfo, getJMSTopicName, getJobDefinition, getJobId, getJobInfo, getJobInfo, getJobLog, getJobLog, getJobLog, getJobsInfo, getJobsInfo, getMetrics, getOozieUrl, getOSEnv, getProtocolUrl, getQueueDump, getRetryCount, getServerBuildVersion, getServerConfiguration, getSlaInfo, getStatus, getSystemMode, getWfsForCoordAction, getWorkflowActionInfo, ignore, kill, kill, killJobs, listShareLib, notEmpty, notNull, pollJob, removeHeader, reRun, reRunBundle, reRunCoord, reRunCoord, resume, resumeJobs, run, setDebugMode, setHeader, setRetryCount, setSystemMode, start, submit, suspend, suspendJobs, updateCoord, updateCoord, updateShareLib, validateWSVersion, validateXML, writeToXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JT

public static final java.lang.String JT

See Also:

Constant Field Values

JT_2

public static final java.lang.String JT_2

See Also:

Constant Field Values

NN

public static final java.lang.String NN

See Also:

Constant Field Values

NN_2

public static final java.lang.String NN_2

See Also:

Constant Field Values

JT_PRINCIPAL

@Deprecated
public static final java.lang.String JT_PRINCIPAL

Deprecated.

See Also:

Constant Field Values

NN_PRINCIPAL

@Deprecated
public static final java.lang.String NN_PRINCIPAL

Deprecated.

See Also:

Constant Field Values

PIG_SCRIPT

public static final java.lang.String PIG_SCRIPT

See Also:

Constant Field Values

PIG_OPTIONS

public static final java.lang.String PIG_OPTIONS

See Also:

Constant Field Values

PIG_SCRIPT_PARAMS

public static final java.lang.String PIG_SCRIPT_PARAMS

See Also:

Constant Field Values

HIVE_SCRIPT

public static final java.lang.String HIVE_SCRIPT

See Also:

Constant Field Values

HIVE_OPTIONS

public static final java.lang.String HIVE_OPTIONS

See Also:

Constant Field Values

HIVE_SCRIPT_PARAMS

public static final java.lang.String HIVE_SCRIPT_PARAMS

See Also:

Constant Field Values

SQOOP_COMMAND

public static final java.lang.String SQOOP_COMMAND

See Also:

Constant Field Values

SQOOP_OPTIONS

public static final java.lang.String SQOOP_OPTIONS

See Also:

Constant Field Values

FILES

public static final java.lang.String FILES

See Also:

Constant Field Values

ARCHIVES

public static final java.lang.String ARCHIVES

See Also:

Constant Field Values

IS_PROXY_SUBMISSION

public static final java.lang.String IS_PROXY_SUBMISSION

See Also:

Constant Field Values

Constructor Detail

XOozieClient

protected XOozieClient()

XOozieClient

public XOozieClient(java.lang.String oozieUrl)

Create an eXtended Workflow client instance.

Parameters:

oozieUrl - URL of the Oozie instance it will interact with.

Method Detail

submitPig

@Deprecated
public java.lang.String submitPig(java.util.Properties conf,
                                    java.lang.String pigScriptFile,
                                    java.lang.String[] pigArgs)
                           throws java.io.IOException,
                                  OozieClientException

Deprecated.

Submit a Pig job via HTTP.

Parameters:

conf - job configuration.

pigScriptFile - pig script file.

pigArgs - pig arguments string.

Returns:

the job Id.

Throws:

OozieClientException - thrown if the job could not be submitted.

java.io.IOException

submitScriptLanguage

public java.lang.String submitScriptLanguage(java.util.Properties conf,
                                    java.lang.String scriptFile,
                                    java.lang.String[] args,
                                    java.lang.String jobType)
                                      throws java.io.IOException,
                                             OozieClientException

Submit a Pig or Hive job via HTTP.

Parameters:

conf - job configuration.

scriptFile - script file.

args - arguments string.

Returns:

the job Id.

Throws:

OozieClientException - thrown if the job could not be submitted.

java.io.IOException

submitScriptLanguage

public java.lang.String submitScriptLanguage(java.util.Properties conf,
                                    java.lang.String scriptFile,
                                    java.lang.String[] args,
                                    java.lang.String[] params,
                                    java.lang.String jobType)
                                      throws java.io.IOException,
                                             OozieClientException

Submit a Pig or Hive job via HTTP.

Parameters:

conf - job configuration.

scriptFile - script file.

args - arguments string.

params - parameters string.

Returns:

the job Id.

Throws:

OozieClientException - thrown if the job could not be submitted.

java.io.IOException

submitSqoop

public java.lang.String submitSqoop(java.util.Properties conf,
                           java.lang.String[] command,
                           java.lang.String[] args)
                             throws OozieClientException

Submit a Sqoop job via HTTP.

Parameters:

conf - job configuration.

command - sqoop command to run.

args - arguments string.

Returns:

the job Id.

Throws:

OozieClientException - thrown if the job could not be submitted.

submitMapReduce

public java.lang.String submitMapReduce(java.util.Properties conf)
                                 throws OozieClientException

Submit a Map/Reduce job via HTTP.

Parameters:

conf - job configuration.

Returns:

the job Id.

Throws:

OozieClientException - thrown if the job could not be submitted.

setLib

public void setLib(java.util.Properties conf,
          java.lang.String pathStr)

set LIBPATH for HTTP submission job.

Parameters:

conf - Configuration object.

pathStr - lib HDFS path.

addFile

public void addFile(java.util.Properties conf,
           java.lang.String file)

The equivalent to tag in oozie's workflow xml.

Parameters:

conf - Configuration object.

file - file HDFS path. A "#..." symbolic string can be appended to the path to specify symbolic link name. For example, "/user/oozie/parameter_file#myparams". If no "#..." is specified, file name will be used as symbolic link name.

addArchive

public void addArchive(java.util.Properties conf,
              java.lang.String file)

The equivalent to tag in oozie's workflow xml.

Parameters:

conf - Configuration object.

file - file HDFS path. A "#..." symbolic string can be appended to the path to specify symbolic link name. For example, "/user/oozie/udf1.jar#my.jar". If no "#..." is specified, file name will be used as symbolic link name.