com.alibaba.csp.sentinel.annotation

Annotation Type SentinelResource

@Target(value={METHOD,TYPE})
 @Retention(value=RUNTIME)
 @Inherited
public @interface SentinelResource

The annotation indicates a definition of Sentinel resource.

Since:

0.1.1

Author:

Eric Zhao, zhaoyuguang

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	blockHandler
Class<?>[]	blockHandlerClass The blockHandler is located in the same class with the original method by default.
String	defaultFallback The defaultFallback is used as the default universal fallback method.
EntryType	entryType
Class<? extends Throwable>[]	exceptionsToIgnore Indicates the exceptions to be ignored.
Class<? extends Throwable>[]	exceptionsToTrace
String	fallback
Class<?>[]	fallbackClass The fallback is located in the same class with the original method by default.
int	resourceType
String	value

Element Detail

value

public abstract String value

Returns:

name of the Sentinel resource

Default:

""

entryType

public abstract EntryType entryType

Returns:

the entry type (inbound or outbound), outbound by default

Default:

com.alibaba.csp.sentinel.EntryType.OUT

resourceType

public abstract int resourceType

Returns:

the classification (type) of the resource

Since:

1.7.0

Default:

0

blockHandler

public abstract String blockHandler

Returns:

name of the block exception function, empty by default

Default:

""

blockHandlerClass

public abstract Class<?>[] blockHandlerClass

The blockHandler is located in the same class with the original method by default. However, if some methods share the same signature and intend to set the same block handler, then users can set the class where the block handler exists. Note that the block handler method must be static.

Returns:

the class where the block handler exists, should not provide more than one classes

Default:

{}

fallback

public abstract String fallback

Returns:

name of the fallback function, empty by default

Default:

""

defaultFallback

public abstract String defaultFallback

The defaultFallback is used as the default universal fallback method. It should not accept any parameters, and the return type should be compatible with the original method.

Returns:

name of the default fallback method, empty by default

Since:

1.6.0

Default:

""

fallbackClass

public abstract Class<?>[] fallbackClass

The fallback is located in the same class with the original method by default. However, if some methods share the same signature and intend to set the same fallback, then users can set the class where the fallback function exists. Note that the shared fallback method must be static.

Returns:

the class where the fallback method is located (only single class)

Since:

1.6.0

Default:

{}

exceptionsToTrace

public abstract Class<? extends Throwable>[] exceptionsToTrace

Returns:

the list of exception classes to trace, Throwable by default

Since:

1.5.1

Default:

java.lang.Throwable.class

exceptionsToIgnore

public abstract Class<? extends Throwable>[] exceptionsToIgnore

Indicates the exceptions to be ignored. Note that exceptionsToTrace should not appear with exceptionsToIgnore at the same time, or exceptionsToIgnore will be of higher precedence.

Returns:

the list of exception classes to ignore, empty by default

Since:

1.6.0

Default:

{}