org.mule.runtime.api.config

Interface Feature

All Known Implementing Classes:

MuleRuntimeFeature

public interface Feature

A feature that can be enabled or disabled according to a certain configuration

Since:

4.4.0 4.3.1

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.

Method Detail

getDescription

String getDescription()

Brief description of the feature.

Returns:

The feature description

getIssueId

String getIssueId()

The issue that caused this feature was added. For instance MULE-1234

Returns:

Issue that motivated the feature.

getSince

String getSince()

A comma-separated list of versions since this feature exists.

Returns:

A comma-separated list of versions, ex "4.4.0, 4.3.0"

getOverridingSystemPropertyName

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. The feature will be enabled according to the value provided, by parsing it as a boolean.

For instance if 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 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 getOverridingSystemPropertyName() is not set, then the feature flagging configuration will be applied to decide whether the feature is enabled or disabled.

Returns:

The name of a System Property to configure the feature.