Package org.pentaho.di.trans.steps.systemdata

Class SystemDataStepHelper

java.lang.Object

org.pentaho.di.trans.step.BaseStepHelper

org.pentaho.di.trans.steps.systemdata.SystemDataStepHelper

All Implemented Interfaces:

StepHelperInterface

public class SystemDataStepHelper
extends BaseStepHelper

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	METHOD_NAME
protected static final String	RESPONSE_KEY

Fields inherited from class org.pentaho.di.trans.step.BaseStepHelper

IS_TRANS_REFERENCE, IS_VALID_REFERENCE, log, REFERENCE_PATH, SEPARATOR

Fields inherited from interface org.pentaho.di.trans.step.StepHelperInterface

ACTION_STATUS, FAILURE_METHOD_NOT_FOUND_RESPONSE, FAILURE_RESPONSE, STATUS, SUCCESS_RESPONSE

Constructor Summary

Constructors

Constructor	Description
SystemDataStepHelper()

Method Summary

Modifier and Type	Method	Description
protected org.json.simple.JSONObject	handleStepAction(String method, TransMeta transMeta, Map<String,String> queryParams)	Handles a step action based on the provided method name.
protected org.json.simple.JSONObject	type()	Generates a JSON response containing all available system data types in SystemDataTypes except for TYPE_SYSTEM_INFO_NONE.

Methods inherited from class org.pentaho.di.trans.step.BaseStepHelper

getReferencePath, isFailedResponse, stepAction, validateAndPutReferenceStatus

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

RESPONSE_KEY

protected static final String RESPONSE_KEY

See Also:

• Constant Field Values

METHOD_NAME

protected static final String METHOD_NAME

See Also:

• Constant Field Values

Constructor Details

SystemDataStepHelper

public SystemDataStepHelper()

Method Details

type

protected org.json.simple.JSONObject type()

Generates a JSON response containing all available system data types in SystemDataTypes except for TYPE_SYSTEM_INFO_NONE. Each system data type is represented as a JSON object with its code and description. The response includes a status indicating success.

Returns:

a JSONObject containing the list of system data types and the action status.

handleStepAction

protected org.json.simple.JSONObject handleStepAction(String method,
 TransMeta transMeta,
 Map<String,String> queryParams)

Handles a step action based on the provided method name.

If the method name matches the expected METHOD_NAME, this method delegates to the type() method and returns its result as a JSONObject. Otherwise, it returns a failure response indicating that the requested method was not found.

Specified by:

handleStepAction in class BaseStepHelper

Parameters:

method - the name of the method to execute (case-sensitive)

transMeta - the transformation metadata (currently unused for this step)

queryParams - query parameters for the action (currently unused for this step)

Returns:

a JSONObject containing either the action result or an error response

See Also:

• BaseStepHelper.handleStepAction(String, TransMeta, Map)