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

Enum ApiGatewayFeature

java.lang.Object

java.lang.Enum<ApiGatewayFeature>

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

All Implemented Interfaces:

Feature, Serializable, Comparable<ApiGatewayFeature>

public enum ApiGatewayFeature
extends Enum<ApiGatewayFeature>
implements Feature

Enum Constant Summary

Enum Constants

Enum Constant and Description
KEEP_DEFAULT_POLICY_FORMAT

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.
static ApiGatewayFeature	valueOf(String name) Returns the enum constant of this type with the specified name.
static ApiGatewayFeature[]	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

KEEP_DEFAULT_POLICY_FORMAT

public static final ApiGatewayFeature KEEP_DEFAULT_POLICY_FORMAT

Method Detail

values

public static ApiGatewayFeature[] 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 (ApiGatewayFeature c : ApiGatewayFeature.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ApiGatewayFeature 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.

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