org.mule.runtime.api.config

Enum MuleRuntimeFeature

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.
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."
HONOUR_RESERVED_PROPERTIES An application shouldn't override reserved properties, but it was possible until MULE-17659.

Method Summary

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

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

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

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
   1. 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
   2. 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.