Package org.pentaho.di.www

Class SniffStepServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.pentaho.di.www.BaseHttpServlet

org.pentaho.di.www.SniffStepServlet

All Implemented Interfaces:

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

public class SniffStepServlet
extends BaseHttpServlet
implements CartePluginInterface

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTEXT_PATH
static final String	TYPE_INPUT
static final String	TYPE_OUTPUT
static final String	XML_TAG

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
SniffStepServlet()
SniffStepServlet(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

TYPE_INPUT

public static final String TYPE_INPUT

See Also:

• Constant Field Values

TYPE_OUTPUT

public static final String TYPE_OUTPUT

See Also:

• Constant Field Values

XML_TAG

public static final String XML_TAG

See Also:

• Constant Field Values

Constructor Details

SniffStepServlet

public SniffStepServlet()

SniffStepServlet

public SniffStepServlet(TransformationMap transformationMap)

Method Details

doGet

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

/kettle/sniffStep

GET

Sniff metadata and data from the specified step of the specified transformation.

Example Request:

    GET /kettle/sniffStep?trans=dummy-transinvalid input: '&step'=tfinvalid input: '&xml'=Yinvalid input: '&lines'=10
    

Parameters

name	description	type
trans	Name of the transformation containing required step.	query
stepName	Name of the transformation step to collect data for.	query
copynr	Copy number of the step to be used for collecting data. If not provided 0 is used.	integer, optional
type	Type of the data to be collected (input or output). If not provided output data is collected.	query, optional
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 transformation to be used for step lookup.	query, optional
lines	Number of lines to collect and include into response. If not provided 0 lines will be collected.	integer, optional

Response Body

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

Response XML or HTML response containing data and metadata of the step. If an error occurs during method invocation result field of the response will contain ERROR status.

Example Response:

    invalid input: '<'?xml version="1.0" encoding="UTF-8"?>
    invalid input: '<'step-sniff>
      invalid input: '<'row-meta>
        invalid input: '<'value-meta>String
          normal
          Field1
          0
          -1
          tf
          
          
          .
          ,
          $
          none
          N
          N
          N
          Y
          en_US
          America/Bahia
          N
        invalid input: '<'/value-meta>
      invalid input: '<'/row-meta>
      10

      invalid input: '<'row-data>invalid input: '<'value-data>my-datainvalid input: '<'/value-data>
      invalid input: '<'/row-data>
      invalid input: '<'row-data>invalid input: '<'value-data>my-data invalid input: '<'/value-data>
      invalid input: '<'/row-data>
      invalid input: '<'row-data>invalid input: '<'value-data>my-datainvalid input: '<'/value-data>
      invalid input: '<'/row-data>
      invalid input: '<'row-data>invalid input: '<'value-data>my-datainvalid input: '<'/value-data>
      invalid input: '<'/row-data>
      invalid input: '<'row-data>invalid input: '<'value-data>my-datainvalid input: '<'/value-data>
      invalid input: '<'/row-data>
      invalid input: '<'row-data>invalid input: '<'value-data>my-datainvalid input: '<'/value-data>
      invalid input: '<'/row-data>
      invalid input: '<'row-data>invalid input: '<'value-data>my-datainvalid input: '<'/value-data>
      invalid input: '<'/row-data>
      invalid input: '<'row-data>invalid input: '<'value-data>my-datainvalid input: '<'/value-data>
      invalid input: '<'/row-data>
      invalid input: '<'row-data>invalid input: '<'value-data>my-datainvalid input: '<'/value-data>
      invalid input: '<'/row-data>
      invalid input: '<'row-data>invalid input: '<'value-data>my-datainvalid input: '<'/value-data>
      invalid input: '<'/row-data>
    invalid input: '<'/step-sniff>
    

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