com.alibaba.csp.sentinel.slots.block

Class BlockException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.alibaba.csp.sentinel.slots.block.BlockException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthorityException, DegradeException, FlowException, SystemBlockException

public abstract class BlockException
extends Exception

Abstract exception indicating blocked by Sentinel due to flow control, circuit breaking or system protection triggered.

Author:

youji.zj

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLOCK_EXCEPTION_FLAG
static String	BLOCK_EXCEPTION_MSG_PREFIX
protected AbstractRule	rule
static StackTraceElement[]	sentinelStackTrace
static RuntimeException	THROW_OUT_EXCEPTION this constant RuntimeException has no stack trace, just has a message BLOCK_EXCEPTION_FLAG that marks its name.

Constructor Summary

Constructors

Constructor and Description
BlockException(String ruleLimitApp)
BlockException(String ruleLimitApp, AbstractRule rule)
BlockException(String ruleLimitApp, String message)
BlockException(String ruleLimitApp, String message, AbstractRule rule)
BlockException(String message, Throwable cause)

Method Summary

Modifier and Type	Method and Description
Throwable	fillInStackTrace()
AbstractRule	getRule()
String	getRuleLimitApp()
static boolean	isBlockException(Throwable t) Check whether the exception is sentinel blocked exception.
void	setRuleLimitApp(String ruleLimitApp)
RuntimeException	toRuntimeException()

Methods inherited from class java.lang.Throwable

addSuppressed, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

BLOCK_EXCEPTION_FLAG

public static final String BLOCK_EXCEPTION_FLAG

See Also:

Constant Field Values

BLOCK_EXCEPTION_MSG_PREFIX

public static final String BLOCK_EXCEPTION_MSG_PREFIX

See Also:

Constant Field Values

THROW_OUT_EXCEPTION

public static RuntimeException THROW_OUT_EXCEPTION

this constant RuntimeException has no stack trace, just has a message BLOCK_EXCEPTION_FLAG that marks its name.

Use isBlockException(Throwable) to check whether one Exception Sentinel Blocked Exception.

sentinelStackTrace

public static StackTraceElement[] sentinelStackTrace

rule

protected AbstractRule rule

Constructor Detail

BlockException

public BlockException(String ruleLimitApp)

BlockException

public BlockException(String ruleLimitApp,
                      AbstractRule rule)

BlockException

public BlockException(String message,
                      Throwable cause)

BlockException

public BlockException(String ruleLimitApp,
                      String message)

BlockException

public BlockException(String ruleLimitApp,
                      String message,
                      AbstractRule rule)

Method Detail

fillInStackTrace

public Throwable fillInStackTrace()

Overrides:

fillInStackTrace in class Throwable

getRuleLimitApp

public String getRuleLimitApp()

setRuleLimitApp

public void setRuleLimitApp(String ruleLimitApp)

toRuntimeException

public RuntimeException toRuntimeException()

isBlockException

public static boolean isBlockException(Throwable t)

Check whether the exception is sentinel blocked exception. One exception is sentinel blocked exception only when:

• the exception or its (sub-)cause is BlockException, or
• the exception's message or any of its sub-cause's message is prefixed by BLOCK_EXCEPTION_FLAG

Parameters:

t - the exception.

Returns:

return true if the exception marks sentinel blocked exception.

getRule

public AbstractRule getRule()