Package com.netflix.hystrix.strategy

Class HystrixPlugins

java.lang.Object

com.netflix.hystrix.strategy.HystrixPlugins

public class HystrixPlugins
extends java.lang.Object

Registry for plugin implementations that allows global override and handles the retrieval of correct implementation based on order of precedence:

1. plugin registered globally via register methods in this class
2. plugin registered and retrieved using the resolved HystrixDynamicProperties (usually Archaius, see get methods for property names)
3. plugin registered and retrieved using the JDK ServiceLoader
4. default implementation

The exception to the above order is the HystrixDynamicProperties implementation which is only loaded through System.properties or the ServiceLoader (see the getter for more details).

See the Hystrix GitHub Wiki for more information: https://github.com/Netflix/Hystrix/wiki/Plugins.

Method Summary

Modifier and Type	Method and Description
HystrixCommandExecutionHook	getCommandExecutionHook() Retrieve instance of HystrixCommandExecutionHook to use based on order of precedence as defined in HystrixPlugins class header.
HystrixConcurrencyStrategy	getConcurrencyStrategy() Retrieve instance of HystrixConcurrencyStrategy to use based on order of precedence as defined in HystrixPlugins class header.
HystrixDynamicProperties	getDynamicProperties() Retrieves the instance of HystrixDynamicProperties to use.
HystrixEventNotifier	getEventNotifier() Retrieve instance of HystrixEventNotifier to use based on order of precedence as defined in HystrixPlugins class header.
static HystrixPlugins	getInstance()
HystrixMetricsPublisher	getMetricsPublisher() Retrieve instance of HystrixMetricsPublisher to use based on order of precedence as defined in HystrixPlugins class header.
HystrixPropertiesStrategy	getPropertiesStrategy() Retrieve instance of HystrixPropertiesStrategy to use based on order of precedence as defined in HystrixPlugins class header.
void	registerCommandExecutionHook(HystrixCommandExecutionHook impl) Register a HystrixCommandExecutionHook implementation as a global override of any injected or default implementations.
void	registerConcurrencyStrategy(HystrixConcurrencyStrategy impl) Register a HystrixConcurrencyStrategy implementation as a global override of any injected or default implementations.
void	registerEventNotifier(HystrixEventNotifier impl) Register a HystrixEventNotifier implementation as a global override of any injected or default implementations.
void	registerMetricsPublisher(HystrixMetricsPublisher impl) Register a HystrixMetricsPublisher implementation as a global override of any injected or default implementations.
void	registerPropertiesStrategy(HystrixPropertiesStrategy impl) Register a HystrixPropertiesStrategy implementation as a global override of any injected or default implementations.
static void	reset() Reset all of the HystrixPlugins to null.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static HystrixPlugins getInstance()

reset

public static void reset()

Reset all of the HystrixPlugins to null. You may invoke this directly, or it also gets invoked via Hystrix.reset()

getEventNotifier

public HystrixEventNotifier getEventNotifier()

Retrieve instance of HystrixEventNotifier to use based on order of precedence as defined in HystrixPlugins class header.

Override default by using registerEventNotifier(HystrixEventNotifier) or setting property (via Archaius): hystrix.plugin.HystrixEventNotifier.implementation with the full classname to load.

Returns:

HystrixEventNotifier implementation to use

registerEventNotifier

public void registerEventNotifier(HystrixEventNotifier impl)

Register a HystrixEventNotifier implementation as a global override of any injected or default implementations.

Parameters:

impl - HystrixEventNotifier implementation

Throws:

java.lang.IllegalStateException - if called more than once or after the default was initialized (if usage occurs before trying to register)

getConcurrencyStrategy

public HystrixConcurrencyStrategy getConcurrencyStrategy()

Retrieve instance of HystrixConcurrencyStrategy to use based on order of precedence as defined in HystrixPlugins class header.

Override default by using registerConcurrencyStrategy(HystrixConcurrencyStrategy) or setting property (via Archaius): hystrix.plugin.HystrixConcurrencyStrategy.implementation with the full classname to load.

Returns:

HystrixConcurrencyStrategy implementation to use

registerConcurrencyStrategy

public void registerConcurrencyStrategy(HystrixConcurrencyStrategy impl)

Register a HystrixConcurrencyStrategy implementation as a global override of any injected or default implementations.

Parameters:

impl - HystrixConcurrencyStrategy implementation

Throws:

java.lang.IllegalStateException - if called more than once or after the default was initialized (if usage occurs before trying to register)

getMetricsPublisher

public HystrixMetricsPublisher getMetricsPublisher()

Retrieve instance of HystrixMetricsPublisher to use based on order of precedence as defined in HystrixPlugins class header.

Override default by using registerMetricsPublisher(HystrixMetricsPublisher) or setting property (via Archaius): hystrix.plugin.HystrixMetricsPublisher.implementation with the full classname to load.

Returns:

HystrixMetricsPublisher implementation to use

registerMetricsPublisher

public void registerMetricsPublisher(HystrixMetricsPublisher impl)

Register a HystrixMetricsPublisher implementation as a global override of any injected or default implementations.

Parameters:

impl - HystrixMetricsPublisher implementation

Throws:

java.lang.IllegalStateException - if called more than once or after the default was initialized (if usage occurs before trying to register)

getPropertiesStrategy

public HystrixPropertiesStrategy getPropertiesStrategy()

Retrieve instance of HystrixPropertiesStrategy to use based on order of precedence as defined in HystrixPlugins class header.

Override default by using registerPropertiesStrategy(HystrixPropertiesStrategy) or setting property (via Archaius): hystrix.plugin.HystrixPropertiesStrategy.implementation with the full classname to load.

Returns:

HystrixPropertiesStrategy implementation to use

getDynamicProperties

public HystrixDynamicProperties getDynamicProperties()

Retrieves the instance of HystrixDynamicProperties to use.

Unlike the other plugins this plugin cannot be re-registered and is only loaded at creation of the HystrixPlugins singleton.

The order of precedence for loading implementations is:

1. System property of key: hystrix.plugin.HystrixDynamicProperties.implementation with the class as a value.
2. The ServiceLoader.
3. An implementation based on Archaius if it is found in the classpath is used.
4. A fallback implementation based on the System.getProperties()

Returns:

never null

registerPropertiesStrategy

public void registerPropertiesStrategy(HystrixPropertiesStrategy impl)

Register a HystrixPropertiesStrategy implementation as a global override of any injected or default implementations.

Parameters:

impl - HystrixPropertiesStrategy implementation

Throws:

java.lang.IllegalStateException - if called more than once or after the default was initialized (if usage occurs before trying to register)

getCommandExecutionHook

public HystrixCommandExecutionHook getCommandExecutionHook()

Retrieve instance of HystrixCommandExecutionHook to use based on order of precedence as defined in HystrixPlugins class header.

Override default by using registerCommandExecutionHook(HystrixCommandExecutionHook) or setting property (via Archaius): hystrix.plugin.HystrixCommandExecutionHook.implementation with the full classname to load.

Returns:

HystrixCommandExecutionHook implementation to use

Since:

1.2

registerCommandExecutionHook

public void registerCommandExecutionHook(HystrixCommandExecutionHook impl)

Register a HystrixCommandExecutionHook implementation as a global override of any injected or default implementations.

Parameters:

impl - HystrixCommandExecutionHook implementation

Throws:

java.lang.IllegalStateException - if called more than once or after the default was initialized (if usage occurs before trying to register)

Since:

1.2