OozieClient (Apache Oozie Client 4.3.0 API)

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

Direct Known Subclasses:

XOozieClient
```
public class OozieClient
extends Object
```
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
Modifier and Type	Class and Description
`protected class`	`OozieClient.ClientCallable<T>`
`class`	`OozieClient.Instrumentation`
`protected class`	`OozieClient.MapClientCallable`
`class`	`OozieClient.Metrics`
`static class`	`OozieClient.SORT_BY`
`static class`	`OozieClient.SYSTEM_MODE`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_MAX_RETRIES`
`static String`	`ACTION_NOTIFICATION_URL`
`static String`	`ACTION_RETRY_INTERVAL`
`static String`	`APP_PATH`
`static String`	`BUNDLE_APP_PATH`
`static String`	`BUNDLE_ID`
`static String`	`CHANGE_VALUE_CONCURRENCY`
`static String`	`CHANGE_VALUE_ENDTIME`
`static String`	`CHANGE_VALUE_PAUSETIME`
`static String`	`CHANGE_VALUE_STATUS`
`static String`	`COORD_ACTION_NOTIFICATION_PROXY`
`static String`	`COORD_ACTION_NOTIFICATION_URL`
`static String`	`COORDINATOR_APP_PATH`
`int`	`debugMode` debugMode =0 means no debugging.
`static String`	`EXTERNAL_ID`
`static String`	`FILTER_APPNAME`
`static String`	`FILTER_BUNDLE`
`static String`	`FILTER_CREATED_TIME_END`
`static String`	`FILTER_CREATED_TIME_START`
`static String`	`FILTER_FREQUENCY`
`static String`	`FILTER_GROUP`
`static String`	`FILTER_ID`
`static String`	`FILTER_JOBID`
`static String`	`FILTER_NAME`
`static String`	`FILTER_NOMINAL_TIME`
`static String`	`FILTER_SLA_APPNAME`
`static String`	`FILTER_SLA_EVENT_STATUS`
`static String`	`FILTER_SLA_ID`
`static String`	`FILTER_SLA_NOMINAL_END`
`static String`	`FILTER_SLA_NOMINAL_START`
`static String`	`FILTER_SLA_PARENT_ID`
`static String`	`FILTER_SLA_STATUS`
`static String`	`FILTER_SORT_BY`
`static String`	`FILTER_STATUS`
`static String`	`FILTER_UNIT`
`static String`	`FILTER_USER`
`static String`	`GROUP_NAME` Deprecated.
`static String`	`JOB_ACL`
`static String`	`LIBPATH`
`static String`	`LOG_TOKEN`
`static String`	`OOZIE_SUSPEND_ON_NODES`
`static String`	`RERUN_FAIL_NODES`
`static String`	`RERUN_SKIP_NODES`
`static String`	`SLA_DISABLE_ALERT`
`static String`	`SLA_DISABLE_ALERT_COORD`
`static String`	`SLA_DISABLE_ALERT_OLDER_THAN`
`static String`	`SLA_ENABLE_ALERT`
`static String`	`USE_SYSTEM_LIBPATH`
`static String`	`USER_NAME`
`static String`	`WORKFLOW_NOTIFICATION_PROXY`
`static String`	`WORKFLOW_NOTIFICATION_URL`
`static long`	`WS_PROTOCOL_VERSION`
`static long`	`WS_PROTOCOL_VERSION_0`
`static long`	`WS_PROTOCOL_VERSION_1`

Constructor Summary

Constructors
Modifier Constructor and Description

protected OozieClient()

OozieClient(String oozieUrl)
Create a Workflow client instance.

Constructors
Modifier	Constructor and Description
`protected`	`OozieClient()`
	`OozieClient(String oozieUrl)` Create a Workflow client instance.

Method Summary

Methods
Modifier and Type	Method and Description
`org.json.simple.JSONObject`	`bulkModifyJobs(String actionType, String filter, String jobType, int start, int len)`
`void`	`change(String jobId, String changeValue)` Change a coordinator job.
`Properties`	`createConfiguration()` Create an empty configuration with just the `USER_NAME` set to the JVM user name.
`protected HttpURLConnection`	`createConnection(URL url, String method)` Create http connection to oozie server.
`protected HttpURLConnection`	`createRetryableConnection(URL url, String method)` Create retryable http connection to oozie server.
`static <T> T`	`doAs(String userName, Callable<T> callable)` Allows to impersonate other users in the Oozie server.
`String`	`dryrun(Properties conf)` dryrun for a given job
`Map<String,String>`	`getAvailableOozieServers()` Return the list of available Oozie servers.
`List<BulkResponse>`	`getBulkInfo(String filter, int start, int len)`
`BundleJob`	`getBundleJobInfo(String jobId)` Get the info of a bundle job.
`List<BundleJob>`	`getBundleJobsInfo(String filter, int start, int len)` Return the info of the bundle jobs that match the filter.
`String`	`getClientBuildVersion()` Return the Oozie client build version.
`CoordinatorAction`	`getCoordActionInfo(String actionId)` Get the info of a coordinator action.
`CoordinatorJob`	`getCoordJobInfo(String jobId)` Get the info of a coordinator job.
`CoordinatorJob`	`getCoordJobInfo(String jobId, String filter, int start, int len)` Get the info of a coordinator job and subset actions.
`CoordinatorJob`	`getCoordJobInfo(String jobId, String filter, int start, int len, String order)` Get the info of a coordinator job and subset actions.
`List<CoordinatorJob>`	`getCoordJobsInfo(String filter, int start, int len)` Return the info of the coordinator jobs that match the filter.
`int`	`getDebugMode()`
`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.
`Map<String,String>`	`getHeaders()` Get the set HTTP header
`OozieClient.Instrumentation`	`getInstrumentation()` Return the Oozie instrumentation.
`Map<String,String>`	`getJavaSystemProperties()` Return the Oozie Java system properties.
`JMSConnectionInfo`	`getJMSConnectionInfo()` Get the JMS Connection info
`String`	`getJMSTopicName(String jobId)` Gets the JMS topic name for a particular job
`void`	`getJobAuditLog(String jobId, PrintStream ps)` Get the audit log of a job.
`String`	`getJobDefinition(String jobId)` Get the definition of a workflow job.
`void`	`getJobErrorLog(String jobId, PrintStream ps)` Get the error log of a job.
`String`	`getJobId(String externalId)` Return the workflow job Id for an external Id.
`WorkflowJob`	`getJobInfo(String jobId)` Get the info of a workflow job.
`WorkflowJob`	`getJobInfo(String jobId, int start, int len)` Get the info of a workflow job and subset actions.
`String`	`getJobLog(String jobId)` Get the log of a workflow job.
`void`	`getJobLog(String jobId, String logRetrievalType, String logRetrievalScope, PrintStream ps)` Get the log of a job.
`void`	`getJobLog(String jobId, String logRetrievalType, String logRetrievalScope, String logFilter, PrintStream ps)` Get the log of a job.
`List<WorkflowJob>`	`getJobsInfo(String filter)` Return the info of the workflow jobs that match the filter.
`List<WorkflowJob>`	`getJobsInfo(String filter, int start, int len)` Return the info of the workflow jobs that match the filter.
`OozieClient.Metrics`	`getMetrics()` Return the Oozie metrics.
`String`	`getOozieUrl()` Return the Oozie URL of the workflow client instance.
`Map<String,String>`	`getOSEnv()` Return the Oozie system OS environment.
`String`	`getProtocolUrl()` Return the Oozie URL used by the client and server for WS communications.
`List<String>`	`getQueueDump()` Return the Oozie queue's commands' dump
`int`	`getRetryCount()`
`String`	`getServerBuildVersion()` Return the Oozie server build version.
`Map<String,String>`	`getServerConfiguration()` Return the Oozie system configuration.
`void`	`getSlaInfo(int start, int len, String filter)` Print sla info about coordinator and workflow jobs and actions.
`String`	`getStatus(String jobId)` Gets the status for a particular job (Workflow Job ID, Coordinator Job ID, Coordinator Action ID, or Bundle Job ID).
`OozieClient.SYSTEM_MODE`	`getSystemMode()` Returns if Oozie is in safe mode or not.
`List<WorkflowJob>`	`getWfsForCoordAction(String coordActionId)`
`WorkflowAction`	`getWorkflowActionInfo(String actionId)` Get the info of a workflow action.
`List<CoordinatorAction>`	`ignore(String jobId, String scope)` Ignore a coordinator job.
`void`	`kill(String jobId)` Kill a workflow/coord/bundle job.
`List<CoordinatorAction>`	`kill(String jobId, String rangeType, String scope)` Kill coordinator actions
`org.json.simple.JSONObject`	`killJobs(String filter, String jobType, int start, int len)`
`String`	`listShareLib(String sharelibKey)`
`static String`	`notEmpty(String str, String name)` Check if the string is not null or not empty.
`static <T> T`	`notNull(T obj, String name)` Check if the object is not null.
`void`	`pollJob(String id, int timeout, int interval, boolean verbose)` Poll a job (Workflow Job ID, Coordinator Job ID, Coordinator Action ID, or Bundle Job ID) and return when it has reached a terminal state.
`void`	`removeHeader(String name)` Remove a HTTP header from the workflow client instance.
`void`	`reRun(String jobId, Properties conf)` Rerun a workflow job.
`Void`	`reRunBundle(String jobId, String coordScope, String dateScope, boolean refresh, boolean noCleanup)` Rerun bundle coordinators.
`List<CoordinatorAction>`	`reRunCoord(String jobId, String rerunType, String scope, boolean refresh, boolean noCleanup)` Rerun coordinator actions.
`List<CoordinatorAction>`	`reRunCoord(String jobId, String rerunType, String scope, boolean refresh, boolean noCleanup, boolean failed, Properties props)` Rerun coordinator actions with failed option.
`void`	`resume(String jobId)` Resume a workflow job.
`org.json.simple.JSONObject`	`resumeJobs(String filter, String jobType, int start, int len)`
`String`	`run(Properties conf)` Submit and start a workflow job.
`void`	`setDebugMode(int debugMode)` Set debug mode.
`void`	`setHeader(String name, String value)` Set a HTTP header to be used in the WS requests by the workflow instance.
`void`	`setRetryCount(int retryCount)`
`void`	`setSystemMode(OozieClient.SYSTEM_MODE status)` Enable or disable safe mode.
`void`	`slaChange(String jobIds, String actions, String dates, String newSlaParams)` Sla change definations.
`void`	`slaChange(String bundleId, String actions, String dates, String coords, Map<String,String> newSlaParams)` Sla change with new sla param as hasmap.
`void`	`slaChange(String bundleId, String actions, String dates, String coords, String newSlaParams)` Sla change defination for bundle with coord name/id.
`void`	`slaDisableAlert(String jobIds, String actions, String dates)` Sla disable alert.
`void`	`slaDisableAlert(String bundleId, String actions, String dates, String coords)` Sla disable alert for bundle with coord name/id.
`void`	`slaEnableAlert(String jobIds, String actions, String dates)` Sla enable alert.
`void`	`slaEnableAlert(String bundleId, String actions, String dates, String coords)` Sla enable alert for bundle with coord name/id.
`void`	`start(String jobId)` Start a workflow job.
`String`	`submit(Properties conf)` Submit a workflow job.
`void`	`suspend(String jobId)` Suspend a workflow job.
`org.json.simple.JSONObject`	`suspendJobs(String filter, String jobType, int start, int len)`
`String`	`updateCoord(String jobId, Properties conf, String dryrun, String showDiff)` Update coord definition.
`String`	`updateCoord(String jobId, String dryrun, String showDiff)` Update coord definition without properties.
`String`	`updateShareLib()`
`void`	`validateWSVersion()` Validate that the Oozie client and server instances are protocol compatible.
`String`	`validateXML(String file)` Return the workflow application is valid.
`void`	`writeToXml(Properties props, OutputStream out)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - WS_PROTOCOL_VERSION_0
```
public static final long WS_PROTOCOL_VERSION_0
```
    See Also:
    Constant Field Values
  - WS_PROTOCOL_VERSION_1
```
public static final long WS_PROTOCOL_VERSION_1
```
    See Also:
    Constant Field Values
  - WS_PROTOCOL_VERSION
```
public static final long WS_PROTOCOL_VERSION
```
    See Also:
    Constant Field Values
  - USER_NAME
```
public static final String USER_NAME
```
    See Also:
    Constant Field Values
  - GROUP_NAME
```
@Deprecated
public static final String GROUP_NAME
```
    Deprecated.
    
    See Also:
    Constant Field Values
  - JOB_ACL
```
public static final String JOB_ACL
```
    See Also:
    Constant Field Values
  - APP_PATH
```
public static final String APP_PATH
```
    See Also:
    Constant Field Values
  - COORDINATOR_APP_PATH
```
public static final String COORDINATOR_APP_PATH
```
    See Also:
    Constant Field Values
  - BUNDLE_APP_PATH
```
public static final String BUNDLE_APP_PATH
```
    See Also:
    Constant Field Values
  - BUNDLE_ID
```
public static final String BUNDLE_ID
```
    See Also:
    Constant Field Values
  - EXTERNAL_ID
```
public static final String EXTERNAL_ID
```
    See Also:
    Constant Field Values
  - WORKFLOW_NOTIFICATION_PROXY
```
public static final String WORKFLOW_NOTIFICATION_PROXY
```
    See Also:
    Constant Field Values
  - WORKFLOW_NOTIFICATION_URL
```
public static final String WORKFLOW_NOTIFICATION_URL
```
    See Also:
    Constant Field Values
  - ACTION_NOTIFICATION_URL
```
public static final String ACTION_NOTIFICATION_URL
```
    See Also:
    Constant Field Values
  - COORD_ACTION_NOTIFICATION_URL
```
public static final String COORD_ACTION_NOTIFICATION_URL
```
    See Also:
    Constant Field Values
  - COORD_ACTION_NOTIFICATION_PROXY
```
public static final String COORD_ACTION_NOTIFICATION_PROXY
```
    See Also:
    Constant Field Values
  - RERUN_SKIP_NODES
```
public static final String RERUN_SKIP_NODES
```
    See Also:
    Constant Field Values
  - RERUN_FAIL_NODES
```
public static final String RERUN_FAIL_NODES
```
    See Also:
    Constant Field Values
  - LOG_TOKEN
```
public static final String LOG_TOKEN
```
    See Also:
    Constant Field Values
  - ACTION_MAX_RETRIES
```
public static final String ACTION_MAX_RETRIES
```
    See Also:
    Constant Field Values
  - ACTION_RETRY_INTERVAL
```
public static final String ACTION_RETRY_INTERVAL
```
    See Also:
    Constant Field Values
  - FILTER_USER
```
public static final String FILTER_USER
```
    See Also:
    Constant Field Values
  - FILTER_GROUP
```
public static final String FILTER_GROUP
```
    See Also:
    Constant Field Values
  - FILTER_NAME
```
public static final String FILTER_NAME
```
    See Also:
    Constant Field Values
  - FILTER_STATUS
```
public static final String FILTER_STATUS
```
    See Also:
    Constant Field Values
  - FILTER_NOMINAL_TIME
```
public static final String FILTER_NOMINAL_TIME
```
    See Also:
    Constant Field Values
  - FILTER_FREQUENCY
```
public static final String FILTER_FREQUENCY
```
    See Also:
    Constant Field Values
  - FILTER_ID
```
public static final String FILTER_ID
```
    See Also:
    Constant Field Values
  - FILTER_UNIT
```
public static final String FILTER_UNIT
```
    See Also:
    Constant Field Values
  - FILTER_JOBID
```
public static final String FILTER_JOBID
```
    See Also:
    Constant Field Values
  - FILTER_APPNAME
```
public static final String FILTER_APPNAME
```
    See Also:
    Constant Field Values
  - FILTER_SLA_APPNAME
```
public static final String FILTER_SLA_APPNAME
```
    See Also:
    Constant Field Values
  - FILTER_SLA_ID
```
public static final String FILTER_SLA_ID
```
    See Also:
    Constant Field Values
  - FILTER_SLA_PARENT_ID
```
public static final String FILTER_SLA_PARENT_ID
```
    See Also:
    Constant Field Values
  - FILTER_BUNDLE
```
public static final String FILTER_BUNDLE
```
    See Also:
    Constant Field Values
  - FILTER_SLA_EVENT_STATUS
```
public static final String FILTER_SLA_EVENT_STATUS
```
    See Also:
    Constant Field Values
  - FILTER_SLA_STATUS
```
public static final String FILTER_SLA_STATUS
```
    See Also:
    Constant Field Values
  - FILTER_SLA_NOMINAL_START
```
public static final String FILTER_SLA_NOMINAL_START
```
    See Also:
    Constant Field Values
  - FILTER_SLA_NOMINAL_END
```
public static final String FILTER_SLA_NOMINAL_END
```
    See Also:
    Constant Field Values
  - FILTER_CREATED_TIME_START
```
public static final String FILTER_CREATED_TIME_START
```
    See Also:
    Constant Field Values
  - FILTER_CREATED_TIME_END
```
public static final String FILTER_CREATED_TIME_END
```
    See Also:
    Constant Field Values
  - SLA_DISABLE_ALERT
```
public static final String SLA_DISABLE_ALERT
```
    See Also:
    Constant Field Values
  - SLA_ENABLE_ALERT
```
public static final String SLA_ENABLE_ALERT
```
    See Also:
    Constant Field Values
  - SLA_DISABLE_ALERT_OLDER_THAN
```
public static final String SLA_DISABLE_ALERT_OLDER_THAN
```
    See Also:
    Constant Field Values
  - SLA_DISABLE_ALERT_COORD
```
public static final String SLA_DISABLE_ALERT_COORD
```
    See Also:
    Constant Field Values
  - CHANGE_VALUE_ENDTIME
```
public static final String CHANGE_VALUE_ENDTIME
```
    See Also:
    Constant Field Values
  - CHANGE_VALUE_PAUSETIME
```
public static final String CHANGE_VALUE_PAUSETIME
```
    See Also:
    Constant Field Values
  - CHANGE_VALUE_CONCURRENCY
```
public static final String CHANGE_VALUE_CONCURRENCY
```
    See Also:
    Constant Field Values
  - CHANGE_VALUE_STATUS
```
public static final String CHANGE_VALUE_STATUS
```
    See Also:
    Constant Field Values
  - LIBPATH
```
public static final String LIBPATH
```
    See Also:
    Constant Field Values
  - USE_SYSTEM_LIBPATH
```
public static final String USE_SYSTEM_LIBPATH
```
    See Also:
    Constant Field Values
  - OOZIE_SUSPEND_ON_NODES
```
public static final String OOZIE_SUSPEND_ON_NODES
```
    See Also:
    Constant Field Values
  - FILTER_SORT_BY
```
public static final String FILTER_SORT_BY
```
    See Also:
    Constant Field Values
  - debugMode
```
public int debugMode
```
    debugMode =0 means no debugging. 1 means debugging on.
- Constructor Detail
  - OozieClient
```
protected OozieClient()
```
  - OozieClient
```
public OozieClient(String oozieUrl)
```
    Create a Workflow client instance.
    
    Parameters:
    oozieUrl - URL of the Oozie instance it will interact with.
- Method Detail
  - doAs
```
public static <T> T doAs(String userName,
         Callable<T> callable)
              throws Exception
```
    Allows to impersonate other users in the Oozie server. The current user must be configured as a proxyuser in Oozie.
    IMPORTANT: impersonation happens only with Oozie client requests done within doAs() calls.
    
    Parameters:
    userName - user to impersonate.
    callable - callable with OozieClient calls impersonating the specified user.
    
    Returns:
    any response returned by the Callable.call() method.
    
    Throws:
    
    Exception - thrown by the Callable.call() method.
  - 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.
    
    Returns:
    the Oozie URL of the workflow client instance.
  - getProtocolUrl
```
public String getProtocolUrl()
                      throws 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.
    
    Returns:
    the Oozie URL used by the client and server for communication.
    
    Throws:
    
    OozieClientException - thrown in the client and the server are not protocol compatible.
  - getDebugMode
```
public int getDebugMode()
```
    Returns:
    current debug Mode
  - setDebugMode
```
public void setDebugMode(int debugMode)
```
    Set debug mode.
    
    Parameters:
    debugMode - : 0 means no debugging. 1 means debugging
  - getRetryCount
```
public int getRetryCount()
```
  - setRetryCount
```
public void setRetryCount(int retryCount)
```
  - validateWSVersion
```
public void validateWSVersion()
                       throws OozieClientException
```
    Validate that the Oozie client and server instances are protocol compatible.
    
    Throws:
    
    OozieClientException - thrown in the client and the server are not protocol compatible.
  - createConfiguration
```
public Properties createConfiguration()
```
    Create an empty configuration with just the USER_NAME set to the JVM user name.
    
    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.
    
    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.
    
    Parameters:
    name - header name.
    
    Returns:
    header value, null if not set.
  - getHeaders
```
public Map<String,String> getHeaders()
```
    Get the set HTTP header
    
    Returns:
    map of header key and value
  - removeHeader
```
public void removeHeader(String name)
```
    Remove a HTTP header from the workflow client instance.
    
    Parameters:
    name - header name.
  - getHeaderNames
```
public Iterator<String> getHeaderNames()
```
    Return an iterator with all the header names set in the workflow instance.
    
    Returns:
    header names.
  - createRetryableConnection
```
protected HttpURLConnection createRetryableConnection(URL url,
                                          String method)
                                               throws IOException
```
    Create retryable http connection to oozie server.
    
    Parameters:
    url -
    method -
    
    Returns:
    connection
    
    Throws:
    
    IOException
  - createConnection
```
protected HttpURLConnection createConnection(URL url,
                                 String method)
                                      throws IOException,
                                             OozieClientException
```
    Create http connection to oozie server.
    
    Parameters:
    url -
    method -
    
    Returns:
    connection
    
    Throws:
    
    IOException
    
    OozieClientException
  - writeToXml
```
public void writeToXml(Properties props,
              OutputStream out)
                throws IOException
```
    Throws:
    
    IOException
  - submit
```
public String submit(Properties conf)
              throws OozieClientException
```
    Submit a workflow job.
    
    Parameters:
    conf - job configuration.
    
    Returns:
    the job Id.
    
    Throws:
    
    OozieClientException - thrown if the job could not be submitted.
  - updateCoord
```
public String updateCoord(String jobId,
                 Properties conf,
                 String dryrun,
                 String showDiff)
                   throws OozieClientException
```
    Update coord definition.
    
    Parameters:
    jobId - the job id
    conf - the conf
    dryrun - the dryrun
    showDiff - the show diff
    
    Returns:
    the string
    
    Throws:
    
    OozieClientException - the oozie client exception
  - updateCoord
```
public String updateCoord(String jobId,
                 String dryrun,
                 String showDiff)
                   throws OozieClientException
```
    Update coord definition without properties.
    
    Parameters:
    jobId - the job id
    dryrun - the dryrun
    showDiff - the show diff
    
    Returns:
    the string
    
    Throws:
    
    OozieClientException - the oozie client exception
  - dryrun
```
public String dryrun(Properties conf)
              throws OozieClientException
```
    dryrun for a given job
    
    Parameters:
    conf - Job configuration.
    
    Throws:
    
    OozieClientException
  - start
```
public void start(String jobId)
           throws OozieClientException
```
    Start a workflow job.
    
    Parameters:
    jobId - job Id.
    
    Throws:
    
    OozieClientException - thrown if the job could not be started.
  - run
```
public String run(Properties conf)
           throws OozieClientException
```
    Submit and start a workflow job.
    
    Parameters:
    conf - job configuration.
    
    Returns:
    the job Id.
    
    Throws:
    
    OozieClientException - thrown if the job could not be submitted.
  - reRun
```
public void reRun(String jobId,
         Properties conf)
           throws OozieClientException
```
    Rerun a workflow job.
    
    Parameters:
    jobId - job Id to rerun.
    conf - configuration information for the rerun.
    
    Throws:
    
    OozieClientException - thrown if the job could not be started.
  - suspend
```
public void suspend(String jobId)
             throws OozieClientException
```
    Suspend a workflow job.
    
    Parameters:
    jobId - job Id.
    
    Throws:
    
    OozieClientException - thrown if the job could not be suspended.
  - resume
```
public void resume(String jobId)
            throws OozieClientException
```
    Resume a workflow job.
    
    Parameters:
    jobId - job Id.
    
    Throws:
    
    OozieClientException - thrown if the job could not be resume.
  - kill
```
public void kill(String jobId)
          throws OozieClientException
```
    Kill a workflow/coord/bundle job.
    
    Parameters:
    jobId - job Id.
    
    Throws:
    
    OozieClientException - thrown if the job could not be killed.
  - kill
```
public List<CoordinatorAction> kill(String jobId,
                           String rangeType,
                           String scope)
                             throws OozieClientException
```
    Kill coordinator actions
    
    Parameters:
    jobId - coordinator Job Id
    rangeType - type 'date' if -date is used, 'action-num' if -action is used
    scope - kill scope for date or action nums
    
    Returns:
    list of coordinator actions that underwent kill
    
    Throws:
    
    OozieClientException - thrown if some actions could not be killed.
  - bulkModifyJobs
```
public org.json.simple.JSONObject bulkModifyJobs(String actionType,
                                        String filter,
                                        String jobType,
                                        int start,
                                        int len)
                                          throws OozieClientException
```
    Throws:
    
    OozieClientException
  - killJobs
```
public org.json.simple.JSONObject killJobs(String filter,
                                  String jobType,
                                  int start,
                                  int len)
                                    throws OozieClientException
```
    Throws:
    
    OozieClientException
  - suspendJobs
```
public org.json.simple.JSONObject suspendJobs(String filter,
                                     String jobType,
                                     int start,
                                     int len)
                                       throws OozieClientException
```
    Throws:
    
    OozieClientException
  - resumeJobs
```
public org.json.simple.JSONObject resumeJobs(String filter,
                                    String jobType,
                                    int start,
                                    int len)
                                      throws OozieClientException
```
    Throws:
    
    OozieClientException
  - change
```
public void change(String jobId,
          String changeValue)
            throws OozieClientException
```
    Change a coordinator job.
    
    Parameters:
    jobId - job Id.
    changeValue - change value.
    
    Throws:
    
    OozieClientException - thrown if the job could not be changed.
  - ignore
```
public List<CoordinatorAction> ignore(String jobId,
                             String scope)
                               throws OozieClientException
```
    Ignore a coordinator job.
    
    Parameters:
    jobId - coord job Id.
    scope - list of coord actions to be ignored
    
    Throws:
    
    OozieClientException - thrown if the job could not be changed.
  - getJobInfo
```
public WorkflowJob getJobInfo(String jobId)
                       throws OozieClientException
```
    Get the info of a workflow job.
    
    Parameters:
    jobId - job Id.
    
    Returns:
    the job info.
    
    Throws:
    
    OozieClientException - thrown if the job info could not be retrieved.
  - getJMSConnectionInfo
```
public JMSConnectionInfo getJMSConnectionInfo()
                                       throws OozieClientException
```
    Get the JMS Connection info
    
    Returns:
    JMSConnectionInfo object
    
    Throws:
    
    OozieClientException
  - getJobInfo
```
public WorkflowJob getJobInfo(String jobId,
                     int start,
                     int len)
                       throws OozieClientException
```
    Get the info of a workflow job and subset actions.
    
    Parameters:
    jobId - job Id.
    start - starting index in the list of actions belonging to the job
    len - number of actions to be returned
    
    Returns:
    the job info.
    
    Throws:
    
    OozieClientException - thrown if the job info could not be retrieved.
  - getWorkflowActionInfo
```
public WorkflowAction getWorkflowActionInfo(String actionId)
                                     throws OozieClientException
```
    Get the info of a workflow action.
    
    Parameters:
    actionId - Id.
    
    Returns:
    the workflow action info.
    
    Throws:
    
    OozieClientException - thrown if the job info could not be retrieved.
  - getJobLog
```
public String getJobLog(String jobId)
                 throws OozieClientException
```
    Get the log of a workflow job.
    
    Parameters:
    jobId - job Id.
    
    Returns:
    the job log.
    
    Throws:
    
    OozieClientException - thrown if the job info could not be retrieved.
  - getJobAuditLog
```
public void getJobAuditLog(String jobId,
                  PrintStream ps)
                    throws OozieClientException
```
    Get the audit log of a job.
    
    Parameters:
    jobId -
    ps -
    
    Throws:
    
    OozieClientException
  - getJobLog
```
public void getJobLog(String jobId,
             String logRetrievalType,
             String logRetrievalScope,
             String logFilter,
             PrintStream ps)
               throws OozieClientException
```
    Get the log of a job.
    
    Parameters:
    jobId - job Id.
    logRetrievalType - Based on which filter criteria the log is retrieved
    logRetrievalScope - Value for the retrieval type
    logFilter - log filter
    ps - Printstream of command line interface
    
    Throws:
    
    OozieClientException - thrown if the job info could not be retrieved.
  - getJobErrorLog
```
public void getJobErrorLog(String jobId,
                  PrintStream ps)
                    throws OozieClientException
```
    Get the error log of a job.
    
    Parameters:
    jobId -
    ps -
    
    Throws:
    
    OozieClientException
  - getJobLog
```
public void getJobLog(String jobId,
             String logRetrievalType,
             String logRetrievalScope,
             PrintStream ps)
               throws OozieClientException
```
    Get the log of a job.
    
    Parameters:
    jobId - job Id.
    logRetrievalType - Based on which filter criteria the log is retrieved
    logRetrievalScope - Value for the retrieval type
    ps - Printstream of command line interface
    
    Throws:
    
    OozieClientException - thrown if the job info could not be retrieved.
  - getJMSTopicName
```
public String getJMSTopicName(String jobId)
                       throws OozieClientException
```
    Gets the JMS topic name for a particular job
    
    Parameters:
    jobId - given jobId
    
    Returns:
    the JMS topic name
    
    Throws:
    
    OozieClientException
  - getJobDefinition
```
public String getJobDefinition(String jobId)
                        throws OozieClientException
```
    Get the definition of a workflow job.
    
    Parameters:
    jobId - job Id.
    
    Returns:
    the job log.
    
    Throws:
    
    OozieClientException - thrown if the job info could not be retrieved.
  - getBundleJobInfo
```
public BundleJob getBundleJobInfo(String jobId)
                           throws OozieClientException
```
    Get the info of a bundle job.
    
    Parameters:
    jobId - job Id.
    
    Returns:
    the job info.
    
    Throws:
    
    OozieClientException - thrown if the job info could not be retrieved.
  - getCoordJobInfo
```
public CoordinatorJob getCoordJobInfo(String jobId)
                               throws OozieClientException
```
    Get the info of a coordinator job.
    
    Parameters:
    jobId - job Id.
    
    Returns:
    the job info.
    
    Throws:
    
    OozieClientException - thrown if the job info could not be retrieved.
  - getCoordJobInfo
```
public CoordinatorJob getCoordJobInfo(String jobId,
                             String filter,
                             int start,
                             int len)
                               throws OozieClientException
```
    Get the info of a coordinator job and subset actions.
    
    Parameters:
    jobId - job Id.
    filter - filter the status filter
    start - starting index in the list of actions belonging to the job
    len - number of actions to be returned
    
    Returns:
    the job info.
    
    Throws:
    
    OozieClientException - thrown if the job info could not be retrieved.
  - getCoordJobInfo
```
public CoordinatorJob getCoordJobInfo(String jobId,
                             String filter,
                             int start,
                             int len,
                             String order)
                               throws OozieClientException
```
    Get the info of a coordinator job and subset actions.
    
    Parameters:
    jobId - job Id.
    filter - filter the status filter
    start - starting index in the list of actions belonging to the job
    len - number of actions to be returned
    order - order to list coord actions (e.g, desc)
    
    Returns:
    the job info.
    
    Throws:
    
    OozieClientException - thrown if the job info could not be retrieved.
  - getWfsForCoordAction
```
public List<WorkflowJob> getWfsForCoordAction(String coordActionId)
                                       throws OozieClientException
```
    Throws:
    
    OozieClientException
  - getCoordActionInfo
```
public CoordinatorAction getCoordActionInfo(String actionId)
                                     throws OozieClientException
```
    Get the info of a coordinator action.
    
    Parameters:
    actionId - Id.
    
    Returns:
    the coordinator action info.
    
    Throws:
    
    OozieClientException - thrown if the job info could not be retrieved.
  - reRunCoord
```
public List<CoordinatorAction> reRunCoord(String jobId,
                                 String rerunType,
                                 String scope,
                                 boolean refresh,
                                 boolean noCleanup)
                                   throws OozieClientException
```
    Rerun coordinator actions.
    
    Parameters:
    jobId - coordinator jobId
    rerunType - rerun type 'date' if -date is used, 'action-id' if -action is used
    scope - rerun scope for date or actionIds
    refresh - true if -refresh is given in command option
    noCleanup - true if -nocleanup is given in command option
    
    Throws:
    
    OozieClientException
  - reRunCoord
```
public List<CoordinatorAction> reRunCoord(String jobId,
                                 String rerunType,
                                 String scope,
                                 boolean refresh,
                                 boolean noCleanup,
                                 boolean failed,
                                 Properties props)
                                   throws OozieClientException
```
    Rerun coordinator actions with failed option.
    
    Parameters:
    jobId - coordinator jobId
    rerunType - rerun type 'date' if -date is used, 'action-id' if -action is used
    scope - rerun scope for date or actionIds
    refresh - true if -refresh is given in command option
    noCleanup - true if -nocleanup is given in command option
    failed - true if -failed is given in command option
    
    Throws:
    
    OozieClientException
  - reRunBundle
```
public Void reRunBundle(String jobId,
               String coordScope,
               String dateScope,
               boolean refresh,
               boolean noCleanup)
                 throws OozieClientException
```
    Rerun bundle coordinators.
    
    Parameters:
    jobId - bundle jobId
    coordScope - rerun scope for coordinator jobs
    dateScope - rerun scope for date
    refresh - true if -refresh is given in command option
    noCleanup - true if -nocleanup is given in command option
    
    Throws:
    
    OozieClientException
  - getJobsInfo
```
public List<WorkflowJob> getJobsInfo(String filter,
                            int start,
                            int len)
                              throws OozieClientException
```
    Return the info of the workflow jobs that match the filter.
    
    Parameters:
    filter - job filter. Refer to the OozieClient 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:
    
    OozieClientException - thrown if the jobs info could not be retrieved.
  - getJobsInfo
```
public List<WorkflowJob> getJobsInfo(String filter)
                              throws OozieClientException
```
    Return the info of the workflow jobs that match the filter.
    It returns the first 100 jobs that match the filter.
    
    Parameters:
    filter - job filter. Refer to the OozieClient for the filter syntax.
    
    Returns:
    a list with the workflow jobs info, without node details.
    
    Throws:
    
    OozieClientException - thrown if the jobs info could not be retrieved.
  - slaEnableAlert
```
public void slaEnableAlert(String jobIds,
                  String actions,
                  String dates)
                    throws OozieClientException
```
    Sla enable alert.
    
    Parameters:
    jobIds - the job ids
    actions - comma separated list of action ids or action id ranges
    dates - comma separated list of the nominal times
    
    Throws:
    
    OozieClientException - the oozie client exception
  - slaEnableAlert
```
public void slaEnableAlert(String bundleId,
                  String actions,
                  String dates,
                  String coords)
                    throws OozieClientException
```
    Sla enable alert for bundle with coord name/id.
    
    Parameters:
    bundleId - the bundle id
    actions - comma separated list of action ids or action id ranges
    dates - comma separated list of the nominal times
    coords - the coordinators
    
    Throws:
    
    OozieClientException - the oozie client exception
  - slaDisableAlert
```
public void slaDisableAlert(String jobIds,
                   String actions,
                   String dates)
                     throws OozieClientException
```
    Sla disable alert.
    
    Parameters:
    jobIds - the job ids
    actions - comma separated list of action ids or action id ranges
    dates - comma separated list of the nominal times
    
    Throws:
    
    OozieClientException - the oozie client exception
  - slaDisableAlert
```
public void slaDisableAlert(String bundleId,
                   String actions,
                   String dates,
                   String coords)
                     throws OozieClientException
```
    Sla disable alert for bundle with coord name/id.
    
    Parameters:
    bundleId - the bundle id
    actions - comma separated list of action ids or action id ranges
    dates - comma separated list of the nominal times
    coords - the coordinators
    
    Throws:
    
    OozieClientException - the oozie client exception
  - slaChange
```
public void slaChange(String jobIds,
             String actions,
             String dates,
             String newSlaParams)
               throws OozieClientException
```
    Sla change definations. SLA change definition parameters can be [<key>=<value>,...<key>=<value>] Supported parameter key names are should-start, should-end and max-duration
    
    Parameters:
    jobIds - the job ids
    actions - comma separated list of action ids or action id ranges.
    dates - comma separated list of the nominal times
    newSlaParams - the new sla params
    
    Throws:
    
    OozieClientException - the oozie client exception
  - slaChange
```
public void slaChange(String bundleId,
             String actions,
             String dates,
             String coords,
             String newSlaParams)
               throws OozieClientException
```
    Sla change defination for bundle with coord name/id. SLA change definition parameters can be [<key>=<value>,...<key>=<value>] Supported parameter key names are should-start, should-end and max-duration
    
    Parameters:
    bundleId - the bundle id
    actions - comma separated list of action ids or action id ranges
    dates - comma separated list of the nominal times
    coords - the coords
    newSlaParams - the new sla params
    
    Throws:
    
    OozieClientException - the oozie client exception
  - slaChange
```
public void slaChange(String bundleId,
             String actions,
             String dates,
             String coords,
             Map<String,String> newSlaParams)
               throws OozieClientException
```
    Sla change with new sla param as hasmap. Supported parameter key names are should-start, should-end and max-duration
    
    Parameters:
    bundleId - the bundle id
    actions - comma separated list of action ids or action id ranges
    dates - comma separated list of the nominal times
    coords - the coords
    newSlaParams - the new sla params
    
    Throws:
    
    OozieClientException - the oozie client exception
  - getSlaInfo
```
public void getSlaInfo(int start,
              int len,
              String filter)
                throws OozieClientException
```
    Print sla info about coordinator and workflow jobs and actions.
    
    Parameters:
    start - starting offset
    len - number of results
    
    Throws:
    
    OozieClientException
  - getJobId
```
public String getJobId(String externalId)
                throws OozieClientException
```
    Return the workflow job Id for an external Id.
    The external Id must have provided at job creation time.
    
    Parameters:
    externalId - external Id given at job creation time.
    
    Returns:
    the workflow job Id for an external Id, null if none.
    
    Throws:
    
    OozieClientException - thrown if the operation could not be done.
  - setSystemMode
```
public void setSystemMode(OozieClient.SYSTEM_MODE status)
                   throws OozieClientException
```
    Enable or disable safe mode. Used by OozieCLI. In safe mode, Oozie would not accept any commands except status command to change and view the safe mode status.
    
    Parameters:
    status - true to enable safe mode, false to disable safe mode.
    
    Throws:
    
    OozieClientException - if it fails to set the safe mode status.
  - getSystemMode
```
public OozieClient.SYSTEM_MODE getSystemMode()
                                      throws OozieClientException
```
    Returns if Oozie is in safe mode or not.
    
    Returns:
    true if safe mode is ON
    false if safe mode is OFF
    
    Throws:
    
    OozieClientException - throw if it could not obtain the safe mode status.
  - updateShareLib
```
public String updateShareLib()
                      throws OozieClientException
```
    Throws:
    
    OozieClientException
  - listShareLib
```
public String listShareLib(String sharelibKey)
                    throws OozieClientException
```
    Throws:
    
    OozieClientException
  - getServerBuildVersion
```
public String getServerBuildVersion()
                             throws OozieClientException
```
    Return the Oozie server build version.
    
    Returns:
    the Oozie server build version.
    
    Throws:
    
    OozieClientException - throw if it the server build version could not be retrieved.
  - getClientBuildVersion
```
public String getClientBuildVersion()
```
    Return the Oozie client build version.
    
    Returns:
    the Oozie client build version.
  - validateXML
```
public String validateXML(String file)
                   throws OozieClientException
```
    Return the workflow application is valid.
    
    Parameters:
    file - local file or hdfs file.
    
    Returns:
    the workflow application is valid.
    
    Throws:
    
    OozieClientException - throw if it the workflow application's validation could not be retrieved.
  - getCoordJobsInfo
```
public List<CoordinatorJob> getCoordJobsInfo(String filter,
                                    int start,
                                    int len)
                                      throws OozieClientException
```
    Return the info of the coordinator jobs that match the filter.
    
    Parameters:
    filter - job filter. Refer to the OozieClient for the filter syntax.
    start - jobs offset, base 1.
    len - number of jobs to return.
    
    Returns:
    a list with the coordinator jobs info
    
    Throws:
    
    OozieClientException - thrown if the jobs info could not be retrieved.
  - getBundleJobsInfo
```
public List<BundleJob> getBundleJobsInfo(String filter,
                                int start,
                                int len)
                                  throws OozieClientException
```
    Return the info of the bundle jobs that match the filter.
    
    Parameters:
    filter - job filter. Refer to the OozieClient for the filter syntax.
    start - jobs offset, base 1.
    len - number of jobs to return.
    
    Returns:
    a list with the bundle jobs info
    
    Throws:
    
    OozieClientException - thrown if the jobs info could not be retrieved.
  - getBulkInfo
```
public List<BulkResponse> getBulkInfo(String filter,
                             int start,
                             int len)
                               throws OozieClientException
```
    Throws:
    
    OozieClientException
  - pollJob
```
public void pollJob(String id,
           int timeout,
           int interval,
           boolean verbose)
             throws OozieClientException
```
    Poll a job (Workflow Job ID, Coordinator Job ID, Coordinator Action ID, or Bundle Job ID) and return when it has reached a terminal state. (i.e. FAILED, KILLED, SUCCEEDED)
    
    Parameters:
    id - The Job ID
    timeout - timeout in minutes (negative values indicate no timeout)
    interval - polling interval in minutes (must be positive)
    verbose - if true, the current status will be printed out at each poll; if false, no output
    
    Throws:
    
    OozieClientException - thrown if the job's status could not be retrieved
  - getStatus
```
public String getStatus(String jobId)
                 throws OozieClientException
```
    Gets the status for a particular job (Workflow Job ID, Coordinator Job ID, Coordinator Action ID, or Bundle Job ID).
    
    Parameters:
    jobId - given jobId
    
    Returns:
    the status
    
    Throws:
    
    OozieClientException
  - getQueueDump
```
public List<String> getQueueDump()
                          throws OozieClientException
```
    Return the Oozie queue's commands' dump
    
    Returns:
    the list of strings of callable identification in queue
    
    Throws:
    
    OozieClientException - throw if it the queue dump could not be retrieved.
  - getAvailableOozieServers
```
public Map<String,String> getAvailableOozieServers()
                                            throws OozieClientException
```
    Return the list of available Oozie servers.
    
    Returns:
    the list of available Oozie servers.
    
    Throws:
    
    OozieClientException - throw if it the list of available Oozie servers could not be retrieved.
  - getServerConfiguration
```
public Map<String,String> getServerConfiguration()
                                          throws OozieClientException
```
    Return the Oozie system configuration.
    
    Returns:
    the Oozie system configuration.
    
    Throws:
    
    OozieClientException - throw if the system configuration could not be retrieved.
  - getJavaSystemProperties
```
public Map<String,String> getJavaSystemProperties()
                                           throws OozieClientException
```
    Return the Oozie Java system properties.
    
    Returns:
    the Oozie Java system properties.
    
    Throws:
    
    OozieClientException - throw if the system properties could not be retrieved.
  - getOSEnv
```
public Map<String,String> getOSEnv()
                            throws OozieClientException
```
    Return the Oozie system OS environment.
    
    Returns:
    the Oozie system OS environment.
    
    Throws:
    
    OozieClientException - throw if the system OS environment could not be retrieved.
  - getMetrics
```
public OozieClient.Metrics getMetrics()
                               throws OozieClientException
```
    Return the Oozie metrics. If null is returned, then try getInstrumentation().
    
    Returns:
    the Oozie metrics or null.
    
    Throws:
    
    OozieClientException - throw if the metrics could not be retrieved.
  - getInstrumentation
```
public OozieClient.Instrumentation getInstrumentation()
                                               throws OozieClientException
```
    Return the Oozie instrumentation. If null is returned, then try getMetrics().
    
    Returns:
    the Oozie intstrumentation or null.
    
    Throws:
    
    OozieClientException - throw if the intstrumentation could not be retrieved.
  - notEmpty
```
public static String notEmpty(String str,
              String name)
```
    Check if the string is not null or not empty.
    
    Parameters:
    str -
    name -
    
    Returns:
    string
  - notNull
```
public static <T> T notNull(T obj,
            String name)
```
    Check if the object is not null.
    
    Type Parameters:
    T -
    Parameters:
    obj -
    name -
    
    Returns:
    string

Class OozieClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WS_PROTOCOL_VERSION_0

WS_PROTOCOL_VERSION_1

WS_PROTOCOL_VERSION

USER_NAME

GROUP_NAME

JOB_ACL

APP_PATH

COORDINATOR_APP_PATH

BUNDLE_APP_PATH

BUNDLE_ID

EXTERNAL_ID

WORKFLOW_NOTIFICATION_PROXY

WORKFLOW_NOTIFICATION_URL

ACTION_NOTIFICATION_URL

COORD_ACTION_NOTIFICATION_URL

COORD_ACTION_NOTIFICATION_PROXY

RERUN_SKIP_NODES

RERUN_FAIL_NODES

LOG_TOKEN

ACTION_MAX_RETRIES

ACTION_RETRY_INTERVAL

FILTER_USER

FILTER_GROUP

FILTER_NAME

FILTER_STATUS

FILTER_NOMINAL_TIME

FILTER_FREQUENCY

FILTER_ID

FILTER_UNIT

FILTER_JOBID

FILTER_APPNAME

FILTER_SLA_APPNAME

FILTER_SLA_ID

FILTER_SLA_PARENT_ID

FILTER_BUNDLE

FILTER_SLA_EVENT_STATUS

FILTER_SLA_STATUS

FILTER_SLA_NOMINAL_START

FILTER_SLA_NOMINAL_END

FILTER_CREATED_TIME_START

FILTER_CREATED_TIME_END

SLA_DISABLE_ALERT

SLA_ENABLE_ALERT

SLA_DISABLE_ALERT_OLDER_THAN

SLA_DISABLE_ALERT_COORD

CHANGE_VALUE_ENDTIME

CHANGE_VALUE_PAUSETIME

CHANGE_VALUE_CONCURRENCY

CHANGE_VALUE_STATUS

LIBPATH

USE_SYSTEM_LIBPATH

OOZIE_SUSPEND_ON_NODES

FILTER_SORT_BY

debugMode

Constructor Detail

OozieClient

OozieClient

Method Detail

doAs

getOozieUrl

getProtocolUrl

getDebugMode

setDebugMode

getRetryCount

setRetryCount

validateWSVersion

createConfiguration

setHeader

getHeader

getHeaders

removeHeader

getHeaderNames

createRetryableConnection