public class CoordinatorEngine extends BaseEngine
Modifier and Type | Class and Description |
---|---|
static class |
CoordinatorEngine.FILTER_COMPARATORS |
Modifier and Type | Field and Description |
---|---|
static String |
COORD_ACTIONS_LOG_MAX_COUNT |
static String[] |
VALID_JOB_FILTERS |
USE_XCOMMAND, user
Constructor and Description |
---|
CoordinatorEngine()
Create a system Coordinator engine, with no user and no group.
|
CoordinatorEngine(String user)
Create a Coordinator engine to perform operations on behave of a user.
|
Modifier and Type | Method and Description |
---|---|
void |
change(String jobId,
String changeValue)
Change a coordinator job.
|
String |
dryRunSubmit(org.apache.hadoop.conf.Configuration conf)
Dry run a job; like {@link BaseEngine#submitJob(org.apache.hadoop.conf.Configuration, boolean) but doesn't actually execute
the job.
|
CoordinatorActionBean |
getCoordAction(String actionId) |
CoordinatorJobBean |
getCoordJob(String jobId)
Return the info about a coord job.
|
CoordinatorJobBean |
getCoordJob(String jobId,
String filter,
int offset,
int length,
boolean desc)
Return the info about a coord job with actions subset.
|
CoordinatorJobInfo |
getCoordJobs(String filter,
int start,
int len) |
String |
getDefinition(String jobId)
Return the a job definition.
|
org.apache.oozie.client.WorkflowJob |
getJob(String jobId)
Return the info about a wf job.
|
org.apache.oozie.client.WorkflowJob |
getJob(String jobId,
int start,
int length)
Return the info about a wf job with actions subset.
|
String |
getJobIdForExternalId(String externalId)
Return the workflow Job ID for an external ID.
|
List<WorkflowJobBean> |
getReruns(String coordActionId) |
CoordinatorActionInfo |
ignore(String jobId,
String type,
String scope) |
void |
kill(String jobId)
Kill a job.
|
CoordinatorActionInfo |
killActions(String jobId,
String rangeType,
String scope) |
Map<Pair<String,CoordinatorEngine.FILTER_COMPARATORS>,List<Object>> |
parseJobFilter(String filter) |
void |
reRun(String jobId,
org.apache.hadoop.conf.Configuration conf)
Deprecated.
|
CoordinatorActionInfo |
reRun(String jobId,
String rerunType,
String scope,
boolean refresh,
boolean noCleanup)
Rerun coordinator actions for given rerunType
|
void |
resume(String jobId)
Resume a job.
|
void |
start(String jobId)
Deprecated.
|
void |
streamLog(String jobId,
String logRetrievalScope,
String logRetrievalType,
Writer writer,
Map<String,String[]> params)
Add list of actions to the filter based on conditions
|
void |
streamLog(String jobId,
Writer writer,
Map<String,String[]> params)
Stream the log of a job.
|
String |
submitJob(org.apache.hadoop.conf.Configuration conf,
boolean startJob)
Submit a job.
|
void |
suspend(String jobId)
Suspend a job.
|
String |
updateJob(org.apache.hadoop.conf.Configuration conf,
String jobId,
boolean dryrun,
boolean showDiff)
Update coord job definition.
|
getJMSTopicName, getUser
public static final String COORD_ACTIONS_LOG_MAX_COUNT
public static final String[] VALID_JOB_FILTERS
public CoordinatorEngine()
public CoordinatorEngine(String user)
user
- user name.public String getDefinition(String jobId) throws BaseEngineException
BaseEngine
getDefinition
in class BaseEngine
jobId
- job Id.BaseEngineException
- thrown if the job definition could no be obtained.public CoordinatorActionBean getCoordAction(String actionId) throws BaseEngineException
actionId
- BaseEngineException
public CoordinatorJobBean getCoordJob(String jobId) throws BaseEngineException
BaseEngine
getCoordJob
in class BaseEngine
jobId
- job Id.BaseEngineException
- thrown if the job info could not be obtained.public CoordinatorJobBean getCoordJob(String jobId, String filter, int offset, int length, boolean desc) throws BaseEngineException
BaseEngine
getCoordJob
in class BaseEngine
jobId
- job Id.filter
- the status filteroffset
- starting from this index in the list of actions belonging to the joblength
- number of actions to be returnedBaseEngineException
- thrown if the job info could not be obtained.public String getJobIdForExternalId(String externalId) throws CoordinatorEngineException
BaseEngine
getJobIdForExternalId
in class BaseEngine
externalId
- external ID provided at job submission time.null
if none.CoordinatorEngineException
public void kill(String jobId) throws CoordinatorEngineException
BaseEngine
kill
in class BaseEngine
jobId
- job Id.CoordinatorEngineException
public CoordinatorActionInfo killActions(String jobId, String rangeType, String scope) throws CoordinatorEngineException
CoordinatorEngineException
public void change(String jobId, String changeValue) throws CoordinatorEngineException
BaseEngine
change
in class BaseEngine
jobId
- job Id.changeValue
- change value.CoordinatorEngineException
public CoordinatorActionInfo ignore(String jobId, String type, String scope) throws CoordinatorEngineException
CoordinatorEngineException
@Deprecated public void reRun(String jobId, org.apache.hadoop.conf.Configuration conf) throws BaseEngineException
BaseEngine
reRun
in class BaseEngine
jobId
- job Id to rerun.conf
- configuration information for the rerun.BaseEngineException
- thrown if the job could not be rerun.public CoordinatorActionInfo reRun(String jobId, String rerunType, String scope, boolean refresh, boolean noCleanup) throws BaseEngineException
jobId
- rerunType
- scope
- refresh
- noCleanup
- BaseEngineException
public void resume(String jobId) throws CoordinatorEngineException
BaseEngine
resume
in class BaseEngine
jobId
- job Id.CoordinatorEngineException
@Deprecated public void start(String jobId) throws BaseEngineException
BaseEngine
start
in class BaseEngine
jobId
- job Id.BaseEngineException
- thrown if the job could not be started.public void streamLog(String jobId, Writer writer, Map<String,String[]> params) throws IOException, BaseEngineException
BaseEngine
streamLog
in class BaseEngine
jobId
- job Id.writer
- writer to stream the log to.params
- additional parameters from the requestIOException
- thrown if the log cannot be streamed.BaseEngineException
- thrown if there is error in getting the Workflow/Coordinator Job Information for
jobId.public void streamLog(String jobId, String logRetrievalScope, String logRetrievalType, Writer writer, Map<String,String[]> params) throws IOException, BaseEngineException, CommandException
jobId
- Job IdlogRetrievalScope
- Value for the retrieval typelogRetrievalType
- Based on which filter criteria the log is retrievedwriter
- writer to stream the log toparams
- additional parameters from the requestIOException
BaseEngineException
CommandException
public String submitJob(org.apache.hadoop.conf.Configuration conf, boolean startJob) throws CoordinatorEngineException
BaseEngine
submitJob
in class BaseEngine
conf
- job configuration.startJob
- indicates if the job should be started or not.CoordinatorEngineException
public String dryRunSubmit(org.apache.hadoop.conf.Configuration conf) throws CoordinatorEngineException
BaseEngine
dryRunSubmit
in class BaseEngine
conf
- job configuration.CoordinatorEngineException
public void suspend(String jobId) throws CoordinatorEngineException
BaseEngine
suspend
in class BaseEngine
jobId
- job Id.CoordinatorEngineException
public org.apache.oozie.client.WorkflowJob getJob(String jobId) throws BaseEngineException
BaseEngine
getJob
in class BaseEngine
jobId
- job Id.DagEngineException
- thrown if the job info could not be obtained.BaseEngineException
public org.apache.oozie.client.WorkflowJob getJob(String jobId, int start, int length) throws BaseEngineException
BaseEngine
getJob
in class BaseEngine
jobId
- job Idstart
- starting from this index in the list of actions belonging to the joblength
- number of actions to be returnedDagEngineException
- thrown if the job info could not be obtained.BaseEngineException
public CoordinatorJobInfo getCoordJobs(String filter, int start, int len) throws CoordinatorEngineException
filter
- start
- len
- CoordinatorEngineException
public Map<Pair<String,CoordinatorEngine.FILTER_COMPARATORS>,List<Object>> parseJobFilter(String filter) throws CoordinatorEngineException
CoordinatorEngineException
public List<WorkflowJobBean> getReruns(String coordActionId) throws CoordinatorEngineException
CoordinatorEngineException
public String updateJob(org.apache.hadoop.conf.Configuration conf, String jobId, boolean dryrun, boolean showDiff) throws CoordinatorEngineException
conf
- the confjobId
- the job iddryrun
- the dryrunshowDiff
- the show diffCoordinatorEngineException
- the coordinator engine exceptionCopyright © 2014 Apache Software Foundation. All Rights Reserved.