MuleRuntimeFeature (Mule API 1.4.0-20240923 API)

java.lang.Object
- java.lang.Enum<MuleRuntimeFeature>
- - org.mule.runtime.api.config.MuleRuntimeFeature

All Implemented Interfaces:: Serializable, Comparable<MuleRuntimeFeature>, Feature

public enum MuleRuntimeFeature
extends Enum<MuleRuntimeFeature>
implements Feature

List of Features that can be configured to be enabled or disabled per application depending on the deployment context.

When some Mule runtime feature needs to be flagged, it should be added here as a new enum constant. Each entry must have a meaningful name, clear enough to understand what it represents, a description with enough information to know how the runtime will work whether the feature is enabled or disabled, the issue that motivated this feature, and a list of Runtime versions from when it exists. Each enum constant has to have its Javadoc with further information about how the feature is configured.

For example:

    public enum MuleRuntimeFeature implements Feature {
      ...

      /**
       * An application shouldn't override reserved properties, but it was possible until MULE-17659. This behaviour has
       * to be fixed by default to any application developed for 4.3.0+ Runtime but can be overridden by setting
       * {@link MuleSystemProperties#HONOUR_RESERVED_PROPERTIES_PROPERTY} System Property.
       *
       * @since 4.4.0, 4.3.1
       *
       */
      HONOUR_RESERVED_PROPERTIES("Whether reserved properties such as 'app.name' can't be overridden by global properties.",
            "MULE-19083", "4.4.0, 4.3.1", HONOUR_RESERVED_PROPERTIES_PROPERTY),

      ...

    }

Since:: 4.4.0 4.3.1

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BATCH_FIXED_AGGREGATOR_TRANSACTION_RECORD_BUFFER` If set to true, then fixed batch aggregator will only commit when a full block is processed.
`COMPUTE_CONNECTION_ERRORS_IN_STATS` If set to true, the connection errors will be taken into account to trigger alerts.
`CREATE_CHILD_POLICY_CONTEXT_FOR_PARALLEL_SCOPES` "When enabled, a new (Source) Policy Context is created for the execution of parallel scopes: ParallelForeach, ScatterGather and Async"
`DEFAULT_ERROR_HANDLER_NOT_ROLLBACK_IF_NOT_CORRESPONDING` When enabled, the default error handler added by the runtime will not rollback a transaction that should not be rollback by it
`DISABLE_SCHEDULER_LOGGING` When enabled, the Scheduler does not log exceptions.
`DW_REMOVE_SHADOWED_IMPLICIT_INPUTS` When enabled, DataWeave will remove implicit inputs when a variable with the same name is declared at the root level.
`ENABLE_BYTE_BUDDY_OBJECT_CREATION` When enabled, the Objects factories will be created with Byte Buddy instead of CGLIB.
`ENABLE_POLICY_ISOLATION` If set to true, extensions imported by a policy will be managed in complete isolation from the extensions imported by the application that is being applied to, and validations will prevent the usage of explicit configurations declared by the application as part of the policy initialization."
`ENABLE_PROFILING_SERVICE` If set to true, profiling events will be produced.
`ENABLE_XML_SDK_MDC_RESET` When enabled, the MDC context will reset after XML SDK Operation has been executed.
`ENTITY_RESOLVER_FAIL_ON_FIRST_ERROR` If set to true, the Mule XML DSL parser will fail when deploying an application that declares a schema that cannot be located.
`ERROR_AND_ROLLBACK_TX_WHEN_TIMEOUT` When enabled, when a (local or xa) transaction reached timeout, an error will be thrown that can be handled using error handling.
`FORCE_RUNTIME_PROFILING_CONSUMERS_ENABLEMENT`
`HANDLE_SPLITTER_EXCEPTION` If set to true, then DW will correctly handle Splitter's exceptions, avoiding some serialization issues.
`HONOUR_ERROR_MAPPINGS_WHEN_POLICY_APPLIED_ON_OPERATION` When set to true, the operation policy's error resolution is ignored so that the error mappings of the processor on which the policy was applied are set successfully
`HONOUR_INSECURE_TLS_CONFIGURATION` When enabled, the insecure attribute of the trust-store element will be honoured even when other attributes are configured.
`HONOUR_PERSISTED_FLOW_STATE` When enabled, flows will honour the state configured in flows.deployment.properties when restarting the app, regardless of the initial state.
`HONOUR_RESERVED_PROPERTIES` An application shouldn't override reserved properties, but it was possible until MULE-17659.
`MULE_PRINT_DETAILED_COMPOSITE_EXCEPTION_LOG` When enabled, AbstractForkJoinRouter based processors, such as ParallelForEach and ScatterGather routers, will show detailed error information for their failed routes.
`PARALLEL_FOREACH_FLATTEN_MESSAGE` When enabled, if the items to iterate over on a parallel-foreach scope are messages (such as the output of an operation that returns Result objects), they will be flattened in a way that is consistent with what the foreach scope does.
`RETHROW_EXCEPTIONS_IN_IDEMPOTENT_MESSAGE_VALIDATOR` When enabled, internal exceptions when processing an event in the 'idempotent-message-validator' will be rethrown instead of raising a general MULE:DUPLICATE_MESSAGE.
`SET_VARIABLE_WITH_NULL_VALUE`
`START_EXTENSION_COMPONENTS_WITH_ARTIFACT_CLASSLOADER` If set to true, extensions will only be able to load exported resources from the deployable artifacts (application, policy, domain).
`SUPPORT_NATIVE_LIBRARY_DEPENDENCIES` When enabled, and the application needs to load a native library, the rest of the native libraries are preloaded in the application's Classloader.
`SUPPRESS_ERRORS` When enabled, error suppression will happen.
`TO_STRING_TRANSFORMER_TRANSFORM_ITERATOR_ELEMENTS` If set to true, managed iterators transformed to Strings will show the representation of the elements instead of the generic 'org.mule.runtime.core.internal.streaming.object.ManagedCursorIteratorProvider$ManagedCursorIterator@######'.
`USE_TRANSACTION_SINK_INDEX` When enabled, flux sinks will be cached using index as part of the key.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDescription()` Brief description of the feature.
`String`	`getIssueId()` The issue that caused this feature was added.
`Optional<String>`	`getOverridingSystemPropertyName()` System Property name to be used to decide whether the feature has to be enabled or disabled for the whole Runtime instance without considering any other condition related to the deployment context.
`String`	`getSince()` A comma-separated list of versions since this feature exists.
`static MuleRuntimeFeature`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static MuleRuntimeFeature[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - HONOUR_RESERVED_PROPERTIES
```
public static final MuleRuntimeFeature HONOUR_RESERVED_PROPERTIES
```
    An application shouldn't override reserved properties, but it was possible until MULE-17659. This behaviour has to be fixed by default to any application developed for 4.3.0+ Runtime but can be overridden by setting MuleSystemProperties.HONOUR_RESERVED_PROPERTIES_PROPERTY System Property.
    
    Since:
    
    4.4.0, 4.3.1
  - HANDLE_SPLITTER_EXCEPTION
```
public static final MuleRuntimeFeature HANDLE_SPLITTER_EXCEPTION
```
    If set to true, then DW will correctly handle Splitter's exceptions, avoiding some serialization issues. Be aware that when enabled, this can make error.cause return a different exception. For more information see DW-383.
    
    Since:
    
    4.4.0, 4.3.1, 4.2.3
  - BATCH_FIXED_AGGREGATOR_TRANSACTION_RECORD_BUFFER
```
public static final MuleRuntimeFeature BATCH_FIXED_AGGREGATOR_TRANSACTION_RECORD_BUFFER
```
    If set to true, then fixed batch aggregator will only commit when a full block is processed. For more information see EE-7443
    
    Since:
    
    4.4.0, 4.3.1, 4.2.3
  - COMPUTE_CONNECTION_ERRORS_IN_STATS
```
public static final MuleRuntimeFeature COMPUTE_CONNECTION_ERRORS_IN_STATS
```
    If set to true, the connection errors will be taken into account to trigger alerts.
    
    Since:
    
    4.4.0, 4.3.1
  - TO_STRING_TRANSFORMER_TRANSFORM_ITERATOR_ELEMENTS
```
public static final MuleRuntimeFeature TO_STRING_TRANSFORMER_TRANSFORM_ITERATOR_ELEMENTS
```
    If set to true, managed iterators transformed to Strings will show the representation of the elements instead of the generic 'org.mule.runtime.core.internal.streaming.object.ManagedCursorIteratorProvider$ManagedCursorIterator@######'.
    
    Since:
    
    4.4.0
  - ENABLE_POLICY_ISOLATION
```
public static final MuleRuntimeFeature ENABLE_POLICY_ISOLATION
```
    If set to true, extensions imported by a policy will be managed in complete isolation from the extensions imported by the application that is being applied to, and validations will prevent the usage of explicit configurations declared by the application as part of the policy initialization."
    
    Since:
    
    4.4.0, 4.3.1
  - ENTITY_RESOLVER_FAIL_ON_FIRST_ERROR
```
public static final MuleRuntimeFeature ENTITY_RESOLVER_FAIL_ON_FIRST_ERROR
```
    If set to true, the Mule XML DSL parser will fail when deploying an application that declares a schema that cannot be located. If set to false, it will only fail if such application makes use of the namespace that such schema defines, instead of just declaring it.
    
    Since:
    
    4.4.0
  - ENABLE_PROFILING_SERVICE
```
public static final MuleRuntimeFeature ENABLE_PROFILING_SERVICE
```
    If set to true, profiling events will be produced.
    
    Since:
    
    4.4.0
  - SET_VARIABLE_WITH_NULL_VALUE
```
public static final MuleRuntimeFeature SET_VARIABLE_WITH_NULL_VALUE
```
  - START_EXTENSION_COMPONENTS_WITH_ARTIFACT_CLASSLOADER
```
public static final MuleRuntimeFeature START_EXTENSION_COMPONENTS_WITH_ARTIFACT_CLASSLOADER
```
    If set to true, extensions will only be able to load exported resources from the deployable artifacts (application, policy, domain).
    
    Since:
    
    4.4.0
  - DW_REMOVE_SHADOWED_IMPLICIT_INPUTS
```
public static final MuleRuntimeFeature DW_REMOVE_SHADOWED_IMPLICIT_INPUTS
```
    When enabled, DataWeave will remove implicit inputs when a variable with the same name is declared at the root level.
    
    Since:
    
    4.4.0-202111
  - DEFAULT_ERROR_HANDLER_NOT_ROLLBACK_IF_NOT_CORRESPONDING
```
public static final MuleRuntimeFeature DEFAULT_ERROR_HANDLER_NOT_ROLLBACK_IF_NOT_CORRESPONDING
```
    When enabled, the default error handler added by the runtime will not rollback a transaction that should not be rollback by it
    
    Since:
    
    4.4.0-202201
  - FORCE_RUNTIME_PROFILING_CONSUMERS_ENABLEMENT
```
public static final MuleRuntimeFeature FORCE_RUNTIME_PROFILING_CONSUMERS_ENABLEMENT
```
  - PARALLEL_FOREACH_FLATTEN_MESSAGE
```
public static final MuleRuntimeFeature PARALLEL_FOREACH_FLATTEN_MESSAGE
```
    When enabled, if the items to iterate over on a parallel-foreach scope are messages (such as the output of an operation that returns Result objects), they will be flattened in a way that is consistent with what the foreach scope does.
    
    Since:
    
    4.3.0-202203
  - ENABLE_BYTE_BUDDY_OBJECT_CREATION
```
public static final MuleRuntimeFeature ENABLE_BYTE_BUDDY_OBJECT_CREATION
```
    When enabled, the Objects factories will be created with Byte Buddy instead of CGLIB.
    
    Since:
    
    4.5.0, 4.4.0-202204, 4.3.0-202204
  - MULE_PRINT_DETAILED_COMPOSITE_EXCEPTION_LOG
```
public static final MuleRuntimeFeature MULE_PRINT_DETAILED_COMPOSITE_EXCEPTION_LOG
```
    When enabled, AbstractForkJoinRouter based processors, such as ParallelForEach and ScatterGather routers, will show detailed error information for their failed routes.
    
    Since:
    
    4.5.0, 4.4.0-202207
  - HONOUR_ERROR_MAPPINGS_WHEN_POLICY_APPLIED_ON_OPERATION
```
public static final MuleRuntimeFeature HONOUR_ERROR_MAPPINGS_WHEN_POLICY_APPLIED_ON_OPERATION
```
    When set to true, the operation policy's error resolution is ignored so that the error mappings of the processor on which the policy was applied are set successfully
    
    Since:
    
    4.5.0, 4.4.0-202207, 4.3.0-202207
  - SUPPRESS_ERRORS
```
public static final MuleRuntimeFeature SUPPRESS_ERRORS
```
    When enabled, error suppression will happen. This will affect, for instance, the Web Service Consumer connector and the Until Successful scope that will always report errors from their corresponding namespaces (MULE and WSC). Suppressed errors will be treated as underlying causes.
    
    Since:
    
    4.5.0, 4.4.0-202210, 4.3.0-202210
  - RETHROW_EXCEPTIONS_IN_IDEMPOTENT_MESSAGE_VALIDATOR
```
public static final MuleRuntimeFeature RETHROW_EXCEPTIONS_IN_IDEMPOTENT_MESSAGE_VALIDATOR
```
    When enabled, internal exceptions when processing an event in the 'idempotent-message-validator' will be rethrown instead of raising a general MULE:DUPLICATE_MESSAGE.
    
    Since:
    
    4.5.0
  - HONOUR_INSECURE_TLS_CONFIGURATION
```
public static final MuleRuntimeFeature HONOUR_INSECURE_TLS_CONFIGURATION
```
    When enabled, the insecure attribute of the trust-store element will be honoured even when other attributes are configured.
    
    Since:
    
    4.5.0
  - USE_TRANSACTION_SINK_INDEX
```
public static final MuleRuntimeFeature USE_TRANSACTION_SINK_INDEX
```
    When enabled, flux sinks will be cached using index as part of the key. If a sink is already in use, new sink will be created to avoid deadlock.
    
    Since:
    
    4.4.0
  - SUPPORT_NATIVE_LIBRARY_DEPENDENCIES
```
public static final MuleRuntimeFeature SUPPORT_NATIVE_LIBRARY_DEPENDENCIES
```
    When enabled, and the application needs to load a native library, the rest of the native libraries are preloaded in the application's Classloader.
    
    Since:
    
    4.5.0, 4.4.0-202305
  - CREATE_CHILD_POLICY_CONTEXT_FOR_PARALLEL_SCOPES
```
public static final MuleRuntimeFeature CREATE_CHILD_POLICY_CONTEXT_FOR_PARALLEL_SCOPES
```
    "When enabled, a new (Source) Policy Context is created for the execution of parallel scopes: ParallelForeach, ScatterGather and Async"
    
    Since:
    
    4.5.0, 4.4.0-202306
  - DISABLE_SCHEDULER_LOGGING
```
public static final MuleRuntimeFeature DISABLE_SCHEDULER_LOGGING
```
    When enabled, the Scheduler does not log exceptions.
    
    Since:
    
    4.6.0
  - ERROR_AND_ROLLBACK_TX_WHEN_TIMEOUT
```
public static final MuleRuntimeFeature ERROR_AND_ROLLBACK_TX_WHEN_TIMEOUT
```
    When enabled, when a (local or xa) transaction reached timeout, an error will be thrown that can be handled using error handling.
    
    Since:
    
    4.6.1
  - ENABLE_XML_SDK_MDC_RESET
```
public static final MuleRuntimeFeature ENABLE_XML_SDK_MDC_RESET
```
    When enabled, the MDC context will reset after XML SDK Operation has been executed.
    
    Since:
    
    4.8.0, 4.7.1, 4.6.4, 4.4.0-202406
  - HONOUR_PERSISTED_FLOW_STATE
```
public static final MuleRuntimeFeature HONOUR_PERSISTED_FLOW_STATE
```
    When enabled, flows will honour the state configured in flows.deployment.properties when restarting the app, regardless of the initial state.
    
    Since:
    
    4.8
- Method Detail
  - values
```
public static MuleRuntimeFeature[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (MuleRuntimeFeature c : MuleRuntimeFeature.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MuleRuntimeFeature valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getDescription
```
public String getDescription()
```
    Description copied from interface: Feature
    
    Brief description of the feature.
    
    Specified by:
    
    getDescription in interface Feature
    
    Returns:
    
    The feature description
  - getIssueId
```
public String getIssueId()
```
    Description copied from interface: Feature
    
    The issue that caused this feature was added. For instance MULE-1234
    
    Specified by:
    
    getIssueId in interface Feature
    
    Returns:
    
    Issue that motivated the feature.
  - getSince
```
public String getSince()
```
    Description copied from interface: Feature
    
    A comma-separated list of versions since this feature exists.
    
    Specified by:
    
    getSince in interface Feature
    
    Returns:
    
    A comma-separated list of versions, ex "4.4.0, 4.3.0"
  - getOverridingSystemPropertyName
```
public Optional<String> getOverridingSystemPropertyName()
```
    Description copied from interface: Feature
    System Property name to be used to decide whether the feature has to be enabled or disabled for the whole Runtime instance without considering any other condition related to the deployment context. The feature will be enabled according to the value provided, by parsing it as a boolean.
    
    For instance if Feature.getOverridingSystemPropertyName():
    1. Is set to a non-null value and there is a System Property defined with this name, then the feature will be enabled or disabled depending on the result of parse the property value.
    2. Is not set or there isn't a System Property defined with a the value assigned to it, then the proper feature flagging criteria will be applied according to how it was configured.
    In other words:
    1. If Feature.getOverridingSystemPropertyName() is set to some.meaningful.name
      
      If the System Property was set (System.getProperty("some.meaningful.name">) is not null), then the feature will be enabled only when Boolean.getBoolean("some.meaningful.name") returns true
      
      If the System Property was not set (System.getProperty("some.meaningful.name">) is null), then the feature flagging configuration will be applied to decide whether the feature is enabled or disabled.
    2. If Feature.getOverridingSystemPropertyName() is not set, then the feature flagging configuration will be applied to decide whether the feature is enabled or disabled.
    Specified by:
    
    getOverridingSystemPropertyName in interface Feature
    
    Returns:
    
    The name of a System Property to configure the feature.

Enum MuleRuntimeFeature

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

HONOUR_RESERVED_PROPERTIES

HANDLE_SPLITTER_EXCEPTION

BATCH_FIXED_AGGREGATOR_TRANSACTION_RECORD_BUFFER

COMPUTE_CONNECTION_ERRORS_IN_STATS

TO_STRING_TRANSFORMER_TRANSFORM_ITERATOR_ELEMENTS

ENABLE_POLICY_ISOLATION

ENTITY_RESOLVER_FAIL_ON_FIRST_ERROR

ENABLE_PROFILING_SERVICE

SET_VARIABLE_WITH_NULL_VALUE

START_EXTENSION_COMPONENTS_WITH_ARTIFACT_CLASSLOADER

DW_REMOVE_SHADOWED_IMPLICIT_INPUTS

DEFAULT_ERROR_HANDLER_NOT_ROLLBACK_IF_NOT_CORRESPONDING

FORCE_RUNTIME_PROFILING_CONSUMERS_ENABLEMENT

PARALLEL_FOREACH_FLATTEN_MESSAGE

ENABLE_BYTE_BUDDY_OBJECT_CREATION

MULE_PRINT_DETAILED_COMPOSITE_EXCEPTION_LOG

HONOUR_ERROR_MAPPINGS_WHEN_POLICY_APPLIED_ON_OPERATION

SUPPRESS_ERRORS

RETHROW_EXCEPTIONS_IN_IDEMPOTENT_MESSAGE_VALIDATOR

HONOUR_INSECURE_TLS_CONFIGURATION

USE_TRANSACTION_SINK_INDEX

SUPPORT_NATIVE_LIBRARY_DEPENDENCIES

CREATE_CHILD_POLICY_CONTEXT_FOR_PARALLEL_SCOPES

DISABLE_SCHEDULER_LOGGING

ERROR_AND_ROLLBACK_TX_WHEN_TIMEOUT

ENABLE_XML_SDK_MDC_RESET

HONOUR_PERSISTED_FLOW_STATE

Method Detail

values

valueOf

getDescription

getIssueId

getSince

getOverridingSystemPropertyName