org.apache.oozie.servlet

Class V1JobServlet

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

All Implemented Interfaces:

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

Direct Known Subclasses:

V2JobServlet

public class V1JobServlet
extends BaseJobServlet

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

Modifier and Type	Field and Description
static String	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

Modifier	Constructor and Description
	V1JobServlet()
protected	V1JobServlet(String instrumentation_name)

Method Summary

Modifier and Type	Method and Description
protected void	changeJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) protected method to change a coordinator job
protected JsonBean	getCoordinatorJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get coord job info
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 JsonBean	getJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) abstract method to get a job, either workflow or coordinator, in JsonBean representation
protected String	getJobDefinition(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) abstract method to get definition of a job, either workflow or coordinator
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 JsonBean	getWorkflowAction(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get wf action info
protected JsonBean	getWorkflowActionBean(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected JsonBean	getWorkflowJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Get workflow job
protected JsonBean	getWorkflowJobBean(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)
protected org.json.simple.JSONObject	killJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) abstract method to kill a job, either workflow or coordinator
protected org.json.simple.JSONObject	reRunJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.hadoop.conf.Configuration conf) abstract method to re-run a job, either workflow or coordinator
protected void	resumeJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) abstract method to resume a job, either workflow or coordinator
protected void	startJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) abstract method to start a job, either workflow or coordinator
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 void	streamJobGraph(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) abstract method to create and stream image for runtime DAG -- workflow only
protected void	streamJobLog(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) abstract method to get and stream log information of job, either workflow or coordinator
protected void	suspendJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) abstract method to suspend a job, either workflow or coordinator
protected org.json.simple.JSONObject	updateJob(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.hadoop.conf.Configuration conf) not supported for v1

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

doGet, doPut, getWfActionByJobIdAndName

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

Field Detail

COORD_ACTIONS_DEFAULT_LENGTH

public static final String COORD_ACTIONS_DEFAULT_LENGTH

See Also:

Constant Field Values

Constructor Detail

V1JobServlet

public V1JobServlet()

V1JobServlet

protected V1JobServlet(String instrumentation_name)

Method Detail

startJob

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

Description copied from class: BaseJobServlet

abstract method to start a job, either workflow or coordinator

Parameters:

request - the request

response - the response

Throws:

XServletException - in case of any servlet error

IOException - in case of any I/O error

resumeJob

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

Description copied from class: BaseJobServlet

abstract method to resume a job, either workflow or coordinator

Parameters:

request - the request

response - the response

Throws:

XServletException - in case of any servlet error

IOException - in case of any I/O error

suspendJob

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

Description copied from class: BaseJobServlet

abstract method to suspend a job, either workflow or coordinator

Parameters:

request - the request

response - the response

Throws:

XServletException - in case of any servlet error

IOException - in case of any I/O error

killJob

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

Description copied from class: BaseJobServlet

abstract method to kill a job, either workflow or coordinator

Parameters:

request - the request

response - the response

Throws:

XServletException - in case of any servlet error

IOException - in case of any I/O error

changeJob

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

protected method to change a coordinator job

Parameters:

request - request object

response - response object

Throws:

XServletException

IOException

ignoreJob

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

Throws:

XServletException

IOException

reRunJob

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

Description copied from class: BaseJobServlet

abstract method to re-run a job, either workflow or coordinator

Parameters:

request - the request

response - the response

conf - the configuration to use

Throws:

XServletException - in case of any servlet error

IOException - in case of any I/O error

getJob

protected JsonBean getJob(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws XServletException,
                          IOException,
                          BaseEngineException

Description copied from class: BaseJobServlet

abstract method to get a job, either workflow or coordinator, in JsonBean representation

Parameters:

request - the request

response - the response

Returns:

JsonBean representation of a job, either workflow or coordinator

Throws:

XServletException - in case of any servlet error

IOException - in case of any I/O error

BaseEngineException - thrown if the job could not be retrieved

getJobDefinition

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

Description copied from class: BaseJobServlet

abstract method to get definition of a job, either workflow or coordinator

Parameters:

request - the request

response - the response

Returns:

job, either workflow or coordinator, definition in string format

Throws:

XServletException - in case of any servlet error

IOException - in case of any I/O error

streamJobLog

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

Description copied from class: BaseJobServlet

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

Parameters:

request - the request

response - the response

Throws:

XServletException - in case of any servlet error

IOException - in case of any I/O error

streamJobGraph

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

Description copied from class: BaseJobServlet

abstract method to create and stream image for runtime DAG -- workflow only

Parameters:

request - the request

response - the response

Throws:

XServletException - in case of any servlet error

IOException - in case of any I/O error

getWorkflowJob

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

Get workflow job

Parameters:

request - servlet request

response - servlet response

Returns:

JsonBean WorkflowJobBean

Throws:

XServletException

getWorkflowJobBean

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

Get workflow job

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

Get wf action info

Parameters:

request - servlet request

response - servlet response

Returns:

JsonBean WorkflowActionBean

Throws:

XServletException

getWorkflowActionBean

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

Throws:

XServletException

getCoordinatorJob

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

Get coord job info

Parameters:

request - servlet request

response - servlet response

Returns:

JsonBean CoordinatorJobBean

Throws:

XServletException

BaseEngineException

getCoordinatorJobLength

protected int getCoordinatorJobLength(int defaultLen,
                                      int len)

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

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

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

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

not supported for v1

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.

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

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

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

Throws:

XServletException

IOException