MuleRuntimeFeature (Mule API 1.5.0-20221117 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 will 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, customer facing name, and must provide values for all the Feature fields.

For example:

    public enum MuleRuntimeFeature implements Feature {
      ...

      /**
       * When enabled, reserved properties such as 'app.name' can't be overridden by global properties (overrides will be ignored).
       *
       * @since 4.4.0, 4.3.0-202102
       *
       */
      HONOUR_RESERVED_PROPERTIES("When enabled, reserved properties such as 'app.name' can't be overridden by global properties (overrides will be ignored).",
            "MULE-19083", "4.4.0, 4.3.1", HONOUR_RESERVED_PROPERTIES_PROPERTY),

      ...

    }

Since:: 4.4.0 4.3.1
See Also:: Feature, FeatureFlaggingService

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BATCH_FIXED_AGGREGATOR_TRANSACTION_RECORD_BUFFER` When enabled, fixed batch aggregators will only commit when a full block is processed.
`COMPUTE_CONNECTION_ERRORS_IN_STATS` When enabled, Connection errors will be computed as part of alerts triggering.
`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_APPLY_OBJECT_PROCESSOR` When enabled, org.mule.runtime.core.privileged.registry.ObjectProcessor implementations will not be applied on objects registered into the `SimpleRegistry`.
`DISABLE_ATTRIBUTE_PARAMETER_WHITESPACE_TRIMMING` When enabled, the Runtime will trim whitespaces from parameter values defined at the attribute level in the dsl.
`DISABLE_POJO_TEXT_CDATA_WHITESPACE_TRIMMING` When enabled, the Runtime will trim whitespaces from CDATA text parameter of pojos in the dsl.
`DISABLE_REGISTRY_BOOTSTRAP_OPTIONAL_ENTRIES` When enabled, `optional` attribute in entries in a `registry-bootstrap.properties` will be ignored.
`DW_HONOUR_MIXED_CONTENT_STRUCTURE` When this property is set to `true`, DataWeave retains a mixed-content structure instead of grouping text with mixed content into a single text field.
`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` When enabled, 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` When enabled, runtime profiling capabilities will become available.
`ENFORCE_ERROR_TYPES_VALIDATION` When enabled, error types validations will be enforced, even for error handlers/components that are not being referenced.
`ENFORCE_EXPRESSION_VALIDATION` When enabled, expression validations will be enforced for all DataWeave expressions.
`ENFORCE_REQUIRED_EXPRESSION_VALIDATION` When enabled, expression validations will be enforced for targetValue, not allowing a literal value.
`ENTITY_RESOLVER_FAIL_ON_FIRST_ERROR` When enabled, the Mule XML DSL parser will fail when deploying an application that declares a schema that cannot be located.
`FORCE_RUNTIME_PROFILING_CONSUMERS_ENABLEMENT` When enabled, profiling consumers implemented by the runtime will be enabled by default.
`HANDLE_SPLITTER_EXCEPTION` When enabled, DataWeave will correctly handle splitter exceptions, avoiding Scala serialization issues.
`HONOUR_ERROR_MAPPINGS_WHEN_POLICY_APPLIED_ON_OPERATION` When enabled, 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_RESERVED_PROPERTIES` When enabled, reserved properties such as 'app.name' can't be overridden by global properties (overrides will be ignored).
`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.
`SET_VARIABLE_WITH_NULL_VALUE` When enabled, the Set Variable component will create a variable even if it's value is null.
`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).
`SUPPRESS_ERRORS` When enabled, error suppression occurs.
`TO_STRING_TRANSFORMER_TRANSFORM_ITERATOR_ELEMENTS` When enabled, managed cursor iterators transformed to Strings will show the representation of the elements instead of the generic 'org.mule.runtime.core.internal.streaming.object.ManagedCursorIteratorProvider$ManagedCursorIterator@######'.
`VALIDATE_APPLICATION_MODEL_WITH_REGION_CLASSLOADER` When enabled, the application model will be validated with the region classloader.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDescription()` Description of the feature.
`String`	`getEnabledByDefaultSince()` A comma-separated list of versions (must include all the different minors) since this feature will be enabled by default.
`String`	`getIssueId()` The issue that caused this feature addition.
`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.
`String`	`getSince()`
`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
```
    When enabled, reserved properties such as 'app.name' can't be overridden by global properties (overrides will be ignored).
    
    Since:
    
    4.4.0, 4.3.0-202102
  - HANDLE_SPLITTER_EXCEPTION
```
public static final MuleRuntimeFeature HANDLE_SPLITTER_EXCEPTION
```
    When enabled, DataWeave will correctly handle splitter exceptions, avoiding Scala serialization issues.
    
    Since:
    
    4.4.0
  - BATCH_FIXED_AGGREGATOR_TRANSACTION_RECORD_BUFFER
```
public static final MuleRuntimeFeature BATCH_FIXED_AGGREGATOR_TRANSACTION_RECORD_BUFFER
```
    When enabled, fixed batch aggregators will only commit when a full block is processed. See EE-7443 for more information.
    
    Since:
    
    4.4.0, 4.3.0-202103, 4.2.2-202103"
  - COMPUTE_CONNECTION_ERRORS_IN_STATS
```
public static final MuleRuntimeFeature COMPUTE_CONNECTION_ERRORS_IN_STATS
```
    When enabled, Connection errors will be computed as part of alerts triggering.
    
    Since:
    
    4.4.0, 4.3.0-202103
  - TO_STRING_TRANSFORMER_TRANSFORM_ITERATOR_ELEMENTS
```
public static final MuleRuntimeFeature TO_STRING_TRANSFORMER_TRANSFORM_ITERATOR_ELEMENTS
```
    When enabled, managed cursor 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
```
    When enabled, 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.0-202107
  - ENTITY_RESOLVER_FAIL_ON_FIRST_ERROR
```
public static final MuleRuntimeFeature ENTITY_RESOLVER_FAIL_ON_FIRST_ERROR
```
    When enabled, the Mule XML DSL parser will fail when deploying an application that declares a schema that cannot be located. Otherwise, it will fail if the application also makes use of the namespace that such schema is bound to.
    
    Since:
    
    4.4.0
  - ENABLE_PROFILING_SERVICE
```
public static final MuleRuntimeFeature ENABLE_PROFILING_SERVICE
```
    When enabled, runtime profiling capabilities will become available.
    
    Since:
    
    4.4.0
  - SET_VARIABLE_WITH_NULL_VALUE
```
public static final MuleRuntimeFeature SET_VARIABLE_WITH_NULL_VALUE
```
    When enabled, the Set Variable component will create a variable even if it's value is null.
    
    Since:
    
    4.4.0, 4.3.0-202106
  - 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, 4.3.0-202110
  - 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.5.0, 4.4.0-202111
  - DW_HONOUR_MIXED_CONTENT_STRUCTURE
```
public static final MuleRuntimeFeature DW_HONOUR_MIXED_CONTENT_STRUCTURE
```
    When this property is set to true, DataWeave retains a mixed-content structure instead of grouping text with mixed content into a single text field.
    
    Since:
    
    4.5.0
  - ENFORCE_ERROR_TYPES_VALIDATION
```
public static final MuleRuntimeFeature ENFORCE_ERROR_TYPES_VALIDATION
```
    When enabled, error types validations will be enforced, even for error handlers/components that are not being referenced.
    
    Since:
    
    4.5.0
  - DISABLE_ATTRIBUTE_PARAMETER_WHITESPACE_TRIMMING
```
public static final MuleRuntimeFeature DISABLE_ATTRIBUTE_PARAMETER_WHITESPACE_TRIMMING
```
    When enabled, the Runtime will trim whitespaces from parameter values defined at the attribute level in the dsl.
    
    Since:
    
    4.5.0
  - DISABLE_POJO_TEXT_CDATA_WHITESPACE_TRIMMING
```
public static final MuleRuntimeFeature DISABLE_POJO_TEXT_CDATA_WHITESPACE_TRIMMING
```
    When enabled, the Runtime will trim whitespaces from CDATA text parameter of pojos in the dsl.
    
    Since:
    
    4.5.0
  - 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.5.0, 4.4.0-202201, 4.3.0-202201
  - ENFORCE_REQUIRED_EXPRESSION_VALIDATION
```
public static final MuleRuntimeFeature ENFORCE_REQUIRED_EXPRESSION_VALIDATION
```
    When enabled, expression validations will be enforced for targetValue, not allowing a literal value.
    
    Since:
    
    4.5.0
  - ENFORCE_EXPRESSION_VALIDATION
```
public static final MuleRuntimeFeature ENFORCE_EXPRESSION_VALIDATION
```
    When enabled, expression validations will be enforced for all DataWeave expressions.
    
    Since:
    
    4.5.0
  - FORCE_RUNTIME_PROFILING_CONSUMERS_ENABLEMENT
```
public static final MuleRuntimeFeature FORCE_RUNTIME_PROFILING_CONSUMERS_ENABLEMENT
```
    When enabled, profiling consumers implemented by the runtime will be enabled by default.
    
    Since:
    
    4.5.0, 4.4.0-202202
  - 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.5.0, 4.4.0-202202, 4.3.0-202202
  - DISABLE_REGISTRY_BOOTSTRAP_OPTIONAL_ENTRIES
```
public static final MuleRuntimeFeature DISABLE_REGISTRY_BOOTSTRAP_OPTIONAL_ENTRIES
```
    When enabled, `optional` attribute in entries in a `registry-bootstrap.properties` will be ignored.
    
    Since:
    
    4.5.0
  - DISABLE_APPLY_OBJECT_PROCESSOR
```
public static final MuleRuntimeFeature DISABLE_APPLY_OBJECT_PROCESSOR
```
    When enabled, org.mule.runtime.core.privileged.registry.ObjectProcessor implementations will not be applied on objects registered into the `SimpleRegistry`.
    
    Since:
    
    4.5.0
  - 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-202203, 4.3.0-202203
  - VALIDATE_APPLICATION_MODEL_WITH_REGION_CLASSLOADER
```
public static final MuleRuntimeFeature VALIDATE_APPLICATION_MODEL_WITH_REGION_CLASSLOADER
```
    When enabled, the application model will be validated with the region classloader. When disabled, it will be validated with the application classloader.
    
    Since:
    
    4.5.0
  - 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-202206
  - HONOUR_ERROR_MAPPINGS_WHEN_POLICY_APPLIED_ON_OPERATION
```
public static final MuleRuntimeFeature HONOUR_ERROR_MAPPINGS_WHEN_POLICY_APPLIED_ON_OPERATION
```
    When enabled, 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 occurs. This feature prevents component such as the Web Service Consumer connector and the Until Successful scope from reporting errors outside their namespaces.
    
    Log extract for a connectivity error at the Web Service Consumer (HTTP:CONNECTIVITY is being suppressed):
```
 Error type : WSC:INVALID_WSDL
 Caused by  : HTTP:CONNECTIVITY
 
```
    Suppressed errors are treated as underlying causes that can also be matched by On Error handlers.
    Since:
    
    4.5.0, 4.4.0-202210
  - 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
- 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
    
    Description of the feature. This description will be part of end user documentation.
    
    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 addition. For instance, MULE-1234.
    
    Specified by:
    
    getIssueId in interface Feature
    
    Returns:
    
    Issue that motivated the feature.
  - getSince
```
public String getSince()
```
    Specified by:
    
    getSince in interface Feature
  - getEnabledByDefaultSince
```
public String getEnabledByDefaultSince()
```
    Description copied from interface: Feature
    
    A comma-separated list of versions (must include all the different minors) since this feature will be enabled by default. Any relevant artifact (application, policy... etc) with a minMuleVersion matching this list will have this Feature enabled by default.
    
    Specified by:
    
    getEnabledByDefaultSince in interface Feature
    
    Returns:
    
    A comma-separated list of versions, ex "4.4.0, 4.3.0-202103".
  - 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. 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, or Optional.empty() if it cannot be configured by system property.

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

DW_HONOUR_MIXED_CONTENT_STRUCTURE

ENFORCE_ERROR_TYPES_VALIDATION

DISABLE_ATTRIBUTE_PARAMETER_WHITESPACE_TRIMMING

DISABLE_POJO_TEXT_CDATA_WHITESPACE_TRIMMING

DEFAULT_ERROR_HANDLER_NOT_ROLLBACK_IF_NOT_CORRESPONDING

ENFORCE_REQUIRED_EXPRESSION_VALIDATION

ENFORCE_EXPRESSION_VALIDATION

FORCE_RUNTIME_PROFILING_CONSUMERS_ENABLEMENT

PARALLEL_FOREACH_FLATTEN_MESSAGE

DISABLE_REGISTRY_BOOTSTRAP_OPTIONAL_ENTRIES

DISABLE_APPLY_OBJECT_PROCESSOR

ENABLE_BYTE_BUDDY_OBJECT_CREATION

VALIDATE_APPLICATION_MODEL_WITH_REGION_CLASSLOADER

MULE_PRINT_DETAILED_COMPOSITE_EXCEPTION_LOG

HONOUR_ERROR_MAPPINGS_WHEN_POLICY_APPLIED_ON_OPERATION

SUPPRESS_ERRORS

HONOUR_INSECURE_TLS_CONFIGURATION

Method Detail

values

valueOf

getDescription

getIssueId

getSince

getEnabledByDefaultSince

getOverridingSystemPropertyName