Package org.pentaho.di.job.entry

Class BaseJobEntryHelper

java.lang.Object

org.pentaho.di.job.entry.BaseJobEntryHelper

All Implemented Interfaces:

JobEntryHelperInterface

Direct Known Subclasses:

JobEntryJobHelper, JobEntryTransHelper, JobEntryZipFileHelper

public abstract class BaseJobEntryHelper
extends Object
implements JobEntryHelperInterface

Base implementation of JobEntryHelperInterface providing shared infrastructure for executing UI-triggered "job entry actions".

Job entry actions are job entry-specific, non-runtime operations initiated from a job entry dialog (e.g. fetching external metadata, validating configuration, testing connections). They do not participate in job execution.

Subclasses implement only the job entry-specific logic in handleJobEntryAction(String, JobMeta, java.util.Map).

See Also:

• JobEntryHelperInterface

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IS_TRANS_REFERENCE
static final String	IS_VALID_REFERENCE
protected org.pentaho.di.core.logging.LogChannelInterface	log
static final String	REFERENCE_PATH
static final String	SEPARATOR

Fields inherited from interface org.pentaho.di.job.entry.JobEntryHelperInterface

ACTION_STATUS, FAILURE_METHOD_NOT_FOUND_RESPONSE, FAILURE_RESPONSE, FAILURE_STATUS, NOT_EXECUTED_STATUS, STATUS, SUCCESS_RESPONSE, SUCCESS_STATUS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseJobEntryHelper()

Method Summary

Modifier and Type	Method	Description
protected String	getReferencePath(JobMeta jobMeta, String directoryPath, String objectName, org.pentaho.di.core.ObjectLocationSpecificationMethod specificationMethod, String fileName)	Constructs the reference path for a job or transformation based on the provided directory path and name.
protected abstract org.json.simple.JSONObject	handleJobEntryAction(String method, JobMeta jobMeta, Map<String,String> queryParams)	Abstract method for handling a specific job entry action.
boolean	isFailedResponse(org.json.simple.JSONObject response)	Utility method to check if a response indicates a failure.
org.json.simple.JSONObject	jobEntryAction(String method, JobMeta jobMeta, Map<String,String> queryParams)	Default implementation for performing a job entry action.

Methods inherited from class java.lang.Object

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

Field Details

IS_TRANS_REFERENCE

public static final String IS_TRANS_REFERENCE

See Also:

• Constant Field Values

IS_VALID_REFERENCE

public static final String IS_VALID_REFERENCE

See Also:

• Constant Field Values

REFERENCE_PATH

public static final String REFERENCE_PATH

See Also:

• Constant Field Values

SEPARATOR

public static final String SEPARATOR

See Also:

• Constant Field Values

log

protected org.pentaho.di.core.logging.LogChannelInterface log

Constructor Details

BaseJobEntryHelper

protected BaseJobEntryHelper()

Method Details

jobEntryAction

public org.json.simple.JSONObject jobEntryAction(String method,
 JobMeta jobMeta,
 Map<String,String> queryParams)

Default implementation for performing a job entry action.

This method provides shared infrastructure for executing job entry-specific, non-runtime operations initiated from a job entry dialog (e.g. fetching external metadata, validating configuration, testing connections). Subclasses implement only the job entry-specific logic in handleJobEntryAction(String, JobMeta, java.util.Map).

Specified by:

jobEntryAction in interface JobEntryHelperInterface

Parameters:

method - The name of the method to execute.

jobMeta - The job metadata associated with the job entry.

queryParams - A map of query parameters for the action.

Returns:

A JSON object containing the action status and any additional response data.

handleJobEntryAction

protected abstract org.json.simple.JSONObject handleJobEntryAction(String method,
 JobMeta jobMeta,
 Map<String,String> queryParams)

Abstract method for handling a specific job entry action. Subclasses must implement this method to provide job entry-specific logic.

Parameters:

method - The name of the method to execute.

jobMeta - The job metadata associated with the job entry.

queryParams - A map of query parameters for the action.

Returns:

A JSON object containing the action status and any additional response data.

isFailedResponse

public boolean isFailedResponse(org.json.simple.JSONObject response)

Utility method to check if a response indicates a failure.

Parameters:

response - The JSON object containing the response data.

Returns:

True if the response indicates a failure, false otherwise.

getReferencePath

protected String getReferencePath(JobMeta jobMeta,
 String directoryPath,
 String objectName,
 org.pentaho.di.core.ObjectLocationSpecificationMethod specificationMethod,
 String fileName)

Constructs the reference path for a job or transformation based on the provided directory path and name.

Parameters:

jobMeta - The job metadata containing the job entry.

directoryPath - The directory path where the job or transformation is located.

objectName - The name of the job or transformation.

specificationMethod - The specification method used (e.g. REPOSITORY_BY_NAME, FILENAME).

fileName - The filename of the job or transformation (used if the specification method is FILENAME).

Returns:

The constructed reference path, or an empty string if neither directoryPath nor objectName is provided.