com.alibaba.csp.sentinel.adapter.servlet.config

Class WebServletConfig

java.lang.Object

com.alibaba.csp.sentinel.adapter.servlet.config.WebServletConfig

public final class WebServletConfig
extends Object

The configuration center for Web Servlet adapter.

Author:

leyou, zhaoyuguang

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLOCK_PAGE_HTTP_STATUS_CONF_KEY
static String	BLOCK_PAGE_URL_CONF_KEY
static String	WEB_SERVLET_CONTEXT_NAME

Method Summary

Modifier and Type	Method and Description
static String	getBlockPage() Get redirecting page when Sentinel blocking for CommonFilter or CommonTotalFilter occurs.
static int	getBlockPageHttpStatus() Get the HTTP status when using the default block page.
static void	setBlockPage(String blockPage)
static void	setBlockPageHttpStatus(int httpStatus) Set the HTTP status of the default block page.

Methods inherited from class java.lang.Object

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

Field Detail

WEB_SERVLET_CONTEXT_NAME

public static final String WEB_SERVLET_CONTEXT_NAME

See Also:

Constant Field Values

BLOCK_PAGE_URL_CONF_KEY

public static final String BLOCK_PAGE_URL_CONF_KEY

See Also:

Constant Field Values

BLOCK_PAGE_HTTP_STATUS_CONF_KEY

public static final String BLOCK_PAGE_HTTP_STATUS_CONF_KEY

See Also:

Constant Field Values

Method Detail

getBlockPage

public static String getBlockPage()

Get redirecting page when Sentinel blocking for CommonFilter or CommonTotalFilter occurs.

Returns:

the block page URL, maybe null if not configured.

setBlockPage

public static void setBlockPage(String blockPage)

getBlockPageHttpStatus

public static int getBlockPageHttpStatus()

Get the HTTP status when using the default block page.

You can set the status code with the -Dcsp.sentinel.web.servlet.block.status property. When the property is empty or invalid, Sentinel will use 429 (Too Many Requests) as the default status code.

Returns:

the HTTP status of the default block page

Since:

1.7.0

setBlockPageHttpStatus

public static void setBlockPageHttpStatus(int httpStatus)

Set the HTTP status of the default block page.

Parameters:

httpStatus - the HTTP status of the default block page

Since:

1.7.0