Package org.pentaho.di.www

Class GetJobStatusServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.pentaho.di.www.BaseHttpServlet

org.pentaho.di.www.GetJobStatusServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, CartePluginInterface, CarteServletInterface

public class GetJobStatusServlet
extends BaseHttpServlet
implements CartePluginInterface

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTEXT_PATH

Fields inherited from class org.pentaho.di.www.BaseHttpServlet

detections, jobMap, log, socketRepository, transformationMap

Constructor Summary

Constructors

Constructor	Description
GetJobStatusServlet()
GetJobStatusServlet(JobMap jobMap)

Method Summary

Modifier and Type	Method	Description
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
String	getContextPath()
String	getService()
String	toString()

Methods inherited from class org.pentaho.di.www.BaseHttpServlet

convertContextPath, doDelete, doPost, doPut, getDetections, getJobMap, getSocketRepository, getTransformationMap, isJettyMode, logBasic, logBasic, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logRowlevel, setJettyMode, setup

Methods inherited from class javax.servlet.http.HttpServlet

doHead, doOptions, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.di.www.CartePluginInterface

isJettyMode, setJettyMode, setup

Field Details

CONTEXT_PATH

public static final String CONTEXT_PATH

See Also:

• Constant Field Values

Constructor Details

GetJobStatusServlet

public GetJobStatusServlet()

GetJobStatusServlet

public GetJobStatusServlet(JobMap jobMap)

Method Details

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
           throws javax.servlet.ServletException,
IOException

/kettle/jobStatus

GET

Retrieves status of the specified job. Status is returned as HTML or XML output depending on the input parameters. Status contains information about last execution of the job.

Example Request:

   GET /kettle/jobStatus/?name=dummy_job&xml=Y
   

Parameters

name	description	type
name	Name of the job to be used for status generation.	query
xml	Boolean flag which defines output format Y forces XML output to be generated. HTML is returned otherwise.	boolean, optional
id	Carte id of the job to be used for status generation.	query, optional
from	Start line number of the execution log to be included into response.	integer, optional

Response Body

element:	(custom)
media types:	text/xml, text/html

Response XML or HTML response containing details about the job specified. If an error occurs during method invocation result field of the response will contain ERROR status.

Example Response:

   <?xml version="1.0" encoding="UTF-8"?>
   
   dummy_job
   a4d54106-25db-41c5-b9f8-73afd42766a6
   Finished
   
   <![CDATA[H4sIAAAAAAAAADMyMDTRNzTUNzRXMDC3MjS2MjJQ0FVIKc3NrYzPyk8CsoNLEotKFPLTFEDc1IrU5NKSzPw8Xi4j4nRm5qUrpOaVFFUqRLuE+vpGxhKj0y0zL7M4IzUFYieybgWNotTi0pwS2+iSotLUWE1iTPNCdrhCGtRsXi4AOMIbLPwAAAA=]]>
   0
   20
   
   0
   0
   0
   0
   0
   0
   0
   0
   0
   0
   Y
   0
   N
   
   null
   <result-file></result-file>
   <result-rows></result-rows>
   
   
   

Status Codes

code	description
200	Request was processed.
400	Bad Request: Mandatory parameter name missing
404	Not found: Job not found
409	Conflicting: multiple jobs with the same name. must provide id
500	Internal server error occurs during request processing.

Specified by:

doGet in interface CartePluginInterface

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

toString

public String toString()

Overrides:

toString in class Object

getService

public String getService()

Specified by:

getService in interface CarteServletInterface

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface CartePluginInterface