org.pentaho.di.www

Class AddExportServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.pentaho.di.www.BaseHttpServlet

org.pentaho.di.www.AddExportServlet

All Implemented Interfaces:

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

Deprecated.

@Deprecated
public class AddExportServlet
extends BaseHttpServlet
implements CartePluginInterface

This servlet allows you to transport an exported job or transformation over to the carte server as a zip file. It ends up in a temporary file. The servlet returns the name of the file stored.

Author:

matt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_PATH Deprecated.
static String	PARAMETER_LOAD Deprecated.
static String	PARAMETER_TYPE Deprecated.
static String	TYPE_JOB Deprecated.
static String	TYPE_TRANS Deprecated.

Fields inherited from class org.pentaho.di.www.BaseHttpServlet

detections, jobMap, log, socketRepository, transformationMap

Constructor Summary

Constructors

Constructor and Description
AddExportServlet() Deprecated.
AddExportServlet(JobMap jobMap, TransformationMap transformationMap) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.
String	getContextPath() Deprecated.
String	getService() Deprecated.
String	toString() Deprecated.

Methods inherited from class org.pentaho.di.www.BaseHttpServlet

convertContextPath, doDelete, doPost, doPut, getDetections, getJobMap, getSocketRepository, getTransformationMap, isJettyMode, logBasic, logBasic, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logRowlevel, setJettyMode, setup

Methods inherited from class javax.servlet.http.HttpServlet

doHead, doOptions, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, 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 Detail

PARAMETER_LOAD

public static final String PARAMETER_LOAD

Deprecated.

See Also:

Constant Field Values

PARAMETER_TYPE

public static final String PARAMETER_TYPE

Deprecated.

See Also:

Constant Field Values

TYPE_JOB

public static final String TYPE_JOB

Deprecated.

See Also:

Constant Field Values

TYPE_TRANS

public static final String TYPE_TRANS

Deprecated.

See Also:

Constant Field Values

CONTEXT_PATH

public static final String CONTEXT_PATH

Deprecated.

See Also:

Constant Field Values

Constructor Detail

AddExportServlet

public AddExportServlet()

Deprecated.

AddExportServlet

public AddExportServlet(JobMap jobMap,
                        TransformationMap transformationMap)

Deprecated.

Method Detail

doGet

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

Deprecated.

/kettle/addExport

POST

Returns the list of users in the platform. This list is in an xml format as shown in the example response. Uploads and executes previously exported job or transformation. Uploads zip file containing job or transformation to be executed and executes it. Method relies on the input parameters to find the entity to be executed. The archive is transferred within request body. File url of the executed entity will be returned in the Response object or message describing error occurred. To determine if the call is successful rely on result parameter in response.

Example Request:

    POST /kettle/addExport/?type=job&load=dummy_job.kjb
    

Request body should contain zip file prepared for Carte execution.

Parameters

name	description	type
type	The type of the entity to be executed either job or trans.	query
load	The name of the entity within archive to be executed.	query

Response Body

element:	(custom)
media types:	application/xml

Response wraps file url of the entity 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:

    
    
      OK
      zip:file:///temp/export_ee2a67de-6a72-11e4-82c0-4701a2bac6a5.zip!dummy_job.kjb
      74cf4219-c881-4633-a71a-2ed16b7db7b8
    
    

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

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