com.mulesoft.mule.runtime.gw.api.config

Interface Feature

All Known Implementing Classes:

ApiGatewayFeature

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() 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.

Method Detail

getDescription

String getDescription()

Description of the feature. This description will be part of end user documentation.

Returns:

The feature description.

getIssueId

String getIssueId()

The issue that caused this feature addition. For instance, MULE-1234.

Returns:

Issue that motivated the feature.

getEnabledByDefaultSince

String getEnabledByDefaultSince()

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.

Returns:

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

Since:

4.4.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. 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, or Optional.empty() if it cannot be configured by system property.