public class LocalOozieClientCoord extends OozieClient
getJobsInfo(String)
getJobsInfo(String, int, int)
methods:
[NAME=VALUE][;NAME=VALUE]*
.
Valid filter names are:
OozieClient.ClientCallable<T>, OozieClient.Instrumentation, OozieClient.MapClientCallable, OozieClient.Metrics, 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_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 |
---|
LocalOozieClientCoord(CoordinatorEngine coordEngine)
Create a coordinator 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'. |
CoordinatorAction |
getCoordActionInfo(String actionId)
Get the info of a coordinator action.
|
CoordinatorJob |
getCoordJobInfo(String jobId)
Get the info of a coordinator job.
|
List<CoordinatorJob> |
getCoordJobsInfo(String filter,
int start,
int len)
Return the info of the coordinator jobs that match the filter.
|
String |
getHeader(String name)
Get the value of a set HTTP header from the coordinator instance.
|
Iterator<String> |
getHeaderNames()
Return an iterator with all the header names set in the coordinator
instance.
|
WorkflowJob |
getJobInfo(String jobId)
Deprecated.
|
List<WorkflowJob> |
getJobsInfo(String filter)
Deprecated.
|
List<WorkflowJob> |
getJobsInfo(String filter,
int start,
int len)
Deprecated.
|
String |
getOozieUrl()
Return the Oozie URL of the coordinator client instance.
|
String |
getProtocolUrl()
Return the Oozie URL used by the client and server for WS communications.
|
void |
kill(String jobId)
Kill a coordinator job.
|
void |
removeHeader(String name)
Remove a HTTP header from the coordinator client instance.
|
void |
reRun(String jobId,
Properties conf)
Deprecated.
|
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)
Resume a coordinator job.
|
String |
run(Properties conf)
Submit and start a coordinator job.
|
void |
setHeader(String name,
String value)
Set a HTTP header to be used in the WS requests by the coordinator
instance.
|
void |
start(String jobId)
Deprecated.
|
String |
submit(Properties conf)
Submit a coordinator job.
|
void |
suspend(String jobId)
Suspend a coordinator 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, getCoordJobInfo, getCoordJobInfo, getDebugMode, getHeaders, getInstrumentation, getJavaSystemProperties, getJMSConnectionInfo, getJMSTopicName, getJobAuditLog, getJobDefinition, getJobErrorLog, getJobId, getJobInfo, getJobLog, getJobLog, getJobLog, getMetrics, getOSEnv, getQueueDump, getRetryCount, getServerBuildVersion, getServerConfiguration, getSlaInfo, getStatus, getSystemMode, getWfsForCoordAction, getWorkflowActionInfo, ignore, kill, killJobs, listShareLib, notEmpty, notNull, pollJob, reRunBundle, resumeJobs, setDebugMode, setRetryCount, setSystemMode, slaChange, slaChange, slaChange, slaDisableAlert, slaDisableAlert, slaEnableAlert, slaEnableAlert, suspendJobs, updateCoord, updateCoord, updateShareLib, writeToXml
public LocalOozieClientCoord(CoordinatorEngine coordEngine)
coordEngine
- the engine instance to use.public String getOozieUrl()
getOozieUrl
in class OozieClient
public String getProtocolUrl() throws OozieClientException
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.@Deprecated 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.@Deprecated 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 List<CoordinatorAction> reRunCoord(String jobId, String rerunType, String scope, boolean refresh, boolean noCleanup) throws OozieClientException
reRunCoord
in class OozieClient
jobId
- coordinator jobIdrerunType
- rerun type 'date' if -date is used, 'action-id' if
-action is usedscope
- rerun scope for date or actionIdsrefresh
- true if -refresh is given in command optionnoCleanup
- true if -nocleanup is given in command optionOozieClientException
public List<CoordinatorAction> reRunCoord(String jobId, String rerunType, String scope, boolean refresh, boolean noCleanup, boolean failed, Properties conf) throws OozieClientException
reRunCoord
in class OozieClient
jobId
- coordinator jobIdrerunType
- rerun type 'date' if -date is used, 'action-id' if
-action is usedscope
- rerun scope for date or actionIdsrefresh
- true if -refresh is given in command optionnoCleanup
- true if -nocleanup is given in command optionfailed
- true if -failed is given in command optionconf
- configuration information for the rerunOozieClientException
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.@Deprecated 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 CoordinatorJob getCoordJobInfo(String jobId) throws OozieClientException
getCoordJobInfo
in class OozieClient
jobId
- job Id.OozieClientException
- thrown if the job
info could not be retrieved.public CoordinatorAction getCoordActionInfo(String actionId) throws OozieClientException
getCoordActionInfo
in class OozieClient
actionId
- Id.OozieClientException
- thrown if the job info could not be
retrieved.@Deprecated public List<WorkflowJob> getJobsInfo(String filter, int start, int len) throws OozieClientException
getJobsInfo
in class OozieClient
filter
- job filter. Refer to the OozieClient
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<CoordinatorJob> getCoordJobsInfo(String filter, int start, int len) throws OozieClientException
getCoordJobsInfo
in class OozieClient
filter
- job filter. Refer to the OozieClient
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.@Deprecated public List<WorkflowJob> getJobsInfo(String filter) throws OozieClientException
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.Copyright © 2015 Apache Software Foundation. All Rights Reserved.