Package org.pentaho.di.www

Class GetTransStatusServlet

java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
org.pentaho.di.www.BaseHttpServlet
org.pentaho.di.www.GetTransStatusServlet
All Implemented Interfaces:
jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable, CartePluginInterface, CarteServletInterface
public class GetTransStatusServlet extends BaseHttpServlet implements CartePluginInterface
See Also:

  • Field Details

  • Constructor Details

    • GetTransStatusServlet

      public GetTransStatusServlet()

    • GetTransStatusServlet

      public GetTransStatusServlet(TransformationMap transformationMap)

  • Method Details

    • doGet

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

      /kettle/transStatus

      GET

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

      Example Request:

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

      Parameters

      name description type
      name Name of the transformation 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 transformation 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 transformation specified. 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"?>
   
   dummy-trans
   c56961b2-c848-49b8-abde-76c8015e29b0
   Stopped
   
   N
   
   Dummy (do nothing)
   00
   00
   00
   00
   Stopped0.0
   --Y
   N
   
   
   0
   37
   
   0
   0
   0
   0
   0
   0
   0
   0
   0
   0
   Y
   0
   Y
   10e2c832-07da-409a-a5ba-4b90a234e957
   
   invalid input: '<'result-file>invalid input: '<'/result-file>
   invalid input: '<'result-rows>invalid input: '<'/result-rows>
   
   <![CDATA[H4sIAAAAAAAAADMyMDTRNzTUNzJRMDSyMrC0MjFV0FVIKc3NrdQtKUrMKwbyXDKLCxJLkjMy89IViksSi0pSUxTS8osUwPJARm5iSWZ+nkI0kq5YXi4AQVH5bFoAAAA=]]>

      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