org.apache.oozie.servlet

Class V2JobServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.oozie.servlet.JsonRestServlet

org.apache.oozie.servlet.BaseJobServlet

org.apache.oozie.servlet.V1JobServlet

org.apache.oozie.servlet.V2JobServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class V2JobServlet
extends V1JobServlet

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.oozie.servlet.JsonRestServlet

JsonRestServlet.ParameterInfo, JsonRestServlet.ResourceInfo

Field Summary

Fields inherited from class org.apache.oozie.servlet.V1JobServlet

COORD_ACTIONS_DEFAULT_LENGTH

Fields inherited from class org.apache.oozie.servlet.JsonRestServlet

AUDIT_ERROR_CODE, AUDIT_ERROR_MESSAGE, AUDIT_HTTP_STATUS_CODE, AUDIT_OPERATION, AUDIT_PARAM, AUTH_TOKEN, INSTRUMENTATION_GROUP, TEXT_UTF8, UNDEF, USER_NAME, XML_UTF8

Constructor Summary

Constructors

Constructor and Description
V2JobServlet()

Method Summary

Modifier and Type	Method and Description
BaseEngine	getBaseEngine(String jobId, String user) Gets the base engine based on jobId.
protected org.json.simple.JSONObject	getCoordActionMissingDependencies(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Abstract method to get the coord action missing dependencies.
protected int	getCoordinatorJobLength(int defaultLen, int len) Given the requested length and the default length, determine how many coordinator jobs to return.
protected String	getJMSTopicName(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) abstract method to get JMS topic name for a job
protected org.json.simple.JSONObject	getJobsByParentId(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) abstract method to get workflow job ids from the parent id i.e.
protected String	getJobStatus(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Abstract method to get status for a job
protected org.json.simple.JSONObject	getWfActionByJobIdAndName(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) get wf actions by name in coordinator job
protected JsonBean	getWorkflowAction(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get wf action info
protected JsonBean	getWorkflowJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get workflow job
protected org.json.simple.JSONObject	ignoreJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Ignore a coordinator job
protected void	slaChange(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Abstract method to change SLA definition.
protected void	slaDisableAlert(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Abstract method to disable SLA alert.
protected void	slaEnableAlert(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Abstract method to enable SLA alert.
protected void	streamJobAuditLog(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	streamJobErrorLog(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) abstract method to get and stream error log information of job, either workflow, coordinator or bundle
protected org.json.simple.JSONObject	updateJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.hadoop.conf.Configuration conf) Update coord job.

Methods inherited from class org.apache.oozie.servlet.V1JobServlet

changeJob, getCoordinatorJob, getJob, getJobDefinition, getWorkflowActionBean, getWorkflowJobBean, killJob, reRunJob, resumeJob, startJob, streamJobGraph, streamJobLog, suspendJob

Methods inherited from class org.apache.oozie.servlet.BaseJobServlet

doGet, doPut

Methods inherited from class org.apache.oozie.servlet.JsonRestServlet

addCron, getContentType, getProxyUser, getResourceName, getUser, incrCounter, init, sendErrorResponse, sendJsonResponse, sendJsonResponse, service, setAllowSafeModeChanges, setLogInfo, startCron, stopCron, validateContentType, validateRestUrl

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

V2JobServlet

public V2JobServlet()

Method Detail

getWorkflowJob

protected JsonBean getWorkflowJob(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws XServletException

Description copied from class: V1JobServlet

Get workflow job

Overrides:

getWorkflowJob in class V1JobServlet

Parameters:

request - servlet request

response - servlet response

Returns:

JsonBean WorkflowJobBean

Throws:

XServletException

getWorkflowAction

protected JsonBean getWorkflowAction(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws XServletException

Description copied from class: V1JobServlet

Get wf action info

Overrides:

getWorkflowAction in class V1JobServlet

Parameters:

request - servlet request

response - servlet response

Returns:

JsonBean WorkflowActionBean

Throws:

XServletException

getCoordinatorJobLength

protected int getCoordinatorJobLength(int defaultLen,
                                      int len)

Description copied from class: V1JobServlet

Given the requested length and the default length, determine how many coordinator jobs to return. Used by V1JobServlet.getCoordinatorJob(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

Overrides:

getCoordinatorJobLength in class V1JobServlet

Parameters:

defaultLen - The default length

len - The requested length

Returns:

The length to use

getJMSTopicName

protected String getJMSTopicName(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws XServletException,
                                 IOException

Description copied from class: BaseJobServlet

abstract method to get JMS topic name for a job

Overrides:

getJMSTopicName in class V1JobServlet

Parameters:

request - the request

response - the response

Throws:

XServletException - in case of any servlet error

IOException - in case of any I/O error

getJobsByParentId

protected org.json.simple.JSONObject getJobsByParentId(javax.servlet.http.HttpServletRequest request,
                                                       javax.servlet.http.HttpServletResponse response)
                                                throws XServletException,
                                                       IOException

Description copied from class: BaseJobServlet

abstract method to get workflow job ids from the parent id i.e. coordinator action

Overrides:

getJobsByParentId in class V1JobServlet

Parameters:

request - the request

response - the response

Returns:

comma-separated list of workflow job ids

Throws:

XServletException - in case of any servlet error

IOException - in case of any I/O error

updateJob

protected org.json.simple.JSONObject updateJob(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response,
                                               org.apache.hadoop.conf.Configuration conf)
                                        throws XServletException,
                                               IOException

Update coord job.

Overrides:

updateJob in class V1JobServlet

Parameters:

request - the request

response - the response

conf - the Configuration

Returns:

the JSON object

Throws:

XServletException - the x servlet exception

IOException - Signals that an I/O exception has occurred.

ignoreJob

protected org.json.simple.JSONObject ignoreJob(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
                                        throws XServletException,
                                               IOException

Ignore a coordinator job

Overrides:

ignoreJob in class V1JobServlet

Parameters:

request - request object

response - response object

Throws:

XServletException

IOException

slaEnableAlert

protected void slaEnableAlert(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws XServletException,
                              IOException

Description copied from class: BaseJobServlet

Abstract method to enable SLA alert.

Parameters:

request - the request

response - the response

Throws:

XServletException - the x servlet exception

IOException - Signals that an I/O exception has occurred.

slaDisableAlert

protected void slaDisableAlert(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws XServletException,
                               IOException

Description copied from class: BaseJobServlet

Abstract method to disable SLA alert.

Parameters:

request - the request

response - the response

Throws:

XServletException - the x servlet exception

IOException - Signals that an I/O exception has occurred.

slaChange

protected void slaChange(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws XServletException,
                         IOException

Description copied from class: BaseJobServlet

Abstract method to change SLA definition.

Parameters:

request - the request

response - the response

Throws:

XServletException - the x servlet exception

IOException - Signals that an I/O exception has occurred.

getJobStatus

protected String getJobStatus(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws XServletException,
                              IOException

Description copied from class: BaseJobServlet

Abstract method to get status for a job

Overrides:

getJobStatus in class V1JobServlet

Parameters:

request - the request

response - the response

Returns:

the JSON object

Throws:

XServletException - the x servlet exception

IOException - Signals that an I/O exception has occurred.

streamJobErrorLog

protected void streamJobErrorLog(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws XServletException,
                                 IOException

Description copied from class: BaseJobServlet

abstract method to get and stream error log information of job, either workflow, coordinator or bundle

Overrides:

streamJobErrorLog in class V1JobServlet

Parameters:

request - the request

response - the response

Throws:

XServletException - in case of any servlet error

IOException - in case of any I/O error

streamJobAuditLog

protected void streamJobAuditLog(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws XServletException,
                                 IOException

Overrides:

streamJobAuditLog in class V1JobServlet

Throws:

XServletException

IOException

getCoordActionMissingDependencies

protected org.json.simple.JSONObject getCoordActionMissingDependencies(javax.servlet.http.HttpServletRequest request,
                                                                       javax.servlet.http.HttpServletResponse response)
                                                                throws XServletException,
                                                                       IOException

Description copied from class: BaseJobServlet

Abstract method to get the coord action missing dependencies.

Parameters:

request - the request

response - the response

Returns:

the coord input dependencies

Throws:

XServletException - the x servlet exception

IOException - Signals that an I/O exception has occurred.

getBaseEngine

public final BaseEngine getBaseEngine(String jobId,
                                      String user)

Gets the base engine based on jobId.

Parameters:

jobId - the jobId

user - the user

Returns:

the baseEngine

getWfActionByJobIdAndName

protected org.json.simple.JSONObject getWfActionByJobIdAndName(javax.servlet.http.HttpServletRequest request,
                                                               javax.servlet.http.HttpServletResponse response)
                                                        throws XServletException,
                                                               IOException

Description copied from class: BaseJobServlet

get wf actions by name in coordinator job

Overrides:

getWfActionByJobIdAndName in class BaseJobServlet

Parameters:

request - the request

response - the response

Returns:

JSONObject the JSON object

Throws:

XServletException - the x servlet exception

IOException - Signals that an I/O exception has occurred.