Class AddJobServlet

java.lang.Object
javax.servlet.GenericServlet
javax.servlet.http.HttpServlet
org.pentaho.di.www.BaseHttpServlet
org.pentaho.di.www.AddJobServlet
All Implemented Interfaces:
Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, CartePluginInterface, CarteServletInterface

@Deprecated public class AddJobServlet extends BaseHttpServlet implements CartePluginInterface
Deprecated.
has been replaced by RegisterJobServlet
See Also:
  • Field Details

  • Constructor Details

    • AddJobServlet

      public AddJobServlet()
      Deprecated.
    • AddJobServlet

      public AddJobServlet(JobMap jobMap, SocketRepository socketRepository)
      Deprecated.
  • Method Details

    • doGet

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

      /kettle/addJob

      POST

      Uploads and executes job configuration XML file. Uploads xml file containing job and job_execution_configuration (wrapped in job_configuration tag) to be executed and executes it. Method relies on the input parameter to determine if xml or html reply should be produced. The job_configuration xml is transferred within request body. Job name of the executed job will be returned in the Response object or message describing error occurred. To determine if the call successful or not you should rely on result parameter in response.

      Example Request:

          POST /kettle/addJob/?xml=Y
          

      Request body should contain xml containing job_configuration (job + job_execution_configuration wrapped in job_configuration tag).

      Parameters

      name description type
      xml Boolean flag set to either Y or N describing if xml or html reply should be produced. boolean, optional

      Response Body

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

      Response wraps job name that was executed or error stack trace if an error occurred. Response has result OK if there were no errors. Otherwise it returns ERROR.

      Example Response:

          <?xml version="1.0" encoding="UTF-8"?>
          
            OK
            Job 'dummy_job' was added to the list with id 1e90eca8-4d4c-47f7-8e5c-99ec36525e7c
            1e90eca8-4d4c-47f7-8e5c-99ec36525e7c
          
          

      Status Codes

      code description
      200 Request was processed and XML response is returned.
      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
    • getAllArgumentStrings

      protected String[] getAllArgumentStrings(Map<String,String> arguments)
      Deprecated.
    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object
    • getService

      public String getService()
      Deprecated.
      Specified by:
      getService in interface CarteServletInterface
    • getContextPath

      public String getContextPath()
      Deprecated.
      Specified by:
      getContextPath in interface CartePluginInterface