Package org.pentaho.di.www

Class CleanupTransServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.pentaho.di.www.BaseHttpServlet

org.pentaho.di.www.CleanupTransServlet

All Implemented Interfaces:

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

public class CleanupTransServlet
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
CleanupTransServlet()
CleanupTransServlet(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

CleanupTransServlet

public CleanupTransServlet()

CleanupTransServlet

public CleanupTransServlet(TransformationMap transformationMap)

Method Details

doGet

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

/kettle/cleanupTrans

GET

Cleans up transformation on Carte server. Method is used for cleaning previously uploaded transformation by its name on Carte server. There are two modes for this method: 1) Clean the server sockets only or 2) Clean everything, including the transformation.

Example Request:

    GET /kettle/cleanupTrans/?name=dummy-trans2invalid input: '&xml'=Y
    

Parameters

name	description	type
name	Name of the transformation to be cleaned.	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 cleaned.	query, optional
sockets	Boolean flag which indicates if full clean up or sockets only is required. Use Y to clean just sockets.	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
    All server sockets ports for transformation [dummy-trans2] were deallocated. 
Transformation [dummy-trans2] was cleaned up.
    
  
  

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