|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.oozie.client.OozieClient org.apache.oozie.LocalOozieClientCoord
public class LocalOozieClientCoord
Client API to submit and manage Oozie coordinator jobs against an Oozie intance.
This class is thread safe. Syntax for filter for thegetJobsInfo(String)
getJobsInfo(String, int, int)
methods:
[NAME=VALUE][;NAME=VALUE]*
.
Valid filter names are:
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.oozie.client.OozieClient |
---|
org.apache.oozie.client.OozieClient.ClientCallable<T>, org.apache.oozie.client.OozieClient.SYSTEM_MODE |
Field Summary |
---|
Fields inherited from class org.apache.oozie.client.OozieClient |
---|
ACTION_MAX_RETRIES, ACTION_NOTIFICATION_URL, ACTION_RETRY_INTERVAL, APP_PATH, BUNDLE_APP_PATH, BUNDLE_ID, CHANGE_VALUE_CONCURRENCY, CHANGE_VALUE_ENDTIME, CHANGE_VALUE_PAUSETIME, COORD_ACTION_NOTIFICATION_URL, COORDINATOR_APP_PATH, debugMode, EXTERNAL_ID, FILTER_APPNAME, FILTER_FREQUENCY, FILTER_GROUP, FILTER_ID, FILTER_JOBID, FILTER_NAME, FILTER_STATUS, FILTER_UNIT, FILTER_USER, GROUP_NAME, JOB_ACL, LIBPATH, LOG_TOKEN, RERUN_FAIL_NODES, RERUN_SKIP_NODES, USE_SYSTEM_LIBPATH, USER_NAME, WORKFLOW_NOTIFICATION_URL, WS_PROTOCOL_VERSION, WS_PROTOCOL_VERSION_0 |
Constructor Summary | |
---|---|
LocalOozieClientCoord(CoordinatorEngine coordEngine)
Create a coordinator client for Oozie local use. |
Method Summary | |
---|---|
Properties |
createConfiguration()
Create an empty configuration with just the OozieClient.USER_NAME set to the
JVM user name and the OozieClient.GROUP_NAME set to 'other'. |
org.apache.oozie.client.CoordinatorAction |
getCoordActionInfo(String actionId)
Get the info of a coordinator action. |
org.apache.oozie.client.CoordinatorJob |
getCoordJobInfo(String jobId)
Get the info of a coordinator job. |
List<org.apache.oozie.client.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. |
org.apache.oozie.client.WorkflowJob |
getJobInfo(String jobId)
Deprecated. |
List<org.apache.oozie.client.WorkflowJob> |
getJobsInfo(String filter)
Deprecated. |
List<org.apache.oozie.client.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<org.apache.oozie.client.CoordinatorAction> |
reRunCoord(String jobId,
String rerunType,
String scope,
boolean refresh,
boolean noCleanup)
Rerun coordinator actions. |
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. |
Methods inherited from class org.apache.oozie.client.OozieClient |
---|
change, createConnection, doAs, dryrun, getBulkInfo, getBundleJobInfo, getBundleJobsInfo, getClientBuildVersion, getCoordJobInfo, getDebugMode, getHeaders, getJobDefinition, getJobId, getJobInfo, getJobLog, getJobLog, getQueueDump, getServerBuildVersion, getSlaInfo, getSystemMode, getWorkflowActionInfo, notEmpty, notNull, reRunBundle, setDebugMode, setSystemMode, writeToXml |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LocalOozieClientCoord(CoordinatorEngine coordEngine)
coordEngine
- the engine instance to use.Method Detail |
---|
public String getOozieUrl()
getOozieUrl
in class org.apache.oozie.client.OozieClient
public String getProtocolUrl() throws org.apache.oozie.client.OozieClientException
getProtocolUrl
in class org.apache.oozie.client.OozieClient
org.apache.oozie.client.OozieClientException
- thrown in the client
and the server are not protocol compatible.public void validateWSVersion() throws org.apache.oozie.client.OozieClientException
validateWSVersion
in class org.apache.oozie.client.OozieClient
org.apache.oozie.client.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 org.apache.oozie.client.OozieClient
public void setHeader(String name, String value)
setHeader
in class org.apache.oozie.client.OozieClient
name
- header name.value
- header value.public String getHeader(String name)
getHeader
in class org.apache.oozie.client.OozieClient
name
- header name.
null
if not set.public void removeHeader(String name)
removeHeader
in class org.apache.oozie.client.OozieClient
name
- header name.public Iterator<String> getHeaderNames()
getHeaderNames
in class org.apache.oozie.client.OozieClient
public String submit(Properties conf) throws org.apache.oozie.client.OozieClientException
submit
in class org.apache.oozie.client.OozieClient
conf
- job configuration.
org.apache.oozie.client.OozieClientException
- thrown if the job
could not be submitted.@Deprecated public void start(String jobId) throws org.apache.oozie.client.OozieClientException
start
in class org.apache.oozie.client.OozieClient
jobId
- job Id.
org.apache.oozie.client.OozieClientException
- thrown if the job
could not be started.public String run(Properties conf) throws org.apache.oozie.client.OozieClientException
run
in class org.apache.oozie.client.OozieClient
conf
- job configuration.
org.apache.oozie.client.OozieClientException
- thrown if the job
could not be submitted.@Deprecated public void reRun(String jobId, Properties conf) throws org.apache.oozie.client.OozieClientException
reRun
in class org.apache.oozie.client.OozieClient
jobId
- job Id to rerun.conf
- configuration information for the rerun.
org.apache.oozie.client.OozieClientException
- thrown if the job
could not be started.public List<org.apache.oozie.client.CoordinatorAction> reRunCoord(String jobId, String rerunType, String scope, boolean refresh, boolean noCleanup) throws org.apache.oozie.client.OozieClientException
reRunCoord
in class org.apache.oozie.client.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 option
org.apache.oozie.client.OozieClientException
public void suspend(String jobId) throws org.apache.oozie.client.OozieClientException
suspend
in class org.apache.oozie.client.OozieClient
jobId
- job Id.
org.apache.oozie.client.OozieClientException
- thrown if the job
could not be suspended.public void resume(String jobId) throws org.apache.oozie.client.OozieClientException
resume
in class org.apache.oozie.client.OozieClient
jobId
- job Id.
org.apache.oozie.client.OozieClientException
- thrown if the job
could not be resume.public void kill(String jobId) throws org.apache.oozie.client.OozieClientException
kill
in class org.apache.oozie.client.OozieClient
jobId
- job Id.
org.apache.oozie.client.OozieClientException
- thrown if the job
could not be killed.@Deprecated public org.apache.oozie.client.WorkflowJob getJobInfo(String jobId) throws org.apache.oozie.client.OozieClientException
getJobInfo
in class org.apache.oozie.client.OozieClient
jobId
- job Id.
org.apache.oozie.client.OozieClientException
- thrown if the job
info could not be retrieved.public org.apache.oozie.client.CoordinatorJob getCoordJobInfo(String jobId) throws org.apache.oozie.client.OozieClientException
getCoordJobInfo
in class org.apache.oozie.client.OozieClient
jobId
- job Id.
org.apache.oozie.client.OozieClientException
- thrown if the job
info could not be retrieved.public org.apache.oozie.client.CoordinatorAction getCoordActionInfo(String actionId) throws org.apache.oozie.client.OozieClientException
getCoordActionInfo
in class org.apache.oozie.client.OozieClient
actionId
- Id.
org.apache.oozie.client.OozieClientException
- thrown if the job info could not be
retrieved.@Deprecated public List<org.apache.oozie.client.WorkflowJob> getJobsInfo(String filter, int start, int len) throws org.apache.oozie.client.OozieClientException
getJobsInfo
in class org.apache.oozie.client.OozieClient
filter
- job filter. Refer to the OozieClient
for the filter
syntax.start
- jobs offset, base 1.len
- number of jobs to return.
org.apache.oozie.client.OozieClientException
- thrown if the jobs info could not be
retrieved.public List<org.apache.oozie.client.CoordinatorJob> getCoordJobsInfo(String filter, int start, int len) throws org.apache.oozie.client.OozieClientException
getCoordJobsInfo
in class org.apache.oozie.client.OozieClient
filter
- job filter. Refer to the OozieClient
for the filter
syntax.start
- jobs offset, base 1.len
- number of jobs to return.
org.apache.oozie.client.OozieClientException
- thrown if the jobs info could not be
retrieved.@Deprecated public List<org.apache.oozie.client.WorkflowJob> getJobsInfo(String filter) throws org.apache.oozie.client.OozieClientException
getJobsInfo
in class org.apache.oozie.client.OozieClient
filter
- job filter. Refer to the LocalOozieClient
for the
filter syntax.
org.apache.oozie.client.OozieClientException
- thrown if the jobs
info could not be retrieved.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |