org.apache.oozie

Class BaseEngine

java.lang.Object

org.apache.oozie.BaseEngine

Direct Known Subclasses:

BundleEngine, CoordinatorEngine, DagEngine

public abstract class BaseEngine
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseEngine.LOG_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static String	USE_XCOMMAND
protected String	user

Constructor Summary

Constructors

Constructor and Description
BaseEngine()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	change(String jobId, String changeValue) Change a coordinator job.
abstract void	changeSLA(String id, String actions, String dates, String childIds, String newParams) Change SLA properties for job
abstract void	disableSLAAlert(String id, String actions, String dates, String childIds) Disable SLA alert for job
abstract 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.
abstract void	enableSLAAlert(String id, String actions, String dates, String childIds) Enable SLA alert for job
protected void	fetchLog(XLogFilter filter, Date startTime, Date endTime, Writer writer, Map<String,String[]> params, BaseEngine.LOG_TYPE logType)
abstract CoordinatorJob	getCoordJob(String jobId) Return the info about a coord job.
abstract CoordinatorJob	getCoordJob(String jobId, String filter, int start, int length, boolean desc) Return the info about a coord job with actions subset.
abstract String	getDefinition(String jobId) Return the a job definition.
String	getJMSTopicName(String jobId) Return the jms topic name for the job.
abstract WorkflowJob	getJob(String jobId) Return the info about a wf job.
abstract WorkflowJob	getJob(String jobId, int start, int length) Return the info about a wf job with actions subset.
abstract String	getJobIdForExternalId(String externalId) Return the workflow Job ID for an external ID.
abstract String	getJobStatus(String jobId) Return the status for a Job ID
String	getUser() Return the user name.
abstract void	kill(String jobId) Kill a job.
abstract void	reRun(String jobId, org.apache.hadoop.conf.Configuration conf) Rerun a job.
abstract void	resume(String jobId) Resume a job.
abstract void	start(String jobId) Start a job.
abstract void	streamAuditLog(String jobId, Writer writer, Map<String,String[]> params) Stream Audit log of a job.
abstract void	streamErrorLog(String jobId, Writer writer, Map<String,String[]> params) Stream error log of a job.
abstract void	streamLog(String jobId, Writer writer, Map<String,String[]> params) Stream the log of a job.
abstract String	submitJob(org.apache.hadoop.conf.Configuration conf, boolean startJob) Submit a job.
abstract void	suspend(String jobId) Suspend a job.

Methods inherited from class java.lang.Object

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

Field Detail

USE_XCOMMAND

public static final String USE_XCOMMAND

See Also:

Constant Field Values

user

protected String user

Constructor Detail

BaseEngine

public BaseEngine()

Method Detail

getUser

public String getUser()

Return the user name.

Returns:

the user name.

submitJob

public abstract String submitJob(org.apache.hadoop.conf.Configuration conf,
               boolean startJob)
                          throws BaseEngineException

Submit a job.

It validates configuration properties.

Parameters:

conf - job configuration.

startJob - indicates if the job should be started or not.

Returns:

the job Id.

Throws:

BaseEngineException - thrown if the job could not be created.

start

public abstract void start(String jobId)
                    throws BaseEngineException

Start a job.

Parameters:

jobId - job Id.

Throws:

BaseEngineException - thrown if the job could not be started.

resume

public abstract void resume(String jobId)
                     throws BaseEngineException

Resume a job.

Parameters:

jobId - job Id.

Throws:

BaseEngineException - thrown if the job could not be resumed.

suspend

public abstract void suspend(String jobId)
                      throws BaseEngineException

Suspend a job.

Parameters:

jobId - job Id.

Throws:

BaseEngineException - thrown if the job could not be suspended.

kill

public abstract void kill(String jobId)
                   throws BaseEngineException

Kill a job.

Parameters:

jobId - job Id.

Throws:

BaseEngineException - thrown if the job could not be killed.

change

public abstract void change(String jobId,
          String changeValue)
                     throws BaseEngineException

Change a coordinator job.

Parameters:

jobId - job Id.

changeValue - change value.

Throws:

BaseEngineException - thrown if the job could not be changed.

reRun

public abstract void reRun(String jobId,
         org.apache.hadoop.conf.Configuration conf)
                    throws BaseEngineException

Rerun a job.

Parameters:

jobId - job Id to rerun.

conf - configuration information for the rerun.

Throws:

BaseEngineException - thrown if the job could not be rerun.

getJob

public abstract WorkflowJob getJob(String jobId)
                            throws BaseEngineException

Return the info about a wf job.

Parameters:

jobId - job Id.

Returns:

the workflow job info.

Throws:

DagEngineException - thrown if the job info could not be obtained.

BaseEngineException

getJob

public abstract WorkflowJob getJob(String jobId,
                 int start,
                 int length)
                            throws BaseEngineException

Return the info about a wf job with actions subset.

Parameters:

jobId - job Id

start - starting from this index in the list of actions belonging to the job

length - number of actions to be returned

Returns:

the workflow job info.

Throws:

DagEngineException - thrown if the job info could not be obtained.

BaseEngineException

getCoordJob

public abstract CoordinatorJob getCoordJob(String jobId)
                                    throws BaseEngineException

Return the info about a coord job.

Parameters:

jobId - job Id.

Returns:

the coord job info.

Throws:

BaseEngineException - thrown if the job info could not be obtained.

getCoordJob

public abstract CoordinatorJob getCoordJob(String jobId,
                         String filter,
                         int start,
                         int length,
                         boolean desc)
                                    throws BaseEngineException

Return the info about a coord job with actions subset.

Parameters:

jobId - job Id.

filter - the status filter

start - starting from this index in the list of actions belonging to the job

length - number of actions to be returned

order - true if actions are sorted in a descending order of nominal time, false if asc order

Returns:

the coord job info.

Throws:

BaseEngineException - thrown if the job info could not be obtained.

getDefinition

public abstract String getDefinition(String jobId)
                              throws BaseEngineException

Return the a job definition.

Parameters:

jobId - job Id.

Returns:

the job definition.

Throws:

BaseEngineException - thrown if the job definition could no be obtained.

streamLog

public abstract void streamLog(String jobId,
             Writer writer,
             Map<String,String[]> params)
                        throws IOException,
                               BaseEngineException

Stream the log of a job.

Parameters:

jobId - job Id.

writer - writer to stream the log to.

params - additional parameters from the request

Throws:

IOException - thrown if the log cannot be streamed.

BaseEngineException - thrown if there is error in getting the Workflow/Coordinator Job Information for jobId.

streamErrorLog

public abstract void streamErrorLog(String jobId,
                  Writer writer,
                  Map<String,String[]> params)
                             throws IOException,
                                    BaseEngineException

Stream error log of a job.

Parameters:

jobId - job Id.

writer - writer to stream the log to.

params - additional parameters from the request

Throws:

IOException - thrown if the log cannot be streamed.

BaseEngineException - thrown if there is error in getting the Workflow/Coordinator Job Information for jobId.

streamAuditLog

public abstract void streamAuditLog(String jobId,
                  Writer writer,
                  Map<String,String[]> params)
                             throws IOException,
                                    BaseEngineException

Stream Audit log of a job.

Parameters:

jobId - job Id.

writer - writer to stream the log to.

params - additional parameters from the request

Throws:

IOException - thrown if the log cannot be streamed.

BaseEngineException - thrown if there is error in getting the Workflow/Coordinator Job Information for jobId.

getJobIdForExternalId

public abstract String getJobIdForExternalId(String externalId)
                                      throws BaseEngineException

Return the workflow Job ID for an external ID.

This is reverse lookup for recovery purposes.

Parameters:

externalId - external ID provided at job submission time.

Returns:

the associated workflow job ID if any, null if none.

Throws:

BaseEngineException - thrown if the lookup could not be done.

dryRunSubmit

public abstract String dryRunSubmit(org.apache.hadoop.conf.Configuration conf)
                             throws BaseEngineException

Dry run a job; like {@link BaseEngine#submitJob(org.apache.hadoop.conf.Configuration, boolean) but doesn't actually execute the job.

It validates configuration properties.

Parameters:

conf - job configuration.

Returns:

the result of the dryrun

Throws:

BaseEngineException - thrown if there was a problem doing the dryrun

getJMSTopicName

public String getJMSTopicName(String jobId)
                       throws DagEngineException

Return the jms topic name for the job.

Parameters:

jobId - job Id.

Returns:

String the topic name

Throws:

DagEngineException - thrown if the jms info could not be obtained.

getJobStatus

public abstract String getJobStatus(String jobId)
                             throws BaseEngineException

Return the status for a Job ID

Parameters:

jobId - job Id.

Returns:

the job's status

Throws:

BaseEngineException - thrown if the job's status could not be obtained

enableSLAAlert

public abstract void enableSLAAlert(String id,
                  String actions,
                  String dates,
                  String childIds)
                             throws BaseEngineException

Enable SLA alert for job

Parameters:

id -

actions -

dates -

childIds -

Throws:

BaseEngineException

disableSLAAlert

public abstract void disableSLAAlert(String id,
                   String actions,
                   String dates,
                   String childIds)
                              throws BaseEngineException

Disable SLA alert for job

Parameters:

id -

actions -

dates -

childIds -

Throws:

BaseEngineException

changeSLA

public abstract void changeSLA(String id,
             String actions,
             String dates,
             String childIds,
             String newParams)
                        throws BaseEngineException

Change SLA properties for job

Parameters:

id -

actions -

childIds -

newParams -

Throws:

BaseEngineException

fetchLog

protected void fetchLog(XLogFilter filter,
            Date startTime,
            Date endTime,
            Writer writer,
            Map<String,String[]> params,
            BaseEngine.LOG_TYPE logType)
                 throws IOException

Throws:

IOException