com.netflix.hystrix.contrib.javanica.annotation

Annotation Type HystrixCommand

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
public @interface HystrixCommand

This annotation used to specify some methods which should be processes as hystrix commands.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	commandKey Hystrix command key.
HystrixProperty[]	commandProperties Specifies command properties.
java.lang.String	defaultFallback Specifies default fallback method for the command.
java.lang.String	fallbackMethod Specifies a method to process fallback logic.
java.lang.String	groupKey The command group key is used for grouping together commands such as for reporting, alerting, dashboards or team/library ownership.
java.lang.Class<? extends java.lang.Throwable>[]	ignoreExceptions Defines exceptions which should be ignored.
ObservableExecutionMode	observableExecutionMode Specifies the mode that should be used to execute hystrix observable command.
HystrixException[]	raiseHystrixExceptions When includes RUNTIME_EXCEPTION, any exceptions that are not ignored are wrapped in HystrixRuntimeException.
java.lang.String	threadPoolKey The thread-pool key is used to represent a HystrixThreadPool for monitoring, metrics publishing, caching and other such uses.
HystrixProperty[]	threadPoolProperties Specifies thread pool properties.

Element Detail

groupKey

public abstract java.lang.String groupKey

The command group key is used for grouping together commands such as for reporting, alerting, dashboards or team/library ownership.

default => the runtime class name of annotated method

Returns:

group key

Default:

""

commandKey

public abstract java.lang.String commandKey

Hystrix command key.

default => the name of annotated method. for example: ...

Returns:

command key

Default:

""

threadPoolKey

public abstract java.lang.String threadPoolKey

The thread-pool key is used to represent a HystrixThreadPool for monitoring, metrics publishing, caching and other such uses.

Returns:

thread pool key

Default:

""

fallbackMethod

public abstract java.lang.String fallbackMethod

Specifies a method to process fallback logic. A fallback method should be defined in the same class where is HystrixCommand. Also a fallback method should have same signature to a method which was invoked as hystrix command. for example:

Returns:

method name

Default:

""

commandProperties

public abstract HystrixProperty[] commandProperties

Specifies command properties.

Returns:

command properties

Default:

{}

threadPoolProperties

public abstract HystrixProperty[] threadPoolProperties

Specifies thread pool properties.

Returns:

thread pool properties

Default:

{}

ignoreExceptions

public abstract java.lang.Class<? extends java.lang.Throwable>[] ignoreExceptions

Defines exceptions which should be ignored. Optionally these can be wrapped in HystrixRuntimeException if raiseHystrixExceptions contains RUNTIME_EXCEPTION.

Returns:

exceptions to ignore

Default:

{}

observableExecutionMode

public abstract ObservableExecutionMode observableExecutionMode

Specifies the mode that should be used to execute hystrix observable command. For more information see ObservableExecutionMode.

Returns:

observable execution mode

Default:

com.netflix.hystrix.contrib.javanica.annotation.ObservableExecutionMode.EAGER

raiseHystrixExceptions

public abstract HystrixException[] raiseHystrixExceptions

When includes RUNTIME_EXCEPTION, any exceptions that are not ignored are wrapped in HystrixRuntimeException.

Returns:

exceptions to wrap

Default:

{}

defaultFallback

public abstract java.lang.String defaultFallback

Specifies default fallback method for the command. If both fallbackMethod() and defaultFallback() methods are specified then specific one is used. note: default fallback method cannot have parameters, return type should be compatible with command return type.

Returns:

the name of default fallback method

Default:

""