Package org.pentaho.di.core

Class Const

java.lang.Object
org.pentaho.di.core.Const
public class Const extends Object
This class is used to define a number of default values for various settings throughout Kettle. It also contains a number of static final methods to make your life easier.
Since:
07-05-2003
Author:
Matt

  • Field Details

    • VERSION

      @Deprecated public static final String VERSION
      Deprecated.
      Use BuildVersion.getVersion() instead
      Version number

    • TIMEOUT_GET_MILLIS

      public static final int TIMEOUT_GET_MILLIS
      Sleep time waiting when buffer is empty (the default)
      See Also:

    • TIMEOUT_PUT_MILLIS

      public static final int TIMEOUT_PUT_MILLIS
      Sleep time waiting when buffer is full (the default)
      See Also:

    • ROWS_UPDATE

      public static final int ROWS_UPDATE
      print update every ... lines
      See Also:

    • ROWS_IN_ROWSET

      public static final int ROWS_IN_ROWSET
      Size of rowset: bigger = faster for large amounts of data
      See Also:

    • FETCH_SIZE

      public static final int FETCH_SIZE
      Fetch size in rows when querying a database
      See Also:

    • SORT_SIZE

      public static final int SORT_SIZE
      Sort size: how many rows do we sort in memory at once?
      See Also:

    • HEARTBEAT_PERIODIC_INTERVAL_IN_SECS

      public static final int HEARTBEAT_PERIODIC_INTERVAL_IN_SECS
      job/trans heartbeat scheduled executor periodic interval ( in seconds )
      See Also:

    • FILE_SEPARATOR

      public static final String FILE_SEPARATOR
      What's the file systems file separator on this operating system?

    • PATH_SEPARATOR

      public static final String PATH_SEPARATOR
      What's the path separator on this operating system?

    • CR

      public static final String CR
      CR: operating systems specific Carriage Return

    • DOSCR

      public static final String DOSCR
      DOSCR: MS-DOS specific Carriage Return
      See Also:

    • EMPTY_STRING

      public static final String EMPTY_STRING
      An empty ("") String.
      See Also:

    • JAVA_VERSION

      public static final String JAVA_VERSION
      The Java runtime version

    • USER_HOME_DIRECTORY

      @Deprecated public static final String USER_HOME_DIRECTORY
      Deprecated.
      Use getUserHomeDirectory() instead.
      Path to the users home directory (keep this entry above references to getKettleDirectory())

    • JNDI_DIRECTORY

      public static String JNDI_DIRECTORY
      Path to the simple-jndi directory

    • PLUGIN_BASE_FOLDERS_PROP

      public static final String PLUGIN_BASE_FOLDERS_PROP
      See Also:

    • DEFAULT_PLUGIN_BASE_FOLDERS

      public static final String DEFAULT_PLUGIN_BASE_FOLDERS
      the default comma separated list of base plugin folders.

    • MIN_DATE

      public static final Date MIN_DATE
      Default minimum date range...

    • MAX_DATE

      public static final Date MAX_DATE
      Default maximum date range...

    • MIN_YEAR

      public static final int MIN_YEAR
      The default minimum year in a dimension date range
      See Also:

    • MAX_YEAR

      public static final int MAX_YEAR
      The default maximum year in a dimension date range
      See Also:

    • LENGTH

      public static final int LENGTH
      Specifies the length (width) of fields in a number of pixels in dialog boxes.
      See Also:

    • MARGIN

      public static final int MARGIN
      The margin between the different dialog components & widgets
      See Also:

    • MIDDLE_PCT

      public static final int MIDDLE_PCT
      The default percentage of the width of screen where we consider the middle of a dialog.
      See Also:

    • ARROW_WIDTH

      public static final int ARROW_WIDTH
      The default width of an arrow in the Graphical Views
      See Also:

    • FORM_MARGIN

      public static final int FORM_MARGIN
      The horizontal and vertical margin of a dialog box.
      See Also:

    • SHADOW_SIZE

      public static final int SHADOW_SIZE
      The default shadow size on the graphical view.
      See Also:

    • SYMBOLSIZE

      public static final int SYMBOLSIZE
      The size of relationship symbols
      See Also:

    • MAX_FILE_HIST

      public static final int MAX_FILE_HIST
      Max nr. of files to remember
      See Also:

    • DEFAULT_LOCALE

      public static final Locale DEFAULT_LOCALE
      The default locale for the kettle environment (system defined)

    • DEFAULT_DECIMAL_SEPARATOR

      public static final char DEFAULT_DECIMAL_SEPARATOR
      The default decimal separator . or ,

    • DEFAULT_GROUPING_SEPARATOR

      public static final char DEFAULT_GROUPING_SEPARATOR
      The default grouping separator , or .

    • DEFAULT_CURRENCY_SYMBOL

      public static final String DEFAULT_CURRENCY_SYMBOL
      The default currency symbol

    • DEFAULT_NUMBER_FORMAT

      public static final String DEFAULT_NUMBER_FORMAT
      The default number format

    • NULL_STRING

      public static final String NULL_STRING
      Default string representing Null String values (empty)
      See Also:

    • NULL_NUMBER

      public static final String NULL_NUMBER
      Default string representing Null Number values (empty)
      See Also:

    • NULL_DATE

      public static final String NULL_DATE
      Default string representing Null Date values (empty)
      See Also:

    • NULL_BIGNUMBER

      public static final String NULL_BIGNUMBER
      Default string representing Null BigNumber values (empty)
      See Also:

    • NULL_BOOLEAN

      public static final String NULL_BOOLEAN
      Default string representing Null Boolean values (empty)
      See Also:

    • NULL_INTEGER

      public static final String NULL_INTEGER
      Default string representing Null Integer values (empty)
      See Also:

    • NULL_BINARY

      public static final String NULL_BINARY
      Default string representing Null Binary values (empty)
      See Also:

    • NULL_NONE

      public static final String NULL_NONE
      Default string representing Null Undefined values (empty)
      See Also:

    • ROUND_HALF_CEILING

      public static final int ROUND_HALF_CEILING
      Rounding mode, not implemented in BigDecimal. Method java.lang.Math.round(double) processes this way.
      Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round ceiling.
      Behaves as for ROUND_CEILING if the discarded fraction is ≥ 0.5; otherwise, behaves as for ROUND_FLOOR. Note that this is the most common arithmetical rounding mode.
      See Also:

    • CHEF_LOG_FILE

      public static final String CHEF_LOG_FILE
      The base name of the Chef logfile
      See Also:

    • SPOON_LOG_FILE

      public static final String SPOON_LOG_FILE
      The base name of the Spoon logfile
      See Also:

    • GENERALIZED_DATE_TIME_FORMAT

      public static final String GENERALIZED_DATE_TIME_FORMAT
      Generalized date/time format: Wherever dates are used, date and time values are organized from the most to the least significant. see also method StringUtil.getFormattedDateTime()
      See Also:

    • GENERALIZED_DATE_TIME_FORMAT_MILLIS

      public static final String GENERALIZED_DATE_TIME_FORMAT_MILLIS
      See Also:

    • XML_ENCODING

      public static final String XML_ENCODING
      Default we store our information in Unicode UTF-8 character set.
      See Also:

    • STRING_TRANS_AND_JOB_FILTER_EXT

      public static final String[] STRING_TRANS_AND_JOB_FILTER_EXT
      The possible extensions a transformation XML file can have.

    • STRING_TRANS_DEFAULT_EXT

      public static final String STRING_TRANS_DEFAULT_EXT
      The extension of a Kettle transformation XML file
      See Also:

    • STRING_TRANS_FILTER_EXT

      public static final String[] STRING_TRANS_FILTER_EXT
      The possible extensions a transformation XML file can have.

    • STRING_JOB_DEFAULT_EXT

      public static final String STRING_JOB_DEFAULT_EXT
      The extension of a Kettle job XML file
      See Also:

    • STRING_JOB_FILTER_EXT

      public static final String[] STRING_JOB_FILTER_EXT
      The possible extensions a job XML file can have.

    • KETTLE_PROPERTIES

      public static final String KETTLE_PROPERTIES
      Name of the kettle parameters file
      See Also:

    • SHARED_DATA_FILE

      public static final String SHARED_DATA_FILE
      Name of the kettle shared data file
      See Also:

    • INTERNAL_VARIABLE_PREFIX

      public static final String INTERNAL_VARIABLE_PREFIX
      The prefix that all internal kettle variables should have
      See Also:

    • INTERNAL_VARIABLE_KETTLE_VERSION

      public static final String INTERNAL_VARIABLE_KETTLE_VERSION
      The version number as an internal variable
      See Also:

    • INTERNAL_VARIABLE_KETTLE_BUILD_VERSION

      public static final String INTERNAL_VARIABLE_KETTLE_BUILD_VERSION
      The build version as an internal variable
      See Also:

    • INTERNAL_VARIABLE_KETTLE_BUILD_DATE

      public static final String INTERNAL_VARIABLE_KETTLE_BUILD_DATE
      The build date as an internal variable
      See Also:

    • INTERNAL_VARIABLE_JOB_FILENAME_DIRECTORY

      public static final String INTERNAL_VARIABLE_JOB_FILENAME_DIRECTORY
      The job filename directory
      See Also:

    • INTERNAL_VARIABLE_JOB_FILENAME_NAME

      public static final String INTERNAL_VARIABLE_JOB_FILENAME_NAME
      The job filename name
      See Also:

    • INTERNAL_VARIABLE_JOB_NAME

      public static final String INTERNAL_VARIABLE_JOB_NAME
      The job name
      See Also:

    • INTERNAL_VARIABLE_JOB_REPOSITORY_DIRECTORY

      public static final String INTERNAL_VARIABLE_JOB_REPOSITORY_DIRECTORY
      The job directory
      See Also:

    • INTERNAL_VARIABLE_JOB_RUN_ID

      public static final String INTERNAL_VARIABLE_JOB_RUN_ID
      The job run ID
      See Also:

    • INTERNAL_VARIABLE_JOB_RUN_ATTEMPTNR

      public static final String INTERNAL_VARIABLE_JOB_RUN_ATTEMPTNR
      The job run attempt nr
      See Also:

    • VARIABLE_HEARTBEAT_PERIODIC_INTERVAL_SECS

      public static final String VARIABLE_HEARTBEAT_PERIODIC_INTERVAL_SECS
      job/trans heartbeat scheduled executor periodic interval ( in seconds )
      See Also:

    • VARIABLE_MONITORING_SNMP_TRAPS_ENABLED

      public static final String VARIABLE_MONITORING_SNMP_TRAPS_ENABLED
      comma-separated list of extension point plugins for which snmp traps should be sent
      See Also:

    • INTERNAL_VARIABLE_ENTRY_CURRENT_DIRECTORY

      public static final String INTERNAL_VARIABLE_ENTRY_CURRENT_DIRECTORY
      The current transformation directory
      See Also:

    • INTERNAL_TRANS_VARIABLES

      public static final String[] INTERNAL_TRANS_VARIABLES
      All the internal transformation variables

    • INTERNAL_JOB_VARIABLES

      public static final String[] INTERNAL_JOB_VARIABLES
      All the internal job variables

    • DEPRECATED_VARIABLES

      public static final String[] DEPRECATED_VARIABLES

    • INTERNAL_VARIABLE_TRANSFORMATION_FILENAME_DIRECTORY

      public static final String INTERNAL_VARIABLE_TRANSFORMATION_FILENAME_DIRECTORY
      The transformation filename directory
      See Also:

    • INTERNAL_VARIABLE_TRANSFORMATION_FILENAME_NAME

      public static final String INTERNAL_VARIABLE_TRANSFORMATION_FILENAME_NAME
      The transformation filename name
      See Also:

    • INTERNAL_VARIABLE_TRANSFORMATION_NAME

      public static final String INTERNAL_VARIABLE_TRANSFORMATION_NAME
      The transformation name
      See Also:

    • INTERNAL_VARIABLE_TRANSFORMATION_REPOSITORY_DIRECTORY

      public static final String INTERNAL_VARIABLE_TRANSFORMATION_REPOSITORY_DIRECTORY
      The transformation directory
      See Also:

    • INTERNAL_VARIABLE_STEP_PARTITION_ID

      public static final String INTERNAL_VARIABLE_STEP_PARTITION_ID
      The step partition ID
      See Also:

    • INTERNAL_VARIABLE_STEP_PARTITION_NR

      public static final String INTERNAL_VARIABLE_STEP_PARTITION_NR
      The step partition number
      See Also:

    • INTERNAL_VARIABLE_SLAVE_SERVER_NUMBER

      public static final String INTERNAL_VARIABLE_SLAVE_SERVER_NUMBER
      The slave transformation number
      See Also:

    • INTERNAL_VARIABLE_SLAVE_SERVER_NAME

      public static final String INTERNAL_VARIABLE_SLAVE_SERVER_NAME
      The slave transformation name
      See Also:

    • INTERNAL_VARIABLE_CLUSTER_SIZE

      public static final String INTERNAL_VARIABLE_CLUSTER_SIZE
      The size of the cluster : number of slaves
      See Also:

    • INTERNAL_VARIABLE_STEP_UNIQUE_NUMBER

      public static final String INTERNAL_VARIABLE_STEP_UNIQUE_NUMBER
      The slave transformation number
      See Also:

    • INTERNAL_VARIABLE_CLUSTER_MASTER

      public static final String INTERNAL_VARIABLE_CLUSTER_MASTER
      Is this transformation running clustered, on the master?
      See Also:

    • INTERNAL_VARIABLE_CLUSTER_RUN_ID

      public static final String INTERNAL_VARIABLE_CLUSTER_RUN_ID
      The internal clustered run ID, unique across a clustered execution, important while doing parallel clustered runs
      See Also:

    • INTERNAL_VARIABLE_STEP_UNIQUE_COUNT

      public static final String INTERNAL_VARIABLE_STEP_UNIQUE_COUNT
      The size of the cluster : number of slaves
      See Also:

    • INTERNAL_VARIABLE_STEP_NAME

      public static final String INTERNAL_VARIABLE_STEP_NAME
      The step name
      See Also:

    • INTERNAL_VARIABLE_STEP_COPYNR

      public static final String INTERNAL_VARIABLE_STEP_COPYNR
      The step copy nr
      See Also:

    • MAX_NR_LOG_LINES

      public static final int MAX_NR_LOG_LINES
      The default maximum for the nr of lines in the GUI logs
      See Also:

    • MAX_NR_HISTORY_LINES

      public static final int MAX_NR_HISTORY_LINES
      The default maximum for the nr of lines in the history views
      See Also:

    • HISTORY_LINES_FETCH_SIZE

      public static final int HISTORY_LINES_FETCH_SIZE
      The default fetch size for lines of history.
      See Also:

    • MAX_LOG_LINE_TIMEOUT_MINUTES

      public static final int MAX_LOG_LINE_TIMEOUT_MINUTES
      The default log line timeout in minutes : 12 hours
      See Also:

    • WARNING

      public static final int WARNING
      UI-agnostic flag for warnings
      See Also:

    • ERROR

      public static final int ERROR
      UI-agnostic flag for warnings
      See Also:

    • INFO

      public static final int INFO
      UI-agnostic flag for warnings
      See Also:

    • SHOW_MESSAGE_DIALOG_DB_TEST_DEFAULT

      public static final int SHOW_MESSAGE_DIALOG_DB_TEST_DEFAULT
      See Also:

    • SHOW_MESSAGE_DIALOG_DB_TEST_SUCCESS

      public static final int SHOW_MESSAGE_DIALOG_DB_TEST_SUCCESS
      See Also:

    • SHOW_FATAL_ERROR

      public static final int SHOW_FATAL_ERROR
      See Also:

    • NOTE_MARGIN

      public static final int NOTE_MARGIN
      The margin between the text of a note and its border.
      See Also:

    • MAX_UNDO

      public static final int MAX_UNDO
      The default undo level for Kettle
      See Also:

    • KETTLE_VARIABLES_FILE

      public static final String KETTLE_VARIABLES_FILE
      The file that documents these variables.
      See Also:

    • KETTLE_LOG_SIZE_LIMIT

      public static final String KETTLE_LOG_SIZE_LIMIT
      If you set this environment variable you can limit the log size of all transformations and jobs that don't have the "log size limit" property set in their respective properties.
      See Also:

    • KETTLE_TRANS_LOG_DB

      public static final String KETTLE_TRANS_LOG_DB
      The name of the variable that defines the log database connection by default for all transformations
      See Also:

    • KETTLE_TRANS_LOG_SCHEMA

      public static final String KETTLE_TRANS_LOG_SCHEMA
      The name of the variable that defines the logging schema for all transformations
      See Also:

    • KETTLE_TRANS_LOG_TABLE

      public static final String KETTLE_TRANS_LOG_TABLE
      The name of the variable that defines the logging table for all transformations
      See Also:

    • KETTLE_JOB_LOG_DB

      public static final String KETTLE_JOB_LOG_DB
      The name of the variable that defines the log database connection by default for all jobs
      See Also:

    • KETTLE_JOB_LOG_SCHEMA

      public static final String KETTLE_JOB_LOG_SCHEMA
      The name of the variable that defines the logging schema for all jobs
      See Also:

    • KETTLE_SLAVE_DETECTION_TIMER

      public static final String KETTLE_SLAVE_DETECTION_TIMER
      The name of the variable that defines the timer used for detecting slave nodes.
      See Also:

    • KETTLE_JOB_LOG_TABLE

      public static final String KETTLE_JOB_LOG_TABLE
      The name of the variable that defines the logging table for all jobs
      See Also:

    • KETTLE_TRANS_PERFORMANCE_LOG_DB

      public static final String KETTLE_TRANS_PERFORMANCE_LOG_DB
      The name of the variable that defines the transformation performance log schema by default for all transformations
      See Also:

    • KETTLE_TRANS_PERFORMANCE_LOG_SCHEMA

      public static final String KETTLE_TRANS_PERFORMANCE_LOG_SCHEMA
      The name of the variable that defines the transformation performance log database connection by default for all transformations
      See Also:

    • KETTLE_TRANS_PERFORMANCE_LOG_TABLE

      public static final String KETTLE_TRANS_PERFORMANCE_LOG_TABLE
      The name of the variable that defines the transformation performance log table by default for all transformations
      See Also:

    • KETTLE_JOBENTRY_LOG_DB

      public static final String KETTLE_JOBENTRY_LOG_DB
      The name of the variable that defines the job entry log database by default for all jobs
      See Also:

    • KETTLE_JOBENTRY_LOG_SCHEMA

      public static final String KETTLE_JOBENTRY_LOG_SCHEMA
      The name of the variable that defines the job entry log schema by default for all jobs
      See Also:

    • KETTLE_JOBENTRY_LOG_TABLE

      public static final String KETTLE_JOBENTRY_LOG_TABLE
      The name of the variable that defines the job entry log table by default for all jobs
      See Also:

    • KETTLE_STEP_LOG_DB

      public static final String KETTLE_STEP_LOG_DB
      The name of the variable that defines the steps log database by default for all transformations
      See Also:

    • KETTLE_STEP_LOG_SCHEMA

      public static final String KETTLE_STEP_LOG_SCHEMA
      The name of the variable that defines the steps log schema by default for all transformations
      See Also:

    • KETTLE_STEP_LOG_TABLE

      public static final String KETTLE_STEP_LOG_TABLE
      The name of the variable that defines the steps log table by default for all transformations
      See Also:

    • KETTLE_CHANNEL_LOG_DB

      public static final String KETTLE_CHANNEL_LOG_DB
      The name of the variable that defines the log channel log database by default for all transformations and jobs
      See Also:

    • KETTLE_CHANNEL_LOG_SCHEMA

      public static final String KETTLE_CHANNEL_LOG_SCHEMA
      The name of the variable that defines the log channel log schema by default for all transformations and jobs
      See Also:

    • KETTLE_CHANNEL_LOG_TABLE

      public static final String KETTLE_CHANNEL_LOG_TABLE
      The name of the variable that defines the log channel log table by default for all transformations and jobs
      See Also:

    • KETTLE_METRICS_LOG_DB

      public static final String KETTLE_METRICS_LOG_DB
      The name of the variable that defines the metrics log database by default for all transformations and jobs
      See Also:

    • KETTLE_METRICS_LOG_SCHEMA

      public static final String KETTLE_METRICS_LOG_SCHEMA
      The name of the variable that defines the metrics log schema by default for all transformations and jobs
      See Also:

    • KETTLE_METRICS_LOG_TABLE

      public static final String KETTLE_METRICS_LOG_TABLE
      The name of the variable that defines the metrics log table by default for all transformations and jobs
      See Also:

    • KETTLE_CHECKPOINT_LOG_DB

      public static final String KETTLE_CHECKPOINT_LOG_DB
      The name of the variable that defines the checkpoint log database by default for all jobs
      See Also:

    • KETTLE_CHECKPOINT_LOG_SCHEMA

      public static final String KETTLE_CHECKPOINT_LOG_SCHEMA
      The name of the variable that defines the checkpoint log schema by default for all jobs
      See Also:

    • KETTLE_CHECKPOINT_LOG_TABLE

      public static final String KETTLE_CHECKPOINT_LOG_TABLE
      The name of the variable that defines the checkpoint log table by default for all jobs
      See Also:

    • KETTLE_SHARED_OBJECTS

      public static final String KETTLE_SHARED_OBJECTS
      Name of the environment variable to set the location of the shared object file (xml) for transformations and jobs
      See Also:

    • KETTLE_EMPTY_STRING_DIFFERS_FROM_NULL

      public static final String KETTLE_EMPTY_STRING_DIFFERS_FROM_NULL
      System wide flag to drive the evaluation of null in ValueMeta. If this setting is set to "Y", an empty string and null are different. Otherwise they are not.
      See Also:

    • KETTLE_FILTER_TREAT_NULLS_AS_NOT_ZERO

      public static final String KETTLE_FILTER_TREAT_NULLS_AS_NOT_ZERO
      System wide flag to allow the Filter step to treat nulls as not being 0 for CUST-270
      See Also:

    • KETTLE_DO_NOT_NORMALIZE_NULL_STRING_TO_EMPTY

      public static final String KETTLE_DO_NOT_NORMALIZE_NULL_STRING_TO_EMPTY
      This flag will prevent Kettle from converting null strings to empty strings in ValueMetaBase The default value is false.
      See Also:

    • KETTLE_DO_NOT_NORMALIZE_SPACES_ONLY_STRING_TO_EMPTY

      public static final String KETTLE_DO_NOT_NORMALIZE_SPACES_ONLY_STRING_TO_EMPTY
      This flag will force to return the original string with only spaces instead of an empty string.
      See Also:

    • KETTLE_XML_EMPTY_TAG_YIELDS_EMPTY_VALUE

      public static final String KETTLE_XML_EMPTY_TAG_YIELDS_EMPTY_VALUE
      This flag will prevent Kettle from yielding null as the value of an empty XML tag in XMLHandler The default value is false and an empty XML tag will produce a null value.
      See Also:

    • KETTLE_XML_MISSING_TAG_YIELDS_NULL_VALUE

      public static final String KETTLE_XML_MISSING_TAG_YIELDS_NULL_VALUE
      This flag will cause the "Get XML data" step to yield null values on missing elements and empty values on empty elements when set to "Y". By default, both empty elements and missing elements will yield empty values.
      See Also:

    • KETTLE_LENIENT_STRING_TO_NUMBER_CONVERSION

      public static final String KETTLE_LENIENT_STRING_TO_NUMBER_CONVERSION
      System wide flag to allow non-strict string to number conversion for backward compatibility. If this setting is set to "Y", an string starting with digits will be converted successfully into a number. (example: 192.168.1.1 will be converted into 192 or 192.168 depending on the decimal symbol). The default (N) will be to throw an error if non-numeric symbols are found in the string.
      See Also:

    • KETTLE_COMPATIBILITY_DB_IGNORE_TIMEZONE

      public static final String KETTLE_COMPATIBILITY_DB_IGNORE_TIMEZONE
      System wide flag to ignore timezone while writing date/timestamp value to the database. See PDI-10749 for details.
      See Also:

    • KETTLE_COMPATIBILITY_IMPORT_PATH_ADDITION_ON_VARIABLES

      public static final String KETTLE_COMPATIBILITY_IMPORT_PATH_ADDITION_ON_VARIABLES
      System wide flag to use the root path prefix for a directory reference. See PDI-6779 for details.
      See Also:

    • KETTLE_COMPATIBILITY_IGNORE_TABLE_LOGGING

      public static final String KETTLE_COMPATIBILITY_IGNORE_TABLE_LOGGING
      System wide flag to ignore logging table. See BACKLOG-15706 for details.
      See Also:

    • KETTLE_COMPATIBILITY_TEXT_FILE_OUTPUT_APPEND_NO_HEADER

      public static final String KETTLE_COMPATIBILITY_TEXT_FILE_OUTPUT_APPEND_NO_HEADER
      System wide flag to set or not append and header options dependency on Text file output step. See PDI-5252 for details.
      See Also:

    • KETTLE_COMPATIBILITY_MERGE_ROWS_USE_REFERENCE_STREAM_WHEN_IDENTICAL

      public static final String KETTLE_COMPATIBILITY_MERGE_ROWS_USE_REFERENCE_STREAM_WHEN_IDENTICAL
      System wide flag to control behavior of the merge rows (diff) step in case of "identical" comparison. (PDI-736) 'Y' preserves the old behavior and takes the fields from the reference stream 'N' enables the documented behavior and takes the fields from the comparison stream (correct behavior)
      See Also:

    • KETTLE_COMPATIBILITY_MEMORY_GROUP_BY_SUM_AVERAGE_RETURN_NUMBER_TYPE

      public static final String KETTLE_COMPATIBILITY_MEMORY_GROUP_BY_SUM_AVERAGE_RETURN_NUMBER_TYPE
      System wide flag to control behavior of the Memory Group By step in case of SUM and AVERAGE aggregation. (PDI-5537) 'Y' preserves the old behavior and always returns a Number type for SUM and Average aggregations 'N' enables the documented behavior of returning the same type as the input fields use (correct behavior).
      See Also:

    • KETTLE_COMPATIBILITY_INVOKE_FILES_WITH_OR_WITHOUT_FILE_EXTENSION

      public static final String KETTLE_COMPATIBILITY_INVOKE_FILES_WITH_OR_WITHOUT_FILE_EXTENSION
      System wide flag to control behavior of the ExecuteTransformationStep and ExecuteJobStep when a file is specified. This only is used when PDI is connected to repository 'Y' It is possible specify a file with the extension or not that is saved in repository 'N' Should not be specified the extension, in other words, should be specified the name of file saved in repository.
      See Also:

    • KETTLE_COMPATIBILITY_JSON_INPUT_LEGACY_MODE

      public static final String KETTLE_COMPATIBILITY_JSON_INPUT_LEGACY_MODE
      System-wide flag to keep legacy behavior on json input step. See PDI-19445 and PDI-18521 for details.
      See Also:

    • KETTLE_SYSTEM_HOSTNAME

      public static final String KETTLE_SYSTEM_HOSTNAME
      You can use this variable to speed up hostname lookup. Hostname lookup is performed by Kettle so that it is capable of logging the server on which a job or transformation is executed.
      See Also:

    • KETTLE_MAX_LOG_SIZE_IN_LINES

      public static final String KETTLE_MAX_LOG_SIZE_IN_LINES
      System wide flag to set the maximum number of log lines that are kept internally by Kettle. Set to 0 to keep all rows (default)
      See Also:

    • KETTLE_MAX_LOG_TIMEOUT_IN_MINUTES

      public static final String KETTLE_MAX_LOG_TIMEOUT_IN_MINUTES
      System wide flag to set the maximum age (in minutes) of a log line while being kept internally by Kettle. Set to 0 to keep all rows indefinitely (default)
      See Also:

    • KETTLE_REDIRECT_STDERR

      public static final String KETTLE_REDIRECT_STDERR
      System wide flag to determine whether standard error will be redirected to Kettle logging facilities. Will redirect if the value is equal ignoring case to the string "Y"
      See Also:

    • KETTLE_REDIRECT_STDOUT

      public static final String KETTLE_REDIRECT_STDOUT
      System wide flag to determine whether standard out will be redirected to Kettle logging facilities. Will redirect if the value is equal ignoring case to the string "Y"
      See Also:

    • KETTLE_CARTE_OBJECT_TIMEOUT_MINUTES

      public static final String KETTLE_CARTE_OBJECT_TIMEOUT_MINUTES
      This environment variable will set a time-out after which waiting, completed or stopped transformations and jobs will be automatically cleaned up. The default value is 1440 (one day).
      See Also:

    • KETTLE_STEP_PERFORMANCE_SNAPSHOT_LIMIT

      public static final String KETTLE_STEP_PERFORMANCE_SNAPSHOT_LIMIT
      System wide parameter: the maximum number of step performance snapshots to keep in memory. Set to 0 to keep all snapshots indefinitely (default)
      See Also:

    • KETTLE_MAX_JOB_TRACKER_SIZE

      public static final String KETTLE_MAX_JOB_TRACKER_SIZE
      A variable to configure the maximum number of job trackers kept in memory.
      See Also:

    • KETTLE_MAX_JOB_ENTRIES_LOGGED

      public static final String KETTLE_MAX_JOB_ENTRIES_LOGGED
      A variable to configure the maximum number of job entry results kept in memory for logging purposes.
      See Also:

    • KETTLE_MAX_LOGGING_REGISTRY_SIZE

      public static final String KETTLE_MAX_LOGGING_REGISTRY_SIZE
      A variable to configure the maximum number of logging registry entries kept in memory for logging purposes.
      See Also:

    • KETTLE_LOGGING_REGISTRY_PURGE_TIMEOUT

      public static final String KETTLE_LOGGING_REGISTRY_PURGE_TIMEOUT
      A variable to configure the logging registry's purge timer which will trigger the registry to cleanup entries.
      See Also:

    • KETTLE_LOG_TAB_REFRESH_DELAY

      public static final String KETTLE_LOG_TAB_REFRESH_DELAY
      A variable to configure the kettle log tab refresh delay.
      See Also:

    • KETTLE_LOG_TAB_REFRESH_PERIOD

      public static final String KETTLE_LOG_TAB_REFRESH_PERIOD
      A variable to configure the kettle log tab refresh period.
      See Also:

    • KETTLE_SAP_CONNECTION_FACTORY

      public static final String KETTLE_SAP_CONNECTION_FACTORY
      The name of the system wide variable that can contain the name of the SAP Connection factory for the test button in the DB dialog. This defaults to
      See Also:

    • KETTLE_SAP_CONNECTION_FACTORY_DEFAULT_NAME

      public static final String KETTLE_SAP_CONNECTION_FACTORY_DEFAULT_NAME
      The default SAP ERP connection factory
      See Also:

    • KETTLE_PLUGIN_CLASSES

      public static final String KETTLE_PLUGIN_CLASSES
      Name of the environment variable to specify additional classes to scan for plugin annotations
      See Also:

    • KETTLE_PLUGIN_PACKAGES

      public static final String KETTLE_PLUGIN_PACKAGES
      Name of the environment variable to specify additional packaged to scan for plugin annotations (warning: slow!)
      See Also:

    • KETTLE_TRANS_ROWSET_SIZE

      public static final String KETTLE_TRANS_ROWSET_SIZE
      Name of the environment variable that contains the size of the transformation rowset size. This overwrites values that you set transformation settings.
      See Also:

    • VERSION_COMMENT_INITIAL_VERSION

      public static final String VERSION_COMMENT_INITIAL_VERSION
      A general initial version comment
      See Also:

    • VERSION_COMMENT_EDIT_VERSION

      public static final String VERSION_COMMENT_EDIT_VERSION
      A general edit version comment
      See Also:

    • XML_FILE_KETTLE_STEPS

      public static final String XML_FILE_KETTLE_STEPS
      The XML file that contains the list of native Kettle steps
      See Also:

    • KETTLE_CORE_STEPS_FILE

      public static final String KETTLE_CORE_STEPS_FILE
      The name of the environment variable that will contain the alternative location of the kettle-steps.xml file
      See Also:

    • XML_FILE_KETTLE_PARTITION_PLUGINS

      public static final String XML_FILE_KETTLE_PARTITION_PLUGINS
      The XML file that contains the list of native partition plugins
      See Also:

    • KETTLE_CORE_JOBENTRIES_FILE

      public static final String KETTLE_CORE_JOBENTRIES_FILE
      The name of the environment variable that will contain the alternative location of the kettle-job-entries.xml file
      See Also:

    • XML_FILE_KETTLE_SERVLETS

      public static final String XML_FILE_KETTLE_SERVLETS
      The XML file that contains the list of native Kettle Carte Servlets
      See Also:

    • XML_FILE_KETTLE_VALUEMETA_PLUGINS

      public static final String XML_FILE_KETTLE_VALUEMETA_PLUGINS
      The XML file that contains the list of native Kettle value metadata plugins
      See Also:

    • XML_FILE_KETTLE_PASSWORD_ENCODER_PLUGINS

      public static final String XML_FILE_KETTLE_PASSWORD_ENCODER_PLUGINS
      The XML file that contains the list of native Kettle two-way password encoder plugins
      See Also:

    • KETTLE_VALUEMETA_PLUGINS_FILE

      public static final String KETTLE_VALUEMETA_PLUGINS_FILE
      The name of the environment variable that will contain the alternative location of the kettle-valuemeta-plugins.xml file
      See Also:

    • KETTLE_PASSWORD_ENCODER_PLUGIN

      public static final String KETTLE_PASSWORD_ENCODER_PLUGIN
      Specifies the password encoding plugin to use by ID (Kettle is the default).
      See Also:

    • KETTLE_PASSWORD_ENCODER_PLUGINS_FILE

      public static final String KETTLE_PASSWORD_ENCODER_PLUGINS_FILE
      The name of the environment variable that will contain the alternative location of the kettle-password-encoder-plugins.xml file
      See Also:

    • KETTLE_TWO_WAY_PASSWORD_ENCODER_SEED

      public static final String KETTLE_TWO_WAY_PASSWORD_ENCODER_SEED
      The name of the Kettle encryption seed environment variable for the KettleTwoWayPasswordEncoder class
      See Also:

    • XML_FILE_KETTLE_LOGGING_PLUGINS

      public static final String XML_FILE_KETTLE_LOGGING_PLUGINS
      The XML file that contains the list of native Kettle logging plugins
      See Also:

    • KETTLE_LOGGING_PLUGINS_FILE

      public static final String KETTLE_LOGGING_PLUGINS_FILE
      The name of the environment variable that will contain the alternative location of the kettle-logging-plugins.xml file
      See Also:

    • KETTLE_CORE_SERVLETS_FILE

      public static final String KETTLE_CORE_SERVLETS_FILE
      The name of the environment variable that will contain the alternative location of the kettle-servlets.xml file
      See Also:

    • KETTLE_ROWSET_GET_TIMEOUT

      public static final String KETTLE_ROWSET_GET_TIMEOUT
      The name of the variable that optionally contains an alternative rowset get timeout (in ms). This only makes a difference for extremely short lived transformations.
      See Also:

    • KETTLE_ROWSET_PUT_TIMEOUT

      public static final String KETTLE_ROWSET_PUT_TIMEOUT
      The name of the variable that optionally contains an alternative rowset put timeout (in ms). This only makes a difference for extremely short lived transformations.
      See Also:

    • KETTLE_BATCHING_ROWSET

      public static final String KETTLE_BATCHING_ROWSET
      Set this variable to Y if you want to test a more efficient batching row set. (default = N)
      See Also:

    • KETTLE_FILE_OUTPUT_MAX_STREAM_COUNT

      public static final String KETTLE_FILE_OUTPUT_MAX_STREAM_COUNT
      Set this variable to limit max number of files the Text File Output step can have open at one time.
      See Also:

    • KETTLE_FILE_OUTPUT_MAX_STREAM_LIFE

      public static final String KETTLE_FILE_OUTPUT_MAX_STREAM_LIFE
      This variable contains the number of milliseconds between flushes of all open files in the Text File Output step.
      See Also:

    • KETTLE_DISABLE_CONSOLE_LOGGING

      public static final String KETTLE_DISABLE_CONSOLE_LOGGING
      Set this variable to Y to disable standard Kettle logging to the console. (stdout)
      See Also:

    • KETTLE_REPOSITORY

      public static final String KETTLE_REPOSITORY
      Set this variable to with the intended repository name ( in repositories.xml )
      See Also:

    • KETTLE_USER

      public static final String KETTLE_USER
      Set this variable to with the intended username to pass as repository credentials
      See Also:

    • KETTLE_PASSWORD

      public static final String KETTLE_PASSWORD
      Set this variable to with the intended password to pass as repository credentials
      See Also:

    • XML_FILE_KETTLE_JOB_ENTRIES

      public static final String XML_FILE_KETTLE_JOB_ENTRIES
      The XML file that contains the list of native Kettle job entries
      See Also:

    • XML_FILE_KETTLE_REPOSITORIES

      public static final String XML_FILE_KETTLE_REPOSITORIES
      The XML file that contains the list of native Kettle repository types (DB, File, etc)
      See Also:

    • XML_FILE_KETTLE_DATABASE_TYPES

      public static final String XML_FILE_KETTLE_DATABASE_TYPES
      The XML file that contains the list of native Kettle database types (MySQL, Oracle, etc)
      See Also:

    • XML_FILE_KETTLE_COMPRESSION_PROVIDERS

      public static final String XML_FILE_KETTLE_COMPRESSION_PROVIDERS
      The XML file that contains the list of native Kettle compression providers (None, ZIP, GZip, etc.)
      See Also:

    • XML_FILE_KETTLE_AUTHENTICATION_PROVIDERS

      public static final String XML_FILE_KETTLE_AUTHENTICATION_PROVIDERS
      The XML file that contains the list of native Kettle compression providers (None, ZIP, GZip, etc.)
      See Also:

    • XML_FILE_KETTLE_EXTENSION_POINTS

      public static final String XML_FILE_KETTLE_EXTENSION_POINTS
      The XML file that contains the list of native extension points (None by default, this is mostly for OEM purposes)
      See Also:

    • XML_FILE_KETTLE_REGISTRY_EXTENSIONS

      public static final String XML_FILE_KETTLE_REGISTRY_EXTENSIONS
      The XML file that contains the list of native extension points (None by default, this is mostly for OEM purposes)
      See Also:

    • XML_FILE_KETTLE_LIFECYCLE_LISTENERS

      public static final String XML_FILE_KETTLE_LIFECYCLE_LISTENERS
      The XML file that contains the list of lifecycle listeners
      See Also:

    • XML_FILE_KETTLE_ENGINES

      public static final String XML_FILE_KETTLE_ENGINES
      The XML file that contains the list of native engines
      See Also:

    • KETTLE_TRANS_PAN_JVM_EXIT_CODE

      public static final String KETTLE_TRANS_PAN_JVM_EXIT_CODE
      the value the Pan JVM should return on exit.
      See Also:

    • KETTLE_DEFAULT_NUMBER_FORMAT

      public static final String KETTLE_DEFAULT_NUMBER_FORMAT
      The name of the variable containing an alternative default number format
      See Also:

    • KETTLE_DEFAULT_BIGNUMBER_FORMAT

      public static final String KETTLE_DEFAULT_BIGNUMBER_FORMAT
      The name of the variable containing an alternative default bignumber format
      See Also:

    • KETTLE_DEFAULT_INTEGER_FORMAT

      public static final String KETTLE_DEFAULT_INTEGER_FORMAT
      The name of the variable containing an alternative default integer format
      See Also:

    • KETTLE_DEFAULT_DATE_FORMAT

      public static final String KETTLE_DEFAULT_DATE_FORMAT
      The name of the variable containing an alternative default date format
      See Also:

    • KETTLE_AGGREGATION_MIN_NULL_IS_VALUED

      public static final String KETTLE_AGGREGATION_MIN_NULL_IS_VALUED
      See Also:

    • KETTLE_AGGREGATION_ALL_NULLS_ARE_ZERO

      public static final String KETTLE_AGGREGATION_ALL_NULLS_ARE_ZERO
      See Also:

    • KETTLE_DEFAULT_TIMESTAMP_FORMAT

      public static final String KETTLE_DEFAULT_TIMESTAMP_FORMAT
      The name of the variable containing an alternative default timestamp format
      See Also:

    • KETTLE_SPLIT_FIELDS_REMOVE_ENCLOSURE

      public static final String KETTLE_SPLIT_FIELDS_REMOVE_ENCLOSURE
      Variable that is responsible for removing enclosure symbol after splitting the string
      See Also:

    • KETTLE_ALLOW_EMPTY_FIELD_NAMES_AND_TYPES

      public static final String KETTLE_ALLOW_EMPTY_FIELD_NAMES_AND_TYPES
      Variable that is responsible for checking empty field names and types.
      See Also:

    • KETTLE_GLOBAL_LOG_VARIABLES_CLEAR_ON_EXPORT

      public static final String KETTLE_GLOBAL_LOG_VARIABLES_CLEAR_ON_EXPORT
      Set this variable to false to preserve global log variables defined in transformation / job Properties -> Log panel. Changing it to true will clear all global log variables when export transformation / job
      See Also:

    • KETTLE_TRANS_FINISHED_BLOCKING_QUEUE_SIZE

      public static final String KETTLE_TRANS_FINISHED_BLOCKING_QUEUE_SIZE
      Property controls the capacity of the transFinishedBlockingQueue in Trans.
      See Also:

    • KETTLE_COMPATIBILITY_CALCULATION_TIMEZONE_DECOMPOSITION

      public static final String KETTLE_COMPATIBILITY_CALCULATION_TIMEZONE_DECOMPOSITION
      Compatibility settings for ValueDataUtil.hourOfDay(ValueMetaInterface, Object). Switches off the fix for calculation of timezone decomposition.
      See Also:

    • KETTLE_COMPATIBILITY_SET_ERROR_ON_SPECIFIC_JOB_ENTRIES

      public static final String KETTLE_COMPATIBILITY_SET_ERROR_ON_SPECIFIC_JOB_ENTRIES
      Compatibility settings for setNrErrors
      See Also:

    • KETTLE_COMPATIBILITY_SEND_RESULT_XML_WITH_FULL_STATUS

      public static final String KETTLE_COMPATIBILITY_SEND_RESULT_XML_WITH_FULL_STATUS
      See Also:

    • KETTLE_COMPATIBILITY_SELECT_VALUES_TYPE_CHANGE_USES_TYPE_DEFAULTS

      public static final String KETTLE_COMPATIBILITY_SELECT_VALUES_TYPE_CHANGE_USES_TYPE_DEFAULTS
      See Also:

    • KETTLE_COMPATIBILITY_XML_OUTPUT_NULL_VALUES

      public static final String KETTLE_COMPATIBILITY_XML_OUTPUT_NULL_VALUES
      See Also:

    • KETTLE_COMPATIBILITY_XML_OUTPUT_NULL_IF_FIELD_VALUES

      public static final String KETTLE_COMPATIBILITY_XML_OUTPUT_NULL_IF_FIELD_VALUES
      See Also:

    • KETTLE_COMPATIBILITY_USE_JDBC_METADATA

      public static final String KETTLE_COMPATIBILITY_USE_JDBC_METADATA
      See Also:

    • KETTLE_COMPATIBILITY_DB_LOOKUP_USE_FIELDS_RETURN_TYPE_CHOSEN_IN_UI

      public static final String KETTLE_COMPATIBILITY_DB_LOOKUP_USE_FIELDS_RETURN_TYPE_CHOSEN_IN_UI
      See Also:

    • KETTLE_COMPATIBILITY_TEXT_FILE_INPUT_USE_LENIENT_ENCLOSURE_HANDLING

      public static final String KETTLE_COMPATIBILITY_TEXT_FILE_INPUT_USE_LENIENT_ENCLOSURE_HANDLING
      See Also:

    • KETTLE_COMPATIBILITY_MDI_INJECTED_FILE_ALWAYS_IN_FILESYSTEM

      public static final String KETTLE_COMPATIBILITY_MDI_INJECTED_FILE_ALWAYS_IN_FILESYSTEM
      See Also:

    • KETTLE_JSON_INPUT_INCLUDE_NULLS

      public static final String KETTLE_JSON_INPUT_INCLUDE_NULLS
      See Also:

    • KETTLE_COMPATIBILITY_CONCAT_FIELDS_SPLIT_ROWS_HEADER_OFFSET

      public static final String KETTLE_COMPATIBILITY_CONCAT_FIELDS_SPLIT_ROWS_HEADER_OFFSET
      See Also:

    • KETTLE_JSON_OUTPUT_FORCE_SAME_OUTPUT_FILE

      public static final String KETTLE_JSON_OUTPUT_FORCE_SAME_OUTPUT_FILE
      This property when set to Y force the same output file even when splits is required. See PDI-19064 for details
      See Also:

    • XML_FILE_KETTLE_IMPORT_RULES

      public static final String XML_FILE_KETTLE_IMPORT_RULES
      The XML file that contains the list of native import rules
      See Also:

    • RELEASE

      public static final Const.ReleaseType RELEASE
      The release type of this compilation

    • PENTAHO_METASTORE_FOLDER

      public static final String PENTAHO_METASTORE_FOLDER
      The system environment variable indicating where the alternative location for the Pentaho metastore folder is located.
      See Also:

    • PENTAHO_METASTORE_NAME

      public static final String PENTAHO_METASTORE_NAME
      The name of the local client MetaStore
      See Also:

    • KETTLE_LOG_MARK_MAPPINGS

      public static final String KETTLE_LOG_MARK_MAPPINGS
      A variable to configure turning on/off detailed subjects in log.
      See Also:

    • KETTLE_CARTE_JETTY_ACCEPTORS

      public static final String KETTLE_CARTE_JETTY_ACCEPTORS
      A variable to configure jetty option: acceptors for Carte
      See Also:

    • KETTLE_CARTE_JETTY_ACCEPT_QUEUE_SIZE

      public static final String KETTLE_CARTE_JETTY_ACCEPT_QUEUE_SIZE
      A variable to configure jetty option: acceptQueueSize for Carte
      See Also:

    • KETTLE_CARTE_JETTY_RES_MAX_IDLE_TIME

      public static final String KETTLE_CARTE_JETTY_RES_MAX_IDLE_TIME
      A variable to configure jetty option: lowResourcesMaxIdleTime for Carte
      See Also:

    • KETTLE_CARTE_REFRESH_STATUS

      public static final String KETTLE_CARTE_REFRESH_STATUS
      A variable to configure refresh for carte job/trans status page
      See Also:

    • S3VFS_USE_TEMPORARY_FILE_ON_UPLOAD_DATA

      public static final String S3VFS_USE_TEMPORARY_FILE_ON_UPLOAD_DATA
      A variable to configure s3vfs to use a temporary file on upload data to S3 Amazon."
      See Also:

    • KETTLE_MAX_TAB_LENGTH

      public static final String KETTLE_MAX_TAB_LENGTH
      A variable to configure Tab size"
      See Also:

    • KETTLE_LOG_GENERAL_OBJECTS_TO_DI_LOGGER

      public static final String KETTLE_LOG_GENERAL_OBJECTS_TO_DI_LOGGER
      A variable to log log info of logobjecttype GENERAL"
      See Also:

    • VFS_USER_DIR_IS_ROOT

      public static final String VFS_USER_DIR_IS_ROOT
      A variable to configure VFS USER_DIR_IS_ROOT option: should be "true" or "false" SftpFileSystemConfigBuilder.USER_DIR_IS_ROOT
      See Also:

    • SHELL_STEP_ENVIRONMENT_VARIABLES_TO_IGNORE

      public static final String SHELL_STEP_ENVIRONMENT_VARIABLES_TO_IGNORE
      A variable to configure environment variables to ignore when initializing shell step
      See Also:

    • SHELL_STEP_ENVIRONMENT_VARIABLES_TO_IGNORE_DEFAULT

      public static final String SHELL_STEP_ENVIRONMENT_VARIABLES_TO_IGNORE_DEFAULT
      The default value for the variable to configure environment variables to ignore when initializing shell step
      See Also:

    • KETTLE_ZIP_MIN_INFLATE_RATIO

      public static final String KETTLE_ZIP_MIN_INFLATE_RATIO

      A variable to configure the minimum allowed ratio between de- and inflated bytes to detect a zipbomb.

      If not set or if the configured value is invalid, it defaults to

      Check PDI-17586 for more details.

      See Also:

    • KETTLE_ZIP_MIN_INFLATE_RATIO_DEFAULT

      public static final Double KETTLE_ZIP_MIN_INFLATE_RATIO_DEFAULT

      The default value for the KETTLE_ZIP_MIN_INFLATE_RATIO as a Double.

      Check PDI-17586 for more details.

      See Also:

    • KETTLE_ZIP_MIN_INFLATE_RATIO_DEFAULT_STRING

      public static final String KETTLE_ZIP_MIN_INFLATE_RATIO_DEFAULT_STRING

      The default value for the KETTLE_ZIP_MIN_INFLATE_RATIO as a String.

      Check PDI-17586 for more details.

      See Also:

    • KETTLE_ZIP_MAX_ENTRY_SIZE

      public static final String KETTLE_ZIP_MAX_ENTRY_SIZE

      A variable to configure the maximum file size of a single zip entry.

      If not set or if the configured value is invalid, it defaults to

      Check PDI-17586 for more details.

      See Also:

    • KETTLE_ZIP_MAX_ENTRY_SIZE_DEFAULT

      public static final Long KETTLE_ZIP_MAX_ENTRY_SIZE_DEFAULT

      The default value for the KETTLE_ZIP_MAX_ENTRY_SIZE as a Long.

      Check PDI-17586 for more details.

      See Also:

    • KETTLE_ZIP_MAX_ENTRY_SIZE_DEFAULT_STRING

      public static final String KETTLE_ZIP_MAX_ENTRY_SIZE_DEFAULT_STRING

      The default value for the KETTLE_ZIP_MAX_ENTRY_SIZE as a String.

      Check PDI-17586 for more details.

      See Also:

    • KETTLE_ZIP_MAX_TEXT_SIZE

      public static final String KETTLE_ZIP_MAX_TEXT_SIZE

      A variable to configure the maximum number of characters of text that are extracted before an exception is thrown during extracting text from documents.

      If not set or if the configured value is invalid, it defaults to

      Check PDI-17586 for more details.

      See Also:

    • KETTLE_ZIP_MAX_TEXT_SIZE_DEFAULT

      public static final Long KETTLE_ZIP_MAX_TEXT_SIZE_DEFAULT

      The default value for the KETTLE_ZIP_MAX_TEXT_SIZE as a Long.

      Check PDI-17586 for more details.

      See Also:

    • KETTLE_ZIP_MAX_TEXT_SIZE_DEFAULT_STRING

      public static final String KETTLE_ZIP_MAX_TEXT_SIZE_DEFAULT_STRING

      The default value for the KETTLE_ZIP_MAX_TEXT_SIZE as a Long.

      Check PDI-17586 for more details.

      See Also:

    • KETTLE_ZIP_NEGATIVE_MIN_INFLATE

      public static final Double KETTLE_ZIP_NEGATIVE_MIN_INFLATE

      The default value for the KETTLE_ZIP_NEGATIVE_MIN_INFLATE as a Double.

      Check PDI-18489 for more details.

    • KETTLE_XLSX_ZIP_BOMB_CHECK

      public static final String KETTLE_XLSX_ZIP_BOMB_CHECK

      This environment variable is used to define whether the check of xlsx zip bomb is performed. This is set to false by default.

      See Also:

    • KETTLE_USE_AWS_DEFAULT_CREDENTIALS

      public static final String KETTLE_USE_AWS_DEFAULT_CREDENTIALS

      A variable to configure if the S3 input / output steps should use the Amazon Default Credentials Provider Chain even if access credentials are specified within the transformation.

      See Also:

    • KETTLE_COMPATIBILITY_ALLOW_S3_LEGACY_URI

      public static final String KETTLE_COMPATIBILITY_ALLOW_S3_LEGACY_URI
      This environment variable allows to enable s3 legacy URI. Please check: PDI-19732.
      See Also:

    • SHARED_STREAMING_BATCH_POOL_SIZE

      public static final String SHARED_STREAMING_BATCH_POOL_SIZE

      This environment variable is used by streaming consumer steps to limit the total of concurrent batches across transformations.

      See Also:

    • KINESIS_POLLING_CONFIG_MAX_RECORDS

      public static final String KINESIS_POLLING_CONFIG_MAX_RECORDS

      This environment variable is used by the Kinesis consumer to control the number of records retrieved by the PollingConfig, if used. Ignored with Enhanced Fan Out./p>

      See Also:

    • SHIM_DRIVER_DEPLOYMENT_LOCATION

      public static final String SHIM_DRIVER_DEPLOYMENT_LOCATION

      This environment variable is used to specify a location used to deploy a shim driver into PDI.

      See Also:

    • KETTLE_FATAL_ERROR_ON_HDFS_NOT_FOUND

      public static final String KETTLE_FATAL_ERROR_ON_HDFS_NOT_FOUND
      Determines whether failure to find the HDFS file system is a fatal error in Hadoop File Input step. Default (legacy) behavior is false.
      See Also:

    • KETTLE_FATAL_ERROR_ON_HDFS_NOT_FOUND_DEFAULT

      public static final String KETTLE_FATAL_ERROR_ON_HDFS_NOT_FOUND_DEFAULT
      See Also:

    • KETTLE_RETRY_OPEN_XML_STREAM

      public static final String KETTLE_RETRY_OPEN_XML_STREAM

      This environment is used to specify how many attempts before failing to read an XML from within a Zip file while multy-thread execution and using XMLHandler.

      See Also:

    • ALLOW_EXTERNAL_ENTITIES_FOR_XSD_VALIDATION

      public static final String ALLOW_EXTERNAL_ENTITIES_FOR_XSD_VALIDATION

      This environment variable is used by XSD validation steps to enable or disable external entities.

      By default external entities are allowed.

      See Also:

    • ALLOW_EXTERNAL_ENTITIES_FOR_XSD_VALIDATION_DEFAULT

      public static final String ALLOW_EXTERNAL_ENTITIES_FOR_XSD_VALIDATION_DEFAULT
      See Also:

    • KETTLE_BIGDECIMAL_DIVISION_PRECISION

      public static final String KETTLE_BIGDECIMAL_DIVISION_PRECISION

      This environment variable is used to define the default division result precision between BigDecimals.

      By default, and when precision is -1, precision is unlimited.

      See Also:

    • KETTLE_BIGDECIMAL_DIVISION_PRECISION_DEFAULT

      public static final String KETTLE_BIGDECIMAL_DIVISION_PRECISION_DEFAULT
      See Also:

    • KETTLE_BIGDECIMAL_DIVISION_ROUNDING_MODE

      public static final String KETTLE_BIGDECIMAL_DIVISION_ROUNDING_MODE

      This environment variable is used to define the default division result rounding mode between BigDecimals.

      By default, rouding mode is half even.

      See Also:

    • KETTLE_BIGDECIMAL_DIVISION_ROUNDING_MODE_DEFAULT

      public static final String KETTLE_BIGDECIMAL_DIVISION_ROUNDING_MODE_DEFAULT
      See Also:

    • KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE

      public static final String KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE

      This environment variable is used to define how Timestamp should be converted to a number and vice-versa.

      Three options exist:

      The default is "LEGACY".

      See Also:

    • KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE_LEGACY

      public static final String KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE_LEGACY

      The value to use for setting the KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE as it behaved on former versions.

      See Also:

    • KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE_MILLISECONDS

      public static final String KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE_MILLISECONDS

      The value to use for setting the KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE to use milliseconds.

      See Also:

    • KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE_NANOSECONDS

      public static final String KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE_NANOSECONDS

      The value to use for setting the KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE to use nanoseconds.

      See Also:

    • KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE_DEFAULT

      public static final String KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE_DEFAULT

      The default value for the KETTLE_TIMESTAMP_NUMBER_CONVERSION_MODE.

      See Also:

    • KETTLE_RETURN_ESCAPED_URI_STRINGS

      public static final String KETTLE_RETURN_ESCAPED_URI_STRINGS
      This environment variable will be used to determine whether file URI strings returned from input steps are returned encoded (spaces and other special characters escaped) or decoded (default legacy behavior).
      See Also:

    • KETTLE_DEFAULT_CHECKSUM_EVALUATION_METHOD

      public static final String KETTLE_DEFAULT_CHECKSUM_EVALUATION_METHOD

      This environment variable is used to define how which calculation method is to be used by the 'Add a Checksum' step.

      Three options exist:

      The default is "BYTES".

      See Also:

    • KETTLE_CHECKSUM_EVALUATION_METHOD_BYTES

      public static final String KETTLE_CHECKSUM_EVALUATION_METHOD_BYTES

      The value to use for setting the KETTLE_DEFAULT_CHECKSUM_EVALUATION_METHOD, so that Checksum is calculated based on Byte representation of fields. Calculation method used by version 8.1 and after.

      See Also:

    • KETTLE_CHECKSUM_EVALUATION_METHOD_PENTAHO_STRINGS

      public static final String KETTLE_CHECKSUM_EVALUATION_METHOD_PENTAHO_STRINGS

      The value to use for setting the KETTLE_DEFAULT_CHECKSUM_EVALUATION_METHOD, so that Checksum is calculated based on Pentaho String representation of fields (applying format masks). Calculation method used by version 7.1 and prior versions.

      See Also:

    • KETTLE_CHECKSUM_EVALUATION_METHOD_NATIVE_STRINGS

      public static final String KETTLE_CHECKSUM_EVALUATION_METHOD_NATIVE_STRINGS

      The value to use for setting the KETTLE_DEFAULT_CHECKSUM_EVALUATION_METHOD, so that Checksum is calculated based on Native String representation of fields. Calculation method used by version 8.0.

      See Also:

    • KETTLE_CHECKSUM_EVALUATION_METHOD_DEFAULT

      public static final String KETTLE_CHECKSUM_EVALUATION_METHOD_DEFAULT

      The default value for the KETTLE_DEFAULT_CHECKSUM_EVALUATION_METHOD.

      See Also:

    • KETTLE_DATEDIFF_DST_AWARE

      public static final String KETTLE_DATEDIFF_DST_AWARE

      While one assumes that a day has 24 hours, due to daylight savings time settings, it may have 23 hours (the day Summer time goes into effect) or 25 hours (Winter time).

      Imagine Summer time: when clocks reach 1:00, it goes forward 1 hour to 2:00

      This means that, when adding 2 hours to 0:30, one gets 3:30

      By setting this environment variable to "N", DateDiff performs calculations based on local time; as so, the difference between these two values (3:30 and 0:30) will be 3 hours difference.

      Setting this environment variable to "Y", DateDiff performs calculations based on UTC time; as so, the difference between these two values (3:30 and 0:30) will be 2 hours difference.

      The default is "N".

      See Also:

    • KETTLE_DATEDIFF_DST_AWARE_DEFAULT

      public static final String KETTLE_DATEDIFF_DST_AWARE_DEFAULT

      The default value for the KETTLE_DATEDIFF_DST_AWARE.

      See Also:

    • KETTLE_AUTO_UPDATE_SITE_FILE

      public static final String KETTLE_AUTO_UPDATE_SITE_FILE
      If true, kettle check for new site files to update in the named cluster every time a named cluster is resolved
      See Also:

    • KETTLE_USE_META_FILE_CACHE

      public static final String KETTLE_USE_META_FILE_CACHE
      If true, use a cache when loading Trans/Job/Step metas vs reading from file system/repository for each load. Note: cache is currently broken; variable spaces do not get replaced upon loads of the same meta, so parameters that have changed do not get updated. This should be off by default.
      See Also:

    • KETTLE_USE_META_FILE_CACHE_DEFAULT

      public static final String KETTLE_USE_META_FILE_CACHE_DEFAULT
      See Also:

    • KETTLE_SKIP_JOB_LOGGING

      public static final String KETTLE_SKIP_JOB_LOGGING
      If true, do not append real-time logging during Job execution. This prevents the logging from growing too large in memory, especially for long-running jobs or jobs with a large number of subjobs/subtrans However, if set to "Y", it would prevent users from seeing any log data visible in tools like the Pentaho Ops Mart, the kettle job status monitor, and other similar tools. It does not change anything regarding what data gets written out via log4j such as the tomcat catalina.out log, or pentaho.log, etc.
      See Also:

    • KETTLE_SKIP_JOB_LOGGING_DEFAULT

      public static final String KETTLE_SKIP_JOB_LOGGING_DEFAULT
      See Also:

    • KETTLE_PYTHON_STEP_REPLACE_NULLS

      public static final String KETTLE_PYTHON_STEP_REPLACE_NULLS
      Value used to replace nulls in Python Executor Step Input Lines. Empty will mean no replacement will be done
      See Also:

    • COMPATIBILITY_JOB_EXECUTE_FOR_EVERY_ROW_ON_NO_INPUT

      public static final String COMPATIBILITY_JOB_EXECUTE_FOR_EVERY_ROW_ON_NO_INPUT
      Value to revert the behaviour of the flag "Execute every Input Row" behavior back to executing even with 0 rows as job input mode.
      See Also:

    • COMPATIBILITY_TRANS_EXECUTE_FOR_EVERY_ROW_ON_NO_INPUT

      public static final String COMPATIBILITY_TRANS_EXECUTE_FOR_EVERY_ROW_ON_NO_INPUT
      Value to revert the behaviour of the flag "Execute every Input Row" behavior back to executing even with 0 rows as trans input mode.
      See Also:

    • COMPATIBILITY_SHOW_WARNINGS_EXECUTE_EVERY_INPUT_ROW

      public static final String COMPATIBILITY_SHOW_WARNINGS_EXECUTE_EVERY_INPUT_ROW
      Value to show/not show the Warning messages regarding the configured behaviour of the flag "Execute every Input Row"
      See Also:

    • STRING_ONLY_USED_DB_TO_XML

      public static final String STRING_ONLY_USED_DB_TO_XML
      Value to Configure if we want to export only the used connections to the XML file
      See Also:

  • Constructor Details

    • Const

      public Const()

  • Method Details

    • checkXlsxZipBomb

      public static boolean checkXlsxZipBomb()

    • getShimDriverDeploymentLocation

      public static String getShimDriverDeploymentLocation()

    • round

      public static double round(double f, int places)
      rounds double f to any number of places after decimal point Does arithmetic using BigDecimal class to avoid integer overflow while rounding
      Parameters:
      f - The value to round
      places - The number of decimal places
      Returns:
      The rounded floating point value

    • round

      public static double round(double f, int places, int roundingMode)
      rounds double f to any number of places after decimal point Does arithmetic using BigDecimal class to avoid integer overflow while rounding
      Parameters:
      f - The value to round
      places - The number of decimal places
      roundingMode - The mode for rounding, e.g. java.math.BigDecimal.ROUND_HALF_EVEN
      Returns:
      The rounded floating point value

    • round

      public static BigDecimal round(BigDecimal f, int places, int roundingMode)
      rounds BigDecimal f to any number of places after decimal point Does arithmetic using BigDecimal class to avoid integer overflow while rounding
      Parameters:
      f - The value to round
      places - The number of decimal places
      roundingMode - The mode for rounding, e.g. java.math.BigDecimal.ROUND_HALF_EVEN
      Returns:
      The rounded floating point value

    • round

      public static long round(long f, int places, int roundingMode)
      rounds long f to any number of places after decimal point Does arithmetic using BigDecimal class to avoid integer overflow while rounding
      Parameters:
      f - The value to round
      places - The number of decimal places
      roundingMode - The mode for rounding, e.g. java.math.BigDecimal.ROUND_HALF_EVEN
      Returns:
      The rounded floating point value

    • toInt

      public static int toInt(String str, int def)
      Convert a String into an integer. If the conversion fails, assign a default value.
      Parameters:
      str - The String to convert to an integer
      def - The default value
      Returns:
      The converted value or the default.

    • toLong

      public static long toLong(String str, long def)
      Convert a String into a long integer. If the conversion fails, assign a default value.
      Parameters:
      str - The String to convert to a long integer
      def - The default value
      Returns:
      The converted value or the default.

    • toDouble

      public static double toDouble(String str, double def)
      Convert a String into a double. If the conversion fails, assign a default value.
      Parameters:
      str - The String to convert to a double
      def - The default value
      Returns:
      The converted value or the default.

    • toDate

      public static Date toDate(String str, Date def)
      Convert a String into a date. The date format is yyyy/MM/dd HH:mm:ss.SSS. If the conversion fails, assign a default value.
      Parameters:
      str - The String to convert into a Date
      def - The default value
      Returns:
      The converted value or the default.

    • isSpace

      public static boolean isSpace(char c)
      Determines whether or not a character is considered a space. A character is considered a space in Kettle if it is a space, a tab, a newline or a cariage return.
      Parameters:
      c - The character to verify if it is a space.
      Returns:
      true if the character is a space. false otherwise.

    • ltrim

      public static String ltrim(String source)
      Left trim: remove spaces to the left of a String.
      Parameters:
      source - The String to left trim
      Returns:
      The left trimmed String

    • rtrim

      public static String rtrim(String source)
      Right trim: remove spaces to the right of a string
      Parameters:
      source - The string to right trim
      Returns:
      The trimmed string.

    • trim

      public static String trim(String str)
      Trims a string: removes the leading and trailing spaces of a String.
      Parameters:
      str - The string to trim
      Returns:
      The trimmed string.

    • rightPad

      public static String rightPad(String ret, int limit)
      Right pad a string: adds spaces to a string until a certain length. If the length is smaller then the limit specified, the String is truncated.
      Parameters:
      ret - The string to pad
      limit - The desired length of the padded string.
      Returns:
      The padded String.

    • rightPad

      public static String rightPad(StringBuffer ret, int limit)
      Right pad a StringBuffer: adds spaces to a string until a certain length. If the length is smaller then the limit specified, the String is truncated. MB - New version is nearly 25% faster
      Parameters:
      ret - The StringBuffer to pad
      limit - The desired length of the padded string.
      Returns:
      The padded String.

    • rightPad

      public static String rightPad(StringBuilder ret, int limit)
      Right pad a StringBuilder: adds spaces to a string until a certain length. If the length is smaller then the limit specified, the String is truncated. MB - New version is nearly 25% faster
      Parameters:
      ret - The StringBuilder to pad
      limit - The desired length of the padded string.
      Returns:
      The padded String.

    • replace

      public static String replace(String string, String repl, String with)
      Replace values in a String with another. 33% Faster using replaceAll this way than original method
      Parameters:
      string - The original String.
      repl - The text to replace
      with - The new text bit
      Returns:
      The resulting string with the text pieces replaced.

    • repl

      public static void repl(StringBuffer str, String code, String repl)
      Alternate faster version of string replace using a stringbuffer as input. 33% Faster using replaceAll this way than original method
      Parameters:
      str - The string where we want to replace in
      code - The code to search for
      repl - The replacement string for code

    • repl

      public static void repl(StringBuilder str, String code, String repl)
      Alternate faster version of string replace using a stringbuilder as input (non-synchronized). 33% Faster using replaceAll this way than original method
      Parameters:
      str - The string where we want to replace in
      code - The code to search for
      repl - The replacement string for code

    • nrSpacesBefore

      public static int nrSpacesBefore(String field)
      Count the number of spaces to the left of a text. (leading)
      Parameters:
      field - The text to examine
      Returns:
      The number of leading spaces found.

    • nrSpacesAfter

      public static int nrSpacesAfter(String field)
      Count the number of spaces to the right of a text. (trailing)
      Parameters:
      field - The text to examine
      Returns:
      The number of trailing spaces found.

    • onlySpaces

      public static boolean onlySpaces(String str)
      Checks whether or not a String consists only of spaces.
      Parameters:
      str - The string to check
      Returns:
      true if the string has nothing but spaces.

    • getOS

      public static String getOS()
      determine the OS name
      Returns:
      The name of the OS

    • getQuoteCharByOS

      public static String getQuoteCharByOS()
      Determine the quoting character depending on the OS. Often used for shell calls, gives back " for Windows systems otherwise '
      Returns:
      quoting character

    • optionallyQuoteStringByOS

      public static String optionallyQuoteStringByOS(String string)
      Quote a string depending on the OS. Often used for shell calls.
      Returns:
      quoted string

    • isWindows

      public static boolean isWindows()
      Returns:
      True if the OS is a Windows derivate.

    • isLinux

      public static boolean isLinux()
      Returns:
      True if the OS is a Linux derivate.

    • isOSX

      public static boolean isOSX()
      Returns:
      True if the OS is an OSX derivate.

    • isKDE

      public static boolean isKDE()
      Returns:
      True if KDE is in use.

    • getHostname

      public static String getHostname()
      Determine the hostname of the machine Kettle is running on
      Returns:
      The hostname

    • getHostnameReal

      public static String getHostnameReal()
      Determine the hostname of the machine Kettle is running on
      Returns:
      The hostname

    • getIPAddress

      public static String getIPAddress() throws Exception
      Determins the IP address of the machine Kettle is running on.
      Returns:
      The IP address
      Throws:
      Exception

    • getIPAddress

      public static String getIPAddress(String networkInterfaceName) throws SocketException
      Get the primary IP address tied to a network interface (excluding loop-back etc)
      Parameters:
      networkInterfaceName - the name of the network interface to interrogate
      Returns:
      null if the network interface or address wasn't found.
      Throws:
      SocketException - in case of a security or network error

    • getMACAddress

      public static String getMACAddress() throws Exception
      Tries to determine the MAC address of the machine Kettle is running on.
      Returns:
      The MAC address.
      Throws:
      Exception

    • isRunningOnWebspoonMode

      public static boolean isRunningOnWebspoonMode()
      Determines if the RUNNING_ON_WEBSPOON_MODE flag is set and returns its boolean value. This is per user-basis.
      Returns:
      Boolean signalig the use of Webspoon mode.

    • getUserHomeDirectory

      public static String getUserHomeDirectory()
      Looks up the user's home directory (or KETTLE_HOME) for every invocation. This is no longer a static property so the value may be set after this class is loaded.
      Returns:
      The path to the users home directory, or the System property KETTLE_HOME if set.

    • getKettleDirectory

      public static String getKettleDirectory()
      Determines the Kettle absolute directory in the user's home directory.
      Returns:
      The Kettle absolute directory.

    • getUserDataDirectory

      public static String getUserDataDirectory()
      Determines the Kettle user data directory in the user's home directory. This is per user-basis.
      Returns:
      The Kettle user data directory.

    • getUserBaseDir

      public static String getUserBaseDir()
      Determines the Kettle directory in the user's home directory.
      Returns:
      The Kettle directory.

    • getDIHomeDirectory

      public static String getDIHomeDirectory()
      Returns the value of DI_HOME.

    • getSharedObjectsFile

      public static String getSharedObjectsFile()
      Determines the location of the shared objects file
      Returns:
      the name of the shared objects file

    • getKettleLocalRepositoriesFile

      public static String getKettleLocalRepositoriesFile()
      Returns the path to the Kettle local (current directory) repositories XML file.
      Returns:
      The local repositories file.

    • getKettleUserRepositoriesFile

      public static String getKettleUserRepositoriesFile()
      Returns the full path to the Kettle repositories XML file.
      Returns:
      The Kettle repositories file.

    • getKettlePropertiesFilename

      public static String getKettlePropertiesFilename()
      Returns the full path to the Kettle properties XML file.
      Returns:
      The Kettle properties file.

    • getKettleLocalCartePasswordFile

      public static String getKettleLocalCartePasswordFile()
      Returns the path to the Kettle local (current directory) Carte password file:

      ./pwd/kettle.pwd

      Returns:
      The local Carte password file.

    • getKettleCartePasswordFile

      public static String getKettleCartePasswordFile()
      Returns the path to the Kettle Carte password file in the home directory:

      $KETTLE_HOME/.kettle/kettle.pwd

      Returns:
      The Carte password file in the home directory.

    • getBaseDocUrl

      public static String getBaseDocUrl()
      Provides the base documentation url (top-level help)
      Returns:
      the fully qualified base documentation URL

    • getBaseWikiDocUrl

      public static String getBaseWikiDocUrl()
      Provides the base wiki documentation url (top-level pentaho-community)
      Returns:
      the fully qualified base wiki documentation URL

    • getDocUrl

      public static String getDocUrl(String uri)
      Provides the documentation url with the configured base + the given URI.
      Parameters:
      uri - the resource identifier for the documentation (eg. Products/Data_Integration/Data_Integration_Perspective/050/000)
      Returns:
      the fully qualified documentation URL for the given URI

    • getEnvironmentVariable

      public static String getEnvironmentVariable(String variable, String deflt)
      Retrieves the content of an environment variable
      Parameters:
      variable - The name of the environment variable
      deflt - The default value in case no value was found
      Returns:
      The value of the environment variable or the value of deflt in case no variable was defined.

    • replEnv

      @Deprecated public static String replEnv(String string)
      Deprecated.
      use StringUtil.environmentSubstitute(): handles both Windows and unix conventions
      Replaces environment variables in a string. For example if you set KETTLE_HOME as an environment variable, you can use %%KETTLE_HOME%% in dialogs etc. to refer to this value. This procedures looks for %%...%% pairs and replaces them including the name of the environment variable with the actual value. In case the variable was not set, nothing is replaced!
      Parameters:
      string - The source string where text is going to be replaced.
      Returns:
      The expanded string.

    • replEnv

      @Deprecated public static String[] replEnv(String[] string)
      Deprecated.
      please use StringUtil.environmentSubstitute now.
      Replaces environment variables in an array of strings.

      See also: replEnv(String string)

      Parameters:
      string - The array of strings that wants its variables to be replaced.
      Returns:
      the array with the environment variables replaced.

    • NVL

      public static String NVL(String source, String def)
      Implements Oracle style NVL function
      Parameters:
      source - The source argument
      def - The default value in case source is null or the length of the string is 0
      Returns:
      source if source is not null, otherwise return def

    • NVL

      public static <T> T NVL(T source, T def)
      Implements Oracle style NVL function for generic arguments
      Parameters:
      source - The source argument
      def - The default value in case source is null
      Returns:
      source if source is not null, otherwise return def

    • nullToEmpty

      public static String nullToEmpty(String source)
      Return empty string "" in case the given parameter is null, otherwise return the same value.
      Parameters:
      source - The source value to check for null.
      Returns:
      empty string if source is null, otherwise simply return the source value.

    • indexOfString

      public static int indexOfString(String lookup, String[] array)
      Search for a string in an array of strings and return the index.
      Parameters:
      lookup - The string to search for
      array - The array of strings to look in
      Returns:
      The index of a search string in an array of strings. -1 if not found.

    • indexsOfStrings

      public static int[] indexsOfStrings(String[] lookup, String[] array)
      Search for strings in an array of strings and return the indexes.
      Parameters:
      lookup - The strings to search for
      array - The array of strings to look in
      Returns:
      The indexes of strings in an array of strings. -1 if not found.

    • indexsOfFoundStrings

      public static int[] indexsOfFoundStrings(String[] lookup, String[] array)
      Search for strings in an array of strings and return the indexes. If a string is not found, the index is not returned.
      Parameters:
      lookup - The strings to search for
      array - The array of strings to look in
      Returns:
      The indexes of strings in an array of strings. Only existing indexes are returned (no -1)

    • indexOfString

      public static int indexOfString(String lookup, List<String> list)
      Search for a string in a list of strings and return the index.
      Parameters:
      lookup - The string to search for
      list - The ArrayList of strings to look in
      Returns:
      The index of a search string in an array of strings. -1 if not found.

    • sortStrings

      public static String[] sortStrings(String[] input)
      Sort the strings of an array in alphabetical order.
      Parameters:
      input - The array of strings to sort.
      Returns:
      The sorted array of strings.

    • splitString

      public static String[] splitString(String string, String separator)
      Convert strings separated by a string into an array of strings.

      Example: a;b;c;d ==> new String[] { a, b, c, d }

      NOTE: this differs from String.split() in a way that the built-in method uses regular expressions and this one does not.

      Parameters:
      string - The string to split
      separator - The separator used.
      Returns:
      the string split into an array of strings

    • splitString

      public static String[] splitString(String string, char separator)
      Convert strings separated by a character into an array of strings.

      Example: a;b;c;d == new String[] { a, b, c, d }

      Parameters:
      string - The string to split
      separator - The separator used.
      Returns:
      the string split into an array of strings

    • splitString

      public static String[] splitString(String string, char separator, boolean escape)
      Convert strings separated by a character into an array of strings.

      Example: a;b;c;d == new String[] { a, b, c, d }

      Parameters:
      string - The string to split
      separator - The separator used.
      escape - in case the separator can be escaped (\;) The escape characters are NOT removed!
      Returns:
      the string split into an array of strings

    • splitPath

      public static String[] splitPath(String path, String separator)
      Convert strings separated by a string into an array of strings.

      Example /a/b/c --> new String[] { a, b, c }

      Parameters:
      path - The string to split
      separator - The separator used.
      Returns:
      the string split into an array of strings

    • splitString

      public static String[] splitString(String stringToSplit, String delimiter, String enclosure)
      Split the given string using the given delimiter and enclosure strings. The delimiter and enclosures are not regular expressions (regexes); rather they are literal strings that will be quoted so as not to be treated like regexes. This method expects that the data contains an even number of enclosure strings in the input; otherwise the results are undefined
      Parameters:
      stringToSplit - the String to split
      delimiter - the delimiter string
      enclosure - the enclosure string
      Returns:
      an array of strings split on the delimiter (ignoring those in enclosures), or null if the string to split is null.

    • splitString

      public static String[] splitString(String stringToSplit, String delimiter, String enclosure, boolean removeEnclosure)
      Split the given string using the given delimiter and enclosure strings. The delimiter and enclosures are not regular expressions (regexes); rather they are literal strings that will be quoted so as not to be treated like regexes. This method expects that the data contains an even number of enclosure strings in the input; otherwise the results are undefined
      Parameters:
      stringToSplit - the String to split
      delimiter - the delimiter string
      enclosure - the enclosure string
      removeEnclosure - removes enclosure from split result
      Returns:
      an array of strings split on the delimiter (ignoring those in enclosures), or null if the string to split is null.

    • getDistinctStrings

      public static String[] getDistinctStrings(String[] strings)
      Sorts the array of Strings, determines the uniquely occurring strings.
      Parameters:
      strings - the array that you want to do a distinct on
      Returns:
      a sorted array of uniquely occurring strings

    • getStackTracker

      public static String getStackTracker(Throwable e)
      Returns a string of the stack trace of the specified exception

    • getClassicStackTrace

      public static String getClassicStackTrace(Throwable e)

    • getCustomStackTrace

      public static String getCustomStackTrace(Throwable aThrowable)

    • isEmpty

      @Deprecated public static boolean isEmpty(String val)
      Deprecated.
      Check if the string supplied is empty. A String is empty when it is null or when the length is 0
      Parameters:
      val - The value to check
      Returns:
      true if the string supplied is empty
      See Also:

    • isEmpty

      @Deprecated public static boolean isEmpty(StringBuffer val)
      Deprecated.
      Check if the stringBuffer supplied is empty. A StringBuffer is empty when it is null or when the length is 0
      Parameters:
      val - The stringBuffer to check
      Returns:
      true if the stringBuffer supplied is empty
      See Also:

    • isEmpty

      @Deprecated public static boolean isEmpty(String[] vals)
      Deprecated.
      Check if the string array supplied is empty. A String array is empty when it is null or when the number of elements is 0
      Parameters:
      vals - The string array to check
      Returns:
      true if the string array supplied is empty
      See Also:

    • isEmpty

      @Deprecated public static boolean isEmpty(CharSequence val)
      Deprecated.
      Check if the CharSequence supplied is empty. A CharSequence is empty when it is null or when the length is 0
      Parameters:
      val - The stringBuffer to check
      Returns:
      true if the stringBuffer supplied is empty
      See Also:

    • isEmpty

      @Deprecated public static boolean isEmpty(CharSequence[] vals)
      Deprecated.
      Check if the CharSequence array supplied is empty. A CharSequence array is empty when it is null or when the number of elements is 0
      Parameters:
      vals - The string array to check
      Returns:
      true if the string array supplied is empty
      See Also:

    • isEmpty

      @Deprecated public static boolean isEmpty(Object[] array)
      Deprecated.
      Check if the array supplied is empty. An array is empty when it is null or when the length is 0
      Parameters:
      array - The array to check
      Returns:
      true if the array supplied is empty
      See Also:

    • isEmpty

      @Deprecated public static boolean isEmpty(List<?> list)
      Deprecated.
      Check if the list supplied is empty. An array is empty when it is null or when the length is 0
      Parameters:
      list - the list to check
      Returns:
      true if the supplied list is empty
      See Also:

    • createNewClassLoader

      public static ClassLoader createNewClassLoader() throws KettleException
      Returns:
      a new ClassLoader
      Throws:
      KettleException

    • createByteArray

      public static byte[] createByteArray(int size)
      Utility class for use in JavaScript to create a new byte array. This is surprisingly difficult to do in JavaScript.
      Returns:
      a new java byte array

    • initCap

      public static String initCap(String string)
      Sets the first character of each word in upper-case.
      Parameters:
      string - The strings to convert to initcap
      Returns:
      the input string but with the first character of each word converted to upper-case.

    • createFilename

      public static String createFilename(String name)
      Create a valid filename using a name We remove all special characters, spaces, etc.
      Parameters:
      name - The name to use as a base for the filename
      Returns:
      a valid filename

    • createFilename

      public static String createFilename(String directory, String name, String extension)

    • createName

      public static String createName(String filename)

    • filenameOnly

      public static String filenameOnly(String sFullPath)

      Returns the pure filename of a filename with full path. E.g. if passed parameter is /opt/tomcat/logs/catalina.out this method returns catalina.out. The method works with the Environment variable System.getProperty("file.separator"), so on linux/Unix it will check for the last occurrence of a frontslash, on windows for the last occurrence of a backslash.

      To make this OS independent, the method could check for the last occurrence of a frontslash and backslash and use the higher value of both. Should work, since these characters aren't allowed in filenames on neither OS types (or said differently: Neither linux nor windows can carry frontslashes OR backslashes in filenames). Just a suggestion of an improvement ...

      Parameters:
      sFullPath -
      Returns:

    • getDateFormats

      public static String[] getDateFormats()
      Returning the localized date conversion formats. They get created once on first request.
      Returns:

    • getTimelessDateFormats

      public static String[] getTimelessDateFormats()
      Returning the localized date conversion formats without time. They get created once on first request.
      Returns:

    • getNumberFormats

      public static String[] getNumberFormats()
      Returning the localized number conversion formats. They get created once on first request.
      Returns:

    • getConversionFormats

      public static String[] getConversionFormats()
      Returns:
      An array of all default conversion formats, to be used in dialogs etc.

    • getTransformationAndJobFilterNames

      public static String[] getTransformationAndJobFilterNames()

    • getTransformationFilterNames

      public static String[] getTransformationFilterNames()

    • getJobFilterNames

      public static String[] getJobFilterNames()

    • nanoTime

      public static long nanoTime()
      Return the current time as nano-seconds.
      Returns:
      time as nano-seconds.

    • trimToType

      public static String trimToType(String string, int trimType)
      Return the input string trimmed as specified.
      Parameters:
      string - String to be trimmed
      trimType - Type of trimming
      Returns:
      Trimmed string.

    • trimDate

      public static Date trimDate(Date date)
      Trims a Date by resetting the time part to zero
      Parameters:
      date - a Date object to trim (reset time to zero)
      Returns:
      a Date object with time part reset to zero

    • safeAppendDirectory

      public static String safeAppendDirectory(String dir, String file)
      implemented to help prevent errors in matching up pluggable LAF directories and paths/files eliminating malformed URLs - duplicate file separators or missing file separators.
      Parameters:
      dir -
      file -
      Returns:
      concatenated string representing a file url

    • getEmptyPaddedStrings

      public static String[] getEmptyPaddedStrings()
      Create an array of Strings consisting of spaces. The index of a String in the array determines the number of spaces in that string.
      Returns:
      array of 'space' Strings.

    • getPercentageFreeMemory

      public static int getPercentageFreeMemory()
      Return the percentage of free memory for this JVM.
      Returns:
      Percentage of free memory.

    • removeDigits

      public static String removeDigits(String input)
      Return non digits only.
      Returns:
      non digits in a string.

    • getDigitsOnly

      public static String getDigitsOnly(String input)
      Return digits only.
      Returns:
      digits in a string.

    • removeTimeFromDate

      public static Date removeTimeFromDate(Date input)
      Remove time from a date.
      Returns:
      a date without hour.

    • escapeXML

      public static String escapeXML(String content)
      Escape XML content. i.e. replace characters with &values;
      Parameters:
      content - content
      Returns:
      escaped content

    • escapeHtml

      public static String escapeHtml(String content)
      Escape HTML content. i.e. replace characters with &values;
      Parameters:
      content - content
      Returns:
      escaped content

    • unEscapeHtml

      public static String unEscapeHtml(String content)
      UnEscape HTML content. i.e. replace characters with &values;
      Parameters:
      content - content
      Returns:
      unescaped content

    • unEscapeXml

      public static String unEscapeXml(String content)
      UnEscape XML content. i.e. replace characters with &values;
      Parameters:
      content - content
      Returns:
      unescaped content

    • escapeSQL

      public static String escapeSQL(String content)
      Escape SQL content. i.e. replace characters with &values;
      Parameters:
      content - content
      Returns:
      escaped content

    • removeCRLF

      public static String removeCRLF(String in)
      Remove CR / LF from String - Better performance version - Doesn't NPE - 40 times faster on an empty string - 2 times faster on a mixed string - 25% faster on 2 char string with only CRLF in it
      Parameters:
      in - input
      Returns:
      cleaned string

    • removeChar

      public static String removeChar(String in, char badChar)
      Remove Character from String - Better performance version - Doesn't NPE - 40 times faster on an empty string - 2 times faster on a mixed string - 25% faster on 2 char string with only CR/LF/TAB in it
      Parameters:
      in - input
      Returns:
      cleaned string

    • removeCR

      public static String removeCR(String in)
      Remove CR / LF from String
      Parameters:
      in - input
      Returns:
      cleaned string

    • removeLF

      public static String removeLF(String in)
      Remove CR / LF from String
      Parameters:
      in - input
      Returns:
      cleaned string

    • removeTAB

      public static String removeTAB(String in)
      Remove horizontal tab from string
      Parameters:
      in - input
      Returns:
      cleaned string

    • addTimeToDate

      public static Date addTimeToDate(Date input, String time, String dateFormat) throws Exception
      Add time to an input date
      Parameters:
      input - the date
      time - the time to add (in string)
      dateFormat - the time format
      Returns:
      date = input + time
      Throws:
      Exception

    • decodeTime

      public static int decodeTime(String s, String dateFormat) throws Exception
      Throws:
      Exception

    • getOccurenceString

      public static int getOccurenceString(String string, String searchFor)
      Get the number of occurrences of searchFor in string.
      Parameters:
      string - String to be searched
      searchFor - to be counted string
      Returns:
      number of occurrences

    • GetAvailableFontNames

      public static String[] GetAvailableFontNames()

    • getKettlePropertiesFileHeader

      public static String getKettlePropertiesFileHeader()

    • protectXMLCDATA

      public static String protectXMLCDATA(String content)
      Mask XML content. i.e. protect with CDATA;
      Parameters:
      content - content
      Returns:
      protected content

    • getOcuranceString

      public static int getOcuranceString(String string, String searchFor)
      Get the number of occurrences of searchFor in string.
      Parameters:
      string - String to be searched
      searchFor - to be counted string
      Returns:
      number of occurrences

    • escapeXml

      public static String escapeXml(String content)
      Mask XML content. i.e. replace characters with &values;
      Parameters:
      content - content
      Returns:
      masked content

    • optionallyDecodeUriString

      public static String optionallyDecodeUriString(String uri)
      Convert a string containing a URI with escaped special characters and return the decoded version depending on system property settings.
      Parameters:
      uri -
      Returns:
      decoded URI string

    • Lpad

      public static String Lpad(String valueToPad, String filler, int size)
      New method avoids string concatenation is between 20% and > 2000% faster depending on length of the string to pad, and the size to pad it to. For larger amounts to pad, (e.g. pad a 4 character string out to 20 places) this is orders of magnitude faster.
      Parameters:
      valueToPad - the string to pad
      filler - the pad string to fill with
      size - the size to pad to
      Returns:
      the new string, padded to the left Note - The original method was flawed in a few cases: 1- The filler could be a string of any length - and the returned string was not necessarily limited to size. So a 3 character pad of an 11 character string could end up being 17 characters long. 2- For a pad of zero characters ("") the former method would enter an infinite loop. 3- For a null pad, it would throw an NPE 4- For a null valueToPad, it would throw an NPE

    • Rpad

      public static String Rpad(String valueToPad, String filler, int size)
      New method avoids string concatenation is between 50% and > 2000% faster depending on length of the string to pad, and the size to pad it to. For larger amounts to pad, (e.g. pad a 4 character string out to 20 places) this is orders of magnitude faster.
      Parameters:
      valueToPad - the string to pad
      filler - the pad string to fill with
      size - the size to pad to
      Returns:
      The string, padded to the right 1- The filler can still be a string of any length - and the returned string was not necessarily limited to size. So a 3 character pad of an 11 character string with a size of 15 could end up being 17 characters long (instead of the "asked for 15"). 2- For a pad of zero characters ("") the former method would enter an infinite loop. 3- For a null pad, it would throw an NPE 4- For a null valueToPad, it would throw an NPE

    • classIsOrExtends

      public static boolean classIsOrExtends(Class<?> clazz, Class<?> superClass)

    • getDeprecatedPrefix

      public static String getDeprecatedPrefix()