Package org.pentaho.di.www

Class GetStatusServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.pentaho.di.www.BaseHttpServlet

org.pentaho.di.www.GetStatusServlet

All Implemented Interfaces:

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

public class GetStatusServlet
extends BaseHttpServlet
implements CartePluginInterface

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONTEXT_PATH

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

detections, jobMap, log, socketRepository, transformationMap

Constructor Summary

Constructors

Constructor	Description
GetStatusServlet()
GetStatusServlet(TransformationMap transformationMap, JobMap jobMap)

Method Summary

Modifier and Type	Method	Description
void	doGet(javax.servlet.http.HttpServletRequest request, javax.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, 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

CONTEXT_PATH

public static final String CONTEXT_PATH

See Also:

Constant Field Values

Constructor Detail

GetStatusServlet

public GetStatusServlet()

GetStatusServlet

public GetStatusServlet(TransformationMap transformationMap,
                        JobMap jobMap)

Method Detail

doGet

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

/kettle/status

GET

Retrieve server status. The status contains information about the server itself (OS, memory, etc) and information about jobs and transformations present on the server.

Example Request:

   GET /kettle/status/?xml=Y
   

Parameters

name	description	type
xml	Boolean flag which defines output format Y forces XML output to be generated. HTML is returned otherwise.	boolean, 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:

   
   
   Online
   229093440
   285736960
   4
   7534848300
   68818403
   45
   -1.0
   Windows 7
   6.1
   amd64
   
   
   Row generator test
   56c93d4e-96c1-4fae-92d9-d864b0779845
   Waiting
   
   N
   
   
   0
   0
   <![CDATA[]]>
   
   
   dummy-trans
   c56961b2-c848-49b8-abde-76c8015e29b0
   Stopped
   
   N
   
   
   0
   0
   <![CDATA[]]>
   
   
   
   
   dummy_job
   abd61143-8174-4f27-9037-6b22fbd3e229
   Stopped
   
   <![CDATA[]]>
   0
   0
   
   
   
   

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 javax.servlet.http.HttpServlet

Throws:

javax.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