Package org.pentaho.di.www

Class RunJobServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.pentaho.di.www.BaseHttpServlet

org.pentaho.di.www.RunJobServlet

All Implemented Interfaces:

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

public class RunJobServlet
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
RunJobServlet()
RunJobServlet(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()
protected void	runJob(Job job)
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

RunJobServlet

public RunJobServlet()

RunJobServlet

public RunJobServlet(JobMap jobMap)

Method Details

doGet

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

/kettle/runJob

GET

Execute job from enterprise repository. Repository should be configured in Carte xml file. Response contains ERROR result if error happened during job execution.

Example Request:

    GET /kettle/runJob?job=home%2Fadmin%2Fdummy_job&level=Debug
    

Parameters

name	description	type
job	Full path to the job in repository.	query
level	Logging level to be used for job execution (i.e. Debug).	query

Response Body

element:	(custom)
media types:	text/xml

Response contains result of the operation. It is either OK or ERROR. If an error occurred during job execution, response also contains information about the error.

Example Response:

    
      OK
      Job started
      05d919b0-74a3-48d6-84d8-afce359d0449
    
    

Status Codes

code	description
200	Request was processed.
400	Bad Request: Mandatory parameter job missing
401	Unauthorized access to the repository
404	Not found: Job not found
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

runJob

protected void runJob(Job job)

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