org.apache.oozie

Class LocalOozieClientCoord

java.lang.Object

org.apache.oozie.client.OozieClient

org.apache.oozie.LocalOozieClientCoord

public class LocalOozieClientCoord
extends OozieClient

Client API to submit and manage Oozie coordinator jobs against an Oozie instance.

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 coordinator application name from the coordinator 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

OozieClient.ClientCallable<T>, OozieClient.Instrumentation, OozieClient.MapClientCallable, OozieClient.Metrics, OozieClient.SORT_BY, 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, CHANGE_VALUE_STATUS, COORD_ACTION_NOTIFICATION_PROXY, COORD_ACTION_NOTIFICATION_URL, COORDINATOR_APP_PATH, debugMode, EXTERNAL_ID, FILTER_APPNAME, FILTER_BUNDLE, 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_SLA_STATUS, 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, SLA_DISABLE_ALERT, SLA_DISABLE_ALERT_COORD, SLA_DISABLE_ALERT_OLDER_THAN, SLA_ENABLE_ALERT, 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

Constructor and Description
LocalOozieClientCoord(CoordinatorEngine coordEngine) Create a coordinator client for Oozie local use.

Method Summary

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)
Properties	createConfiguration()
protected HttpURLConnection	createConnection(URL url, String method)
protected HttpURLConnection	createRetryableConnection(URL url, String method)
String	dryrun(Properties conf)
Map<String,String>	getAvailableOozieServers()
List<BulkResponse>	getBulkInfo(String filter, int start, int len)
BundleJob	getBundleJobInfo(String jobId)
List<BundleJob>	getBundleJobsInfo(String filter, int start, int len)
String	getClientBuildVersion()
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.
CoordinatorJob	getCoordJobInfo(String jobId, String filter, int start, int len, String order)
List<CoordinatorJob>	getCoordJobsInfo(String filter, int start, int len) Return the info of the coordinator jobs that match the filter.
String	getHeader(String name)
Iterator<String>	getHeaderNames()
Map<String,String>	getHeaders()
OozieClient.Instrumentation	getInstrumentation()
Map<String,String>	getJavaSystemProperties()
JMSConnectionInfo	getJMSConnectionInfo()
String	getJMSTopicName(String jobId)
void	getJobAuditLog(String jobId, PrintStream ps)
String	getJobDefinition(String jobId)
void	getJobErrorLog(String jobId, PrintStream ps)
String	getJobId(String externalId)
WorkflowJob	getJobInfo(String jobId)
WorkflowJob	getJobInfo(String jobId, int start, int len)
String	getJobLog(String jobId)
void	getJobLog(String jobId, String logRetrievalType, String logRetrievalScope, PrintStream ps)
void	getJobLog(String jobId, String logRetrievalType, String logRetrievalScope, String logFilter, PrintStream ps)
List<WorkflowJob>	getJobsInfo(String filter)
List<WorkflowJob>	getJobsInfo(String filter, int start, int len)
OozieClient.Metrics	getMetrics()
String	getOozieUrl()
Map<String,String>	getOSEnv()
String	getProtocolUrl()
List<String>	getQueueDump()
String	getServerBuildVersion()
Map<String,String>	getServerConfiguration()
void	getSlaInfo(int start, int len, String filter)
String	getStatus(String jobId)
OozieClient.SYSTEM_MODE	getSystemMode()
List<WorkflowJob>	getWfsForCoordAction(String coordActionId)
WorkflowAction	getWorkflowActionInfo(String actionId)
List<CoordinatorAction>	ignore(String jobId, String scope)
void	kill(String jobId)
List<CoordinatorAction>	kill(String jobId, String rangeType, String scope)
org.json.simple.JSONObject	killJobs(String filter, String jobType, int start, int len)
String	listShareLib(String sharelibKey)
void	pollJob(String id, int timeout, int interval, boolean verbose)
void	removeHeader(String name)
void	reRun(String jobId, Properties conf)
Void	reRunBundle(String jobId, String coordScope, String dateScope, boolean refresh, boolean noCleanup)
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 conf) Rerun coordinator actions with failed option.
void	resume(String jobId)
org.json.simple.JSONObject	resumeJobs(String filter, String jobType, int start, int len)
String	run(Properties conf)
void	setHeader(String name, String value)
void	setSystemMode(OozieClient.SYSTEM_MODE status)
void	slaChange(String jobIds, String actions, String dates, String newSlaParams)
void	slaChange(String bundleId, String actions, String dates, String coords, Map<String,String> newSlaParams)
void	slaChange(String bundleId, String actions, String dates, String coords, String newSlaParams)
void	slaDisableAlert(String jobIds, String actions, String dates)
void	slaDisableAlert(String bundleId, String actions, String dates, String coords)
void	slaEnableAlert(String jobIds, String actions, String dates)
void	slaEnableAlert(String bundleId, String actions, String dates, String coords)
void	start(String jobId)
String	submit(Properties conf)
void	suspend(String jobId)
org.json.simple.JSONObject	suspendJobs(String filter, String jobType, int start, int len)
String	updateCoord(String jobId, Properties conf, String dryrun, String showDiff)
String	updateCoord(String jobId, String dryrun, String showDiff)
String	updateShareLib()
void	validateWSVersion()
String	validateXML(String file)

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

doAs, getCoordActionMissingDependencies, getCoordActionMissingDependencies, getDebugMode, getRetryCount, getWorkflowActionRetriesInfo, mapToString, notEmpty, notNull, purgeCommand, setDebugMode, setRetryCount, writeToXml

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalOozieClientCoord

public LocalOozieClientCoord(CoordinatorEngine coordEngine)

Create a coordinator client for Oozie local use.

Parameters:

coordEngine - the engine instance to use.

Method Detail

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 - if coordinators cannot be rerun

reRunCoord

public List<CoordinatorAction> reRunCoord(String jobId,
                                          String rerunType,
                                          String scope,
                                          boolean refresh,
                                          boolean noCleanup,
                                          boolean failed,
                                          Properties conf)
                                   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

conf - configuration information for the rerun

Throws:

OozieClientException - if coordinators cannot be rerun

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.

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.

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.

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.

updateCoord

public String updateCoord(String jobId,
                          Properties conf,
                          String dryrun,
                          String showDiff)
                   throws OozieClientException

Throws:

OozieClientException

updateCoord

public String updateCoord(String jobId,
                          String dryrun,
                          String showDiff)
                   throws OozieClientException

Throws:

OozieClientException

getCoordJobInfo

public CoordinatorJob getCoordJobInfo(String jobId,
                                      String filter,
                                      int start,
                                      int len,
                                      String order)
                               throws OozieClientException

Throws:

OozieClientException

kill

public List<CoordinatorAction> kill(String jobId,
                                    String rangeType,
                                    String scope)
                             throws OozieClientException

Throws:

OozieClientException

ignore

public List<CoordinatorAction> ignore(String jobId,
                                      String scope)
                               throws OozieClientException

Throws:

OozieClientException

getWfsForCoordAction

public List<WorkflowJob> getWfsForCoordAction(String coordActionId)
                                       throws OozieClientException

Throws:

OozieClientException

getOozieUrl

public String getOozieUrl()

Overrides:

getOozieUrl in class OozieClient

getProtocolUrl

public String getProtocolUrl()
                      throws OozieClientException

Overrides:

getProtocolUrl in class OozieClient

Throws:

OozieClientException

validateWSVersion

public void validateWSVersion()
                       throws OozieClientException

Overrides:

validateWSVersion in class OozieClient

Throws:

OozieClientException

createConfiguration

public Properties createConfiguration()

Overrides:

createConfiguration in class OozieClient

setHeader

public void setHeader(String name,
                      String value)

Overrides:

setHeader in class OozieClient

getHeader

public String getHeader(String name)

Overrides:

getHeader in class OozieClient

removeHeader

public void removeHeader(String name)

Overrides:

removeHeader in class OozieClient

getHeaderNames

public Iterator<String> getHeaderNames()

Overrides:

getHeaderNames in class OozieClient

getHeaders

public Map<String,String> getHeaders()

Overrides:

getHeaders in class OozieClient

submit

public String submit(Properties conf)
              throws OozieClientException

Overrides:

submit in class OozieClient

Throws:

OozieClientException

start

public void start(String jobId)
           throws OozieClientException

Overrides:

start in class OozieClient

Throws:

OozieClientException

run

public String run(Properties conf)
           throws OozieClientException

Overrides:

run in class OozieClient

Throws:

OozieClientException

reRun

public void reRun(String jobId,
                  Properties conf)
           throws OozieClientException

Overrides:

reRun in class OozieClient

Throws:

OozieClientException

suspend

public void suspend(String jobId)
             throws OozieClientException

Overrides:

suspend in class OozieClient

Throws:

OozieClientException

resume

public void resume(String jobId)
            throws OozieClientException

Overrides:

resume in class OozieClient

Throws:

OozieClientException

kill

public void kill(String jobId)
          throws OozieClientException

Overrides:

kill in class OozieClient

Throws:

OozieClientException

dryrun

public String dryrun(Properties conf)
              throws OozieClientException

Overrides:

dryrun in class OozieClient

Throws:

OozieClientException

getStatus

public String getStatus(String jobId)
                 throws OozieClientException

Overrides:

getStatus in class OozieClient

Throws:

OozieClientException

getJobDefinition

public String getJobDefinition(String jobId)
                        throws OozieClientException

Overrides:

getJobDefinition in class OozieClient

Throws:

OozieClientException

getJobId

public String getJobId(String externalId)
                throws OozieClientException

Overrides:

getJobId in class OozieClient

Throws:

OozieClientException

slaEnableAlert

public void slaEnableAlert(String bundleId,
                           String actions,
                           String dates,
                           String coords)
                    throws OozieClientException

Overrides:

slaEnableAlert in class OozieClient

Throws:

OozieClientException

slaEnableAlert

public void slaEnableAlert(String jobIds,
                           String actions,
                           String dates)
                    throws OozieClientException

Overrides:

slaEnableAlert in class OozieClient

Throws:

OozieClientException

slaDisableAlert

public void slaDisableAlert(String bundleId,
                            String actions,
                            String dates,
                            String coords)
                     throws OozieClientException

Overrides:

slaDisableAlert in class OozieClient

Throws:

OozieClientException

slaDisableAlert

public void slaDisableAlert(String jobIds,
                            String actions,
                            String dates)
                     throws OozieClientException

Overrides:

slaDisableAlert in class OozieClient

Throws:

OozieClientException

slaChange

public void slaChange(String bundleId,
                      String actions,
                      String dates,
                      String coords,
                      String newSlaParams)
               throws OozieClientException

Overrides:

slaChange in class OozieClient

Throws:

OozieClientException

slaChange

public void slaChange(String jobIds,
                      String actions,
                      String dates,
                      String newSlaParams)
               throws OozieClientException

Overrides:

slaChange in class OozieClient

Throws:

OozieClientException

slaChange

public void slaChange(String bundleId,
                      String actions,
                      String dates,
                      String coords,
                      Map<String,String> newSlaParams)
               throws OozieClientException

Overrides:

slaChange in class OozieClient

Throws:

OozieClientException

change

public void change(String jobId,
                   String changeValue)
            throws OozieClientException

Overrides:

change in class OozieClient

Throws:

OozieClientException

bulkModifyJobs

public org.json.simple.JSONObject bulkModifyJobs(String actionType,
                                                 String filter,
                                                 String jobType,
                                                 int start,
                                                 int len)
                                          throws OozieClientException

Overrides:

bulkModifyJobs in class OozieClient

Throws:

OozieClientException

killJobs

public org.json.simple.JSONObject killJobs(String filter,
                                           String jobType,
                                           int start,
                                           int len)
                                    throws OozieClientException

Overrides:

killJobs in class OozieClient

Throws:

OozieClientException

suspendJobs

public org.json.simple.JSONObject suspendJobs(String filter,
                                              String jobType,
                                              int start,
                                              int len)
                                       throws OozieClientException

Overrides:

suspendJobs in class OozieClient

Throws:

OozieClientException

resumeJobs

public org.json.simple.JSONObject resumeJobs(String filter,
                                             String jobType,
                                             int start,
                                             int len)
                                      throws OozieClientException

Overrides:

resumeJobs in class OozieClient

Throws:

OozieClientException

getJobInfo

public WorkflowJob getJobInfo(String jobId)
                       throws OozieClientException

Overrides:

getJobInfo in class OozieClient

Throws:

OozieClientException

getJobInfo

public WorkflowJob getJobInfo(String jobId,
                              int start,
                              int len)
                       throws OozieClientException

Overrides:

getJobInfo in class OozieClient

Throws:

OozieClientException

getJobsInfo

public List<WorkflowJob> getJobsInfo(String filter,
                                     int start,
                                     int len)
                              throws OozieClientException

Overrides:

getJobsInfo in class OozieClient

Throws:

OozieClientException

getJobsInfo

public List<WorkflowJob> getJobsInfo(String filter)
                              throws OozieClientException

Overrides:

getJobsInfo in class OozieClient

Throws:

OozieClientException

getBulkInfo

public List<BulkResponse> getBulkInfo(String filter,
                                      int start,
                                      int len)
                               throws OozieClientException

Overrides:

getBulkInfo in class OozieClient

Throws:

OozieClientException

getWorkflowActionInfo

public WorkflowAction getWorkflowActionInfo(String actionId)
                                     throws OozieClientException

Overrides:

getWorkflowActionInfo in class OozieClient

Throws:

OozieClientException

getBundleJobInfo

public BundleJob getBundleJobInfo(String jobId)
                           throws OozieClientException

Overrides:

getBundleJobInfo in class OozieClient

Throws:

OozieClientException

reRunBundle

public Void reRunBundle(String jobId,
                        String coordScope,
                        String dateScope,
                        boolean refresh,
                        boolean noCleanup)
                 throws OozieClientException

Overrides:

reRunBundle in class OozieClient

Throws:

OozieClientException

getBundleJobsInfo

public List<BundleJob> getBundleJobsInfo(String filter,
                                         int start,
                                         int len)
                                  throws OozieClientException

Overrides:

getBundleJobsInfo in class OozieClient

Throws:

OozieClientException

createRetryableConnection

protected HttpURLConnection createRetryableConnection(URL url,
                                                      String method)
                                               throws IOException

Overrides:

createRetryableConnection in class OozieClient

Throws:

IOException

createConnection

protected HttpURLConnection createConnection(URL url,
                                             String method)
                                      throws IOException,
                                             OozieClientException

Overrides:

createConnection in class OozieClient

Throws:

IOException

OozieClientException

getJMSConnectionInfo

public JMSConnectionInfo getJMSConnectionInfo()
                                       throws OozieClientException

Overrides:

getJMSConnectionInfo in class OozieClient

Throws:

OozieClientException

getJobLog

public String getJobLog(String jobId)
                 throws OozieClientException

Overrides:

getJobLog in class OozieClient

Throws:

OozieClientException

getJobAuditLog

public void getJobAuditLog(String jobId,
                           PrintStream ps)
                    throws OozieClientException

Overrides:

getJobAuditLog in class OozieClient

Throws:

OozieClientException

getJobLog

public void getJobLog(String jobId,
                      String logRetrievalType,
                      String logRetrievalScope,
                      String logFilter,
                      PrintStream ps)
               throws OozieClientException

Overrides:

getJobLog in class OozieClient

Throws:

OozieClientException

getJobErrorLog

public void getJobErrorLog(String jobId,
                           PrintStream ps)
                    throws OozieClientException

Overrides:

getJobErrorLog in class OozieClient

Throws:

OozieClientException

getJobLog

public void getJobLog(String jobId,
                      String logRetrievalType,
                      String logRetrievalScope,
                      PrintStream ps)
               throws OozieClientException

Overrides:

getJobLog in class OozieClient

Throws:

OozieClientException

getJMSTopicName

public String getJMSTopicName(String jobId)
                       throws OozieClientException

Overrides:

getJMSTopicName in class OozieClient

Throws:

OozieClientException

getSlaInfo

public void getSlaInfo(int start,
                       int len,
                       String filter)
                throws OozieClientException

Overrides:

getSlaInfo in class OozieClient

Throws:

OozieClientException

setSystemMode

public void setSystemMode(OozieClient.SYSTEM_MODE status)
                   throws OozieClientException

Overrides:

setSystemMode in class OozieClient

Throws:

OozieClientException

getSystemMode

public OozieClient.SYSTEM_MODE getSystemMode()
                                      throws OozieClientException

Overrides:

getSystemMode in class OozieClient

Throws:

OozieClientException

updateShareLib

public String updateShareLib()
                      throws OozieClientException

Overrides:

updateShareLib in class OozieClient

Throws:

OozieClientException

listShareLib

public String listShareLib(String sharelibKey)
                    throws OozieClientException

Overrides:

listShareLib in class OozieClient

Throws:

OozieClientException

getServerBuildVersion

public String getServerBuildVersion()
                             throws OozieClientException

Overrides:

getServerBuildVersion in class OozieClient

Throws:

OozieClientException

getClientBuildVersion

public String getClientBuildVersion()

Overrides:

getClientBuildVersion in class OozieClient

validateXML

public String validateXML(String file)
                   throws OozieClientException

Overrides:

validateXML in class OozieClient

Throws:

OozieClientException

pollJob

public void pollJob(String id,
                    int timeout,
                    int interval,
                    boolean verbose)
             throws OozieClientException

Overrides:

pollJob in class OozieClient

Throws:

OozieClientException

getQueueDump

public List<String> getQueueDump()
                          throws OozieClientException

Overrides:

getQueueDump in class OozieClient

Throws:

OozieClientException

getAvailableOozieServers

public Map<String,String> getAvailableOozieServers()
                                            throws OozieClientException

Overrides:

getAvailableOozieServers in class OozieClient

Throws:

OozieClientException

getServerConfiguration

public Map<String,String> getServerConfiguration()
                                          throws OozieClientException

Overrides:

getServerConfiguration in class OozieClient

Throws:

OozieClientException

getJavaSystemProperties

public Map<String,String> getJavaSystemProperties()
                                           throws OozieClientException

Overrides:

getJavaSystemProperties in class OozieClient

Throws:

OozieClientException

getOSEnv

public Map<String,String> getOSEnv()
                            throws OozieClientException

Overrides:

getOSEnv in class OozieClient

Throws:

OozieClientException

getMetrics

public OozieClient.Metrics getMetrics()
                               throws OozieClientException

Overrides:

getMetrics in class OozieClient

Throws:

OozieClientException

getInstrumentation

public OozieClient.Instrumentation getInstrumentation()
                                               throws OozieClientException

Overrides:

getInstrumentation in class OozieClient

Throws:

OozieClientException