Package org.pentaho.di.www

Class StopTransServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.pentaho.di.www.BaseHttpServlet

org.pentaho.di.www.StopTransServlet

All Implemented Interfaces:

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

public class StopTransServlet
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

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Constructor Summary

Constructors

Constructor	Description
StopTransServlet()
StopTransServlet(TransformationMap transformationMap)

Method Summary

Modifier and Type	Method	Description
void	doGet(jakarta.servlet.http.HttpServletRequest request, jakarta.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, getPopulatedVariableSpaceFromRequest, getSocketRepository, getTransformationMap, isJettyMode, logBasic, logBasic, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logRowlevel, setJettyMode, setup

Methods inherited from class jakarta.servlet.http.HttpServlet

doHead, doOptions, doTrace, getLastModified, init, service, service

Methods inherited from class jakarta.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, 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

StopTransServlet

public StopTransServlet()

StopTransServlet

public StopTransServlet(TransformationMap transformationMap)

Method Details

doGet

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

/kettle/stopTrans

GET

Stops transformation execution on Carte server.

Example Request:

      GET /kettle/stopTrans/?name=dummy-transinvalid input: '&xml'=Y
      

Parameters

name	description	type
name	Name of the transformation to be stopped.	query
xml	Boolean flag which sets the output format required. Use Y to receive XML response.	boolean, optional
id	Carte transformation ID of the transformation to be stopped. This parameter is optional when xml=Y is used.	query, optional
inputOnly	Boolean flag indicates which steps to stop. Use Y to Stop input processing	boolean, optional

Response Body

text:	HTML
media types:	text/xml, text/html

Response XML or HTML containing operation result. When using xml=Y result field indicates whether operation was successful (OK) or not (ERROR).

Example Response:

    invalid input: '<'?xml version="1.0" encoding="UTF-8"?>
    
      OK
      Transformation [dummy-trans] stop requested.
      c56961b2-c848-49b8-abde-76c8015e29b0
    
    

Status Codes

code	description
200	Request was processed.
500	Internal server error occurs during request processing.

Specified by:

doGet in interface CartePluginInterface

Overrides:

doGet in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.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