This project has retired. For details please refer to its Attic page.

org.apache.oozie
Class LocalOozieClient

java.lang.Object
  org.apache.oozie.client.OozieClient
      org.apache.oozie.LocalOozieClient

public class LocalOozieClient
extends org.apache.oozie.client.OozieClient

Client API to submit and manage Oozie workflow jobs against an Oozie intance.

This class is thread safe.

Syntax for filter for the getJobsInfo(String) getJobsInfo(String, int, int) methods: [NAME=VALUE][;NAME=VALUE]*.

Valid filter names are:

• name: the workflow application name from the workflow definition.
• user: the user that submitted the job.
• group: the group for the job.
• status: the status of the job.

The query will do an AND among all the filter names. The query will do an OR among all the filter values for the same name. Multiple values must be specified as different name value pairs.

Nested Class Summary

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

org.apache.oozie.client.OozieClient.ClientCallable<T>, org.apache.oozie.client.OozieClient.SYSTEM_MODE

Field Summary

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, COORD_ACTION_NOTIFICATION_URL, COORDINATOR_APP_PATH, debugMode, EXTERNAL_ID, FILTER_FREQUENCY, FILTER_GROUP, FILTER_ID, FILTER_NAME, FILTER_STATUS, FILTER_UNIT, FILTER_USER, GROUP_NAME, JOB_ACL, LIBPATH, LOG_TOKEN, RERUN_FAIL_NODES, RERUN_SKIP_NODES, USE_SYSTEM_LIBPATH, USER_NAME, WORKFLOW_NOTIFICATION_URL, WS_PROTOCOL_VERSION, WS_PROTOCOL_VERSION_0

Constructor Summary

LocalOozieClient(DagEngine dagEngine)
Create a workflow client for Oozie local use.

Method Summary

Properties	createConfiguration() Create an empty configuration with just the OozieClient.USER_NAME set to the JVM user name and the OozieClient.GROUP_NAME set to 'other'.
String	getHeader(String name) Get the value of a set HTTP header from the workflow instance.
Iterator<String>	getHeaderNames() Return an iterator with all the header names set in the workflow instance.
String	getJobId(String externalId) Return the workflow job Id for an external Id.
org.apache.oozie.client.WorkflowJob	getJobInfo(String jobId) Get the info of a workflow job.
List<org.apache.oozie.client.WorkflowJob>	getJobsInfo(String filter) Return the info of the workflow jobs that match the filter.
List<org.apache.oozie.client.WorkflowJob>	getJobsInfo(String filter, int start, int len) Return the info of the workflow jobs that match the filter.
String	getOozieUrl() Return the Oozie URL of the workflow client instance.
String	getProtocolUrl() Return the Oozie URL used by the client and server for WS communications.
void	kill(String jobId) Kill a workflow job.
void	removeHeader(String name) Remove a HTTP header from the workflow client instance.
void	reRun(String jobId, Properties conf) Rerun a workflow job.
void	resume(String jobId) Resume a workflow job.
String	run(Properties conf) Submit and start a workflow job.
void	setHeader(String name, String value) Set a HTTP header to be used in the WS requests by the workflow instance.
void	start(String jobId) Start a workflow job.
String	submit(Properties conf) Submit a workflow job.
void	suspend(String jobId) Suspend a workflow job.
void	validateWSVersion() Validate that the Oozie client and server instances are protocol compatible.

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

change, createConnection, doAs, dryrun, getBulkInfo, getBundleJobInfo, getBundleJobsInfo, getClientBuildVersion, getCoordActionInfo, getCoordJobInfo, getCoordJobInfo, getCoordJobsInfo, getDebugMode, getHeaders, getJobDefinition, getJobInfo, getJobLog, getJobLog, getQueueDump, getServerBuildVersion, getSlaInfo, getSystemMode, getWorkflowActionInfo, notEmpty, notNull, reRunBundle, reRunCoord, setDebugMode, setSystemMode, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalOozieClient

public LocalOozieClient(DagEngine dagEngine)

Create a workflow client for Oozie local use.

Parameters:

dagEngine - the dag engine instance to use.

Method Detail

getOozieUrl

public String getOozieUrl()

Return the Oozie URL of the workflow client instance.

This URL is the base URL fo the Oozie system, with not protocol versioning.

Overrides:

getOozieUrl in class org.apache.oozie.client.OozieClient

Returns:

the Oozie URL of the workflow client instance.

getProtocolUrl

public String getProtocolUrl()
                      throws org.apache.oozie.client.OozieClientException

Return the Oozie URL used by the client and server for WS communications.

This URL is the original URL plus the versioning element path.

Overrides:

getProtocolUrl in class org.apache.oozie.client.OozieClient

Returns:

the Oozie URL used by the client and server for communication.

Throws:

org.apache.oozie.client.OozieClientException - thrown in the client and the server are not protocol compatible.

validateWSVersion

public void validateWSVersion()
                       throws org.apache.oozie.client.OozieClientException

Validate that the Oozie client and server instances are protocol compatible.

Overrides:

validateWSVersion in class org.apache.oozie.client.OozieClient

Throws:

org.apache.oozie.client.OozieClientException - thrown in the client and the server are not protocol compatible.

createConfiguration

public Properties createConfiguration()

Create an empty configuration with just the OozieClient.USER_NAME set to the JVM user name and the OozieClient.GROUP_NAME set to 'other'.

Overrides:

createConfiguration in class org.apache.oozie.client.OozieClient

Returns:

an empty configuration.

setHeader

public void setHeader(String name,
                      String value)

Set a HTTP header to be used in the WS requests by the workflow instance.

Overrides:

setHeader in class org.apache.oozie.client.OozieClient

Parameters:

name - header name.

value - header value.

getHeader

public String getHeader(String name)

Get the value of a set HTTP header from the workflow instance.

Overrides:

getHeader in class org.apache.oozie.client.OozieClient

Parameters:

name - header name.

Returns:

header value, null if not set.

removeHeader

public void removeHeader(String name)

Remove a HTTP header from the workflow client instance.

Overrides:

removeHeader in class org.apache.oozie.client.OozieClient

Parameters:

name - header name.

getHeaderNames

public Iterator<String> getHeaderNames()

Return an iterator with all the header names set in the workflow instance.

Overrides:

getHeaderNames in class org.apache.oozie.client.OozieClient

Returns:

header names.

submit

public String submit(Properties conf)
              throws org.apache.oozie.client.OozieClientException

Submit a workflow job.

Overrides:

submit in class org.apache.oozie.client.OozieClient

Parameters:

conf - job configuration.

Returns:

the job Id.

Throws:

org.apache.oozie.client.OozieClientException - thrown if the job could not be submitted.

start

public void start(String jobId)
           throws org.apache.oozie.client.OozieClientException

Start a workflow job.

Overrides:

start in class org.apache.oozie.client.OozieClient

Parameters:

jobId - job Id.

Throws:

org.apache.oozie.client.OozieClientException - thrown if the job could not be started.

run

public String run(Properties conf)
           throws org.apache.oozie.client.OozieClientException

Submit and start a workflow job.

Overrides:

run in class org.apache.oozie.client.OozieClient

Parameters:

conf - job configuration.

Returns:

the job Id.

Throws:

org.apache.oozie.client.OozieClientException - thrown if the job could not be submitted.

reRun

public void reRun(String jobId,
                  Properties conf)
           throws org.apache.oozie.client.OozieClientException

Rerun a workflow job.

Overrides:

reRun in class org.apache.oozie.client.OozieClient

Parameters:

jobId - job Id to rerun.

conf - configuration information for the rerun.

Throws:

org.apache.oozie.client.OozieClientException - thrown if the job could not be started.

suspend

public void suspend(String jobId)
             throws org.apache.oozie.client.OozieClientException

Suspend a workflow job.

Overrides:

suspend in class org.apache.oozie.client.OozieClient

Parameters:

jobId - job Id.

Throws:

org.apache.oozie.client.OozieClientException - thrown if the job could not be suspended.

resume

public void resume(String jobId)
            throws org.apache.oozie.client.OozieClientException

Resume a workflow job.

Overrides:

resume in class org.apache.oozie.client.OozieClient

Parameters:

jobId - job Id.

Throws:

org.apache.oozie.client.OozieClientException - thrown if the job could not be resume.

kill

public void kill(String jobId)
          throws org.apache.oozie.client.OozieClientException

Kill a workflow job.

Overrides:

kill in class org.apache.oozie.client.OozieClient

Parameters:

jobId - job Id.

Throws:

org.apache.oozie.client.OozieClientException - thrown if the job could not be killed.

getJobInfo

public org.apache.oozie.client.WorkflowJob getJobInfo(String jobId)
                                               throws org.apache.oozie.client.OozieClientException

Get the info of a workflow job.

Overrides:

getJobInfo in class org.apache.oozie.client.OozieClient

Parameters:

jobId - job Id.

Returns:

the job info.

Throws:

org.apache.oozie.client.OozieClientException - thrown if the job info could not be retrieved.

getJobsInfo

public List<org.apache.oozie.client.WorkflowJob> getJobsInfo(String filter,
                                                             int start,
                                                             int len)
                                                      throws org.apache.oozie.client.OozieClientException

Return the info of the workflow jobs that match the filter.

Overrides:

getJobsInfo in class org.apache.oozie.client.OozieClient

Parameters:

filter - job filter. Refer to the LocalOozieClient for the filter syntax.

start - jobs offset, base 1.

len - number of jobs to return.

Returns:

a list with the workflow jobs info, without node details.

Throws:

org.apache.oozie.client.OozieClientException - thrown if the jobs info could not be retrieved.

getJobsInfo

public List<org.apache.oozie.client.WorkflowJob> getJobsInfo(String filter)
                                                      throws org.apache.oozie.client.OozieClientException

Return the info of the workflow jobs that match the filter.

It returns the first 100 jobs that match the filter.

Overrides:

getJobsInfo in class org.apache.oozie.client.OozieClient

Parameters:

filter - job filter. Refer to the LocalOozieClient for the filter syntax.

Returns:

a list with the workflow jobs info, without node details.

Throws:

org.apache.oozie.client.OozieClientException - thrown if the jobs info could not be retrieved.

getJobId

public String getJobId(String externalId)
                throws org.apache.oozie.client.OozieClientException

Return the workflow job Id for an external Id.

The external Id must have provided at job creation time.

Overrides:

getJobId in class org.apache.oozie.client.OozieClient

Parameters:

externalId - external Id given at job creation time.

Returns:

the workflow job Id for an external Id, null if none.

Throws:

org.apache.oozie.client.OozieClientException - thrown if the operation could not be done.