public class LocalOozieClient extends OozieClient
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:
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.
OozieClient.ClientCallable<T>, OozieClient.Instrumentation, OozieClient.MapClientCallable, OozieClient.Metrics, OozieClient.SORT_BY, OozieClient.SYSTEM_MODE
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_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 and Description |
---|
LocalOozieClient(DagEngine dagEngine)
Create a workflow client for Oozie local use.
|
Modifier and Type | Method and Description |
---|---|
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.
|
WorkflowJob |
getJobInfo(String jobId)
Get the info of a workflow 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.
|
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.
|
bulkModifyJobs, change, createConnection, createRetryableConnection, doAs, dryrun, getAvailableOozieServers, getBulkInfo, getBundleJobInfo, getBundleJobsInfo, getClientBuildVersion, getCoordActionInfo, getCoordJobInfo, getCoordJobInfo, getCoordJobInfo, getCoordJobsInfo, getDebugMode, getHeaders, getInstrumentation, getJavaSystemProperties, getJMSConnectionInfo, getJMSTopicName, getJobAuditLog, getJobDefinition, getJobErrorLog, getJobInfo, getJobLog, getJobLog, getJobLog, getMetrics, getOSEnv, getQueueDump, getRetryCount, getServerBuildVersion, getServerConfiguration, getSlaInfo, getStatus, getSystemMode, getWfsForCoordAction, getWorkflowActionInfo, ignore, kill, killJobs, listShareLib, notEmpty, notNull, pollJob, reRunBundle, reRunCoord, reRunCoord, resumeJobs, setDebugMode, setRetryCount, setSystemMode, slaChange, slaChange, slaChange, slaDisableAlert, slaDisableAlert, slaEnableAlert, slaEnableAlert, suspendJobs, updateCoord, updateCoord, updateShareLib, validateXML, writeToXml
public LocalOozieClient(DagEngine dagEngine)
dagEngine
- the dag engine instance to use.public String getOozieUrl()
This URL is the base URL fo the Oozie system, with not protocol versioning.
getOozieUrl
in class OozieClient
public String getProtocolUrl() throws OozieClientException
This URL is the original URL plus the versioning element path.
getProtocolUrl
in class OozieClient
OozieClientException
- thrown in the client and the server are not protocol
compatible.public void validateWSVersion() throws OozieClientException
validateWSVersion
in class OozieClient
OozieClientException
- thrown in the client and the server are not protocol
compatible.public Properties createConfiguration()
OozieClient.USER_NAME
set to the JVM user name and the OozieClient.GROUP_NAME
set to 'other'.createConfiguration
in class OozieClient
public void setHeader(String name, String value)
setHeader
in class OozieClient
name
- header name.value
- header value.public String getHeader(String name)
getHeader
in class OozieClient
name
- header name.null
if not set.public void removeHeader(String name)
removeHeader
in class OozieClient
name
- header name.public Iterator<String> getHeaderNames()
getHeaderNames
in class OozieClient
public String submit(Properties conf) throws OozieClientException
submit
in class OozieClient
conf
- job configuration.OozieClientException
- thrown if the job could not be submitted.public void start(String jobId) throws OozieClientException
start
in class OozieClient
jobId
- job Id.OozieClientException
- thrown if the job could not be started.public String run(Properties conf) throws OozieClientException
run
in class OozieClient
conf
- job configuration.OozieClientException
- thrown if the job could not be submitted.public void reRun(String jobId, Properties conf) throws OozieClientException
reRun
in class OozieClient
jobId
- job Id to rerun.conf
- configuration information for the rerun.OozieClientException
- thrown if the job could not be started.public void suspend(String jobId) throws OozieClientException
suspend
in class OozieClient
jobId
- job Id.OozieClientException
- thrown if the job could not be suspended.public void resume(String jobId) throws OozieClientException
resume
in class OozieClient
jobId
- job Id.OozieClientException
- thrown if the job could not be resume.public void kill(String jobId) throws OozieClientException
kill
in class OozieClient
jobId
- job Id.OozieClientException
- thrown if the job could not be killed.public WorkflowJob getJobInfo(String jobId) throws OozieClientException
getJobInfo
in class OozieClient
jobId
- job Id.OozieClientException
- thrown if the job info could not be retrieved.public List<WorkflowJob> getJobsInfo(String filter, int start, int len) throws OozieClientException
getJobsInfo
in class OozieClient
filter
- job filter. Refer to the LocalOozieClient
for the filter syntax.start
- jobs offset, base 1.len
- number of jobs to return.OozieClientException
- thrown if the jobs info could not be retrieved.public List<WorkflowJob> getJobsInfo(String filter) throws OozieClientException
It returns the first 100 jobs that match the filter.
getJobsInfo
in class OozieClient
filter
- job filter. Refer to the LocalOozieClient
for the filter syntax.OozieClientException
- thrown if the jobs info could not be retrieved.public String getJobId(String externalId) throws OozieClientException
The external Id must have provided at job creation time.
getJobId
in class OozieClient
externalId
- external Id given at job creation time.null
if none.OozieClientException
- thrown if the operation could not be done.Copyright © 2018 Apache Software Foundation. All rights reserved.