org.apache.brooklyn.core

Class BrooklynFeatureEnablement

java.lang.Object

org.apache.brooklyn.core.BrooklynFeatureEnablement

public class BrooklynFeatureEnablement
extends java.lang.Object

For enabling/disabling experimental features. Feature enablement can be set in a number of ways, with the following precedence (most important first):

1. Explicit call to setEnablement(String, boolean) (or to enable(String) or disable(String))).
2. Java system properties
3. Brooklyn properties (passed using init(BrooklynProperties))
4. Defaults set explicitly by calling setDefault(String, boolean)
5. Hard-coded defaults

For example, start Brooklyn with -Dbrooklyn.executionManager.renameThreads=true

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FEATURE_AUTO_FIX_CATALOG_REF_ON_REBIND When rebinding, an entity could reference a catalog item that no longer exists.
static java.lang.String	FEATURE_BACKWARDS_COMPATIBILITY_INFER_CATALOG_ITEM_ON_REBIND When rebinding to state created from very old versions, the catalogItemId properties will be missing which results in errors when OSGi bundles are used.
static java.lang.String	FEATURE_BUNDLE_PERSISTENCE_PROPERTY
static java.lang.String	FEATURE_CATALOG_PERSISTENCE_PROPERTY
static java.lang.String	FEATURE_CORS_CXF_PROPERTY
static java.lang.String	FEATURE_DEFAULT_STANDBY_IS_HOT_PROPERTY whether the default standby mode is HighAvailabilityMode.HOT_STANDBY or falling back to the traditional HighAvailabilityMode.STANDBY
static java.lang.String	FEATURE_ENRICHER_PERSISTENCE_PROPERTY
static java.lang.String	FEATURE_FEED_PERSISTENCE_PROPERTY
static java.lang.String	FEATURE_FEED_REGISTRATION_PROPERTY whether feeds are automatically registered when set on entities, so that they are persisted
static java.lang.String	FEATURE_JITTER_THREADS Add a jitter to the startup of tasks for testing concurrency code.
static java.lang.String	FEATURE_PERSIST_ENTITY_SPEC_AS_SUPPLIER whether $brooklyn:entitySpec blocks persist a DeferredSupplier containing YAML or the resolved EntitySpec; the former allows upgrades and deferred resolution of other flags, whereas the latter is the traditional behaviour (prior to 2017-11) which resolves the EntitySpec earlier and persists that
static java.lang.String	FEATURE_POLICY_PERSISTENCE_PROPERTY
static java.lang.String	FEATURE_PROPERTY_PREFIX
static java.lang.String	FEATURE_REFERENCED_OBJECTS_REPERSISTENCE_PROPERTY When persisting an entity that changes, whether to persist its adjuncts and locations (i.e.
static java.lang.String	FEATURE_RENAME_THREADS Renaming threads can really helps with debugging etc; however it's a massive performance hit (2x)
static java.lang.String	FEATURE_SSH_ASYNC_EXEC When executing over ssh, whether to support the "async exec" approach, or only the classic approach.
static java.lang.String	FEATURE_VALIDATE_LOCATION_SSH_KEYS

Constructor Summary

Constructors

Constructor and Description
BrooklynFeatureEnablement()

Method Summary

Modifier and Type	Method and Description
static void	clearCache()
static boolean	disable(java.lang.String property)
static boolean	enable(java.lang.String property)
static void	init(BrooklynProperties props) Initialises the feature-enablement from brooklyn properties.
static boolean	isEnabled(java.lang.String property)
static void	setDefault(java.lang.String property, boolean val)
static boolean	setEnablement(java.lang.String property, boolean val)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FEATURE_PROPERTY_PREFIX

public static final java.lang.String FEATURE_PROPERTY_PREFIX

See Also:

Constant Field Values

FEATURE_POLICY_PERSISTENCE_PROPERTY

public static final java.lang.String FEATURE_POLICY_PERSISTENCE_PROPERTY

See Also:

Constant Field Values

FEATURE_ENRICHER_PERSISTENCE_PROPERTY

public static final java.lang.String FEATURE_ENRICHER_PERSISTENCE_PROPERTY

See Also:

Constant Field Values

FEATURE_FEED_PERSISTENCE_PROPERTY

public static final java.lang.String FEATURE_FEED_PERSISTENCE_PROPERTY

See Also:

Constant Field Values

FEATURE_REFERENCED_OBJECTS_REPERSISTENCE_PROPERTY

public static final java.lang.String FEATURE_REFERENCED_OBJECTS_REPERSISTENCE_PROPERTY

When persisting an entity that changes, whether to persist its adjuncts and locations (i.e. its enrichers, policies, feeds and locations). This was previously the default behaviour, which meant that (legacy) java-based Brooklyn objects (e.g. entities, locations, policies, enrichers or feeds) could get away with bad practices and still be persisted. For example, they could change 'state' without telling the listener, and hope that the entity they were attached to would soon persist (thus piggy-backing off it).

See Also:

Constant Field Values

FEATURE_FEED_REGISTRATION_PROPERTY

public static final java.lang.String FEATURE_FEED_REGISTRATION_PROPERTY

whether feeds are automatically registered when set on entities, so that they are persisted

See Also:

Constant Field Values

FEATURE_CORS_CXF_PROPERTY

public static final java.lang.String FEATURE_CORS_CXF_PROPERTY

See Also:

Constant Field Values

FEATURE_BUNDLE_PERSISTENCE_PROPERTY

public static final java.lang.String FEATURE_BUNDLE_PERSISTENCE_PROPERTY

See Also:

Constant Field Values

FEATURE_CATALOG_PERSISTENCE_PROPERTY

public static final java.lang.String FEATURE_CATALOG_PERSISTENCE_PROPERTY

See Also:

Constant Field Values

FEATURE_DEFAULT_STANDBY_IS_HOT_PROPERTY

public static final java.lang.String FEATURE_DEFAULT_STANDBY_IS_HOT_PROPERTY

whether the default standby mode is HighAvailabilityMode.HOT_STANDBY or falling back to the traditional HighAvailabilityMode.STANDBY

See Also:

Constant Field Values

FEATURE_PERSIST_ENTITY_SPEC_AS_SUPPLIER

public static final java.lang.String FEATURE_PERSIST_ENTITY_SPEC_AS_SUPPLIER

whether $brooklyn:entitySpec blocks persist a DeferredSupplier containing YAML or the resolved EntitySpec; the former allows upgrades and deferred resolution of other flags, whereas the latter is the traditional behaviour (prior to 2017-11) which resolves the EntitySpec earlier and persists that

See Also:

Constant Field Values

FEATURE_RENAME_THREADS

public static final java.lang.String FEATURE_RENAME_THREADS

Renaming threads can really helps with debugging etc; however it's a massive performance hit (2x)

We get 55000 tasks per sec with this off, 28k/s with this on.

Defaults to false if system property is not set.

See Also:

Constant Field Values

FEATURE_JITTER_THREADS

public static final java.lang.String FEATURE_JITTER_THREADS

Add a jitter to the startup of tasks for testing concurrency code. Use brooklyn.executionManager.jitterThreads.maxDelay to tune the maximum time task startup gets delayed in milliseconds. The actual time will be a random value between [0, maxDelay). Default is 200 milliseconds.

See Also:

Constant Field Values

FEATURE_BACKWARDS_COMPATIBILITY_INFER_CATALOG_ITEM_ON_REBIND

public static final java.lang.String FEATURE_BACKWARDS_COMPATIBILITY_INFER_CATALOG_ITEM_ON_REBIND

When rebinding to state created from very old versions, the catalogItemId properties will be missing which results in errors when OSGi bundles are used. When enabled the code tries to infer the catalogItemId from

• parent entities
• catalog items matching the type that needs to be deserialized
• iterating through all catalog items and checking if they can provide the needed type

See Also:

Constant Field Values

FEATURE_AUTO_FIX_CATALOG_REF_ON_REBIND

public static final java.lang.String FEATURE_AUTO_FIX_CATALOG_REF_ON_REBIND

When rebinding, an entity could reference a catalog item that no longer exists. This option will automatically update the catalog item reference to what is inferred as the most suitable catalog symbolicName:version.

See Also:

Constant Field Values

FEATURE_SSH_ASYNC_EXEC

public static final java.lang.String FEATURE_SSH_ASYNC_EXEC

When executing over ssh, whether to support the "async exec" approach, or only the classic approach. If this feature is disabled, then even if the ShellTool.PROP_EXEC_ASYNC is configured it will still use the classic ssh approach.

See Also:

Constant Field Values

FEATURE_VALIDATE_LOCATION_SSH_KEYS

public static final java.lang.String FEATURE_VALIDATE_LOCATION_SSH_KEYS

See Also:

Constant Field Values

Constructor Detail

BrooklynFeatureEnablement

public BrooklynFeatureEnablement()

Method Detail

isEnabled

public static boolean isEnabled(java.lang.String property)

init

public static void init(BrooklynProperties props)

Initialises the feature-enablement from brooklyn properties. For each property, prefer a system-property if present; otherwise use the value from brooklyn properties.

enable

public static boolean enable(java.lang.String property)

disable

public static boolean disable(java.lang.String property)

setEnablement

public static boolean setEnablement(java.lang.String property,
                                    boolean val)

setDefault

public static void setDefault(java.lang.String property,
                              boolean val)

clearCache

public static void clearCache()