com.alibaba.csp.sentinel.adapter.spring.webmvc

Class AbstractSentinelInterceptor

java.lang.Object

com.alibaba.csp.sentinel.adapter.spring.webmvc.AbstractSentinelInterceptor

All Implemented Interfaces:

org.springframework.web.servlet.HandlerInterceptor

Direct Known Subclasses:

SentinelWebInterceptor, SentinelWebTotalInterceptor

public abstract class AbstractSentinelInterceptor
extends Object
implements org.springframework.web.servlet.HandlerInterceptor

Since request may be reprocessed in flow if any forwarding or including or other action happened (see ServletRequest.getDispatcherType()) we will only deal with the initial request. So we use reference count to track in dispathing "onion" though which we could figure out whether we are in initial type "REQUEST". That means the sub-requests which we rarely meet in practice will NOT be recorded in Sentinel.

How to implement a forward sub-request in your action:

 initalRequest() {
     ModelAndView mav = new ModelAndView();
     mav.setViewName("another");
     return mav;
 }
 

Since:

1.7.1

Author:

kaizi2009

Field Summary

Fields

Modifier and Type	Field and Description
static String	SENTINEL_SPRING_WEB_CONTEXT_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractSentinelInterceptor(BaseWebMvcConfig config)

Method Summary

Modifier and Type	Method and Description
void	afterCompletion(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler, Exception ex)
protected String	getContextName(javax.servlet.http.HttpServletRequest request) Return the context name of the target web resource.
protected Entry	getEntryInRequest(javax.servlet.http.HttpServletRequest request, String attrKey)
protected abstract String	getResourceName(javax.servlet.http.HttpServletRequest request) Return the resource name of the target web resource.
protected void	handleBlockException(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, BlockException e)
protected String	parseOrigin(javax.servlet.http.HttpServletRequest request)
void	postHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler, org.springframework.web.servlet.ModelAndView modelAndView)
boolean	preHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler)
protected void	removeEntryInRequest(javax.servlet.http.HttpServletRequest request)
protected void	traceExceptionAndExit(Entry entry, Exception ex)

Methods inherited from class java.lang.Object

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

Field Detail

SENTINEL_SPRING_WEB_CONTEXT_NAME

public static final String SENTINEL_SPRING_WEB_CONTEXT_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractSentinelInterceptor

public AbstractSentinelInterceptor(BaseWebMvcConfig config)

Method Detail

preHandle

public boolean preHandle(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         Object handler)
                  throws Exception

Specified by:

preHandle in interface org.springframework.web.servlet.HandlerInterceptor

Throws:

Exception

getResourceName

protected abstract String getResourceName(javax.servlet.http.HttpServletRequest request)

Return the resource name of the target web resource.

Parameters:

request - web request

Returns:

the resource name of the target web resource.

getContextName

protected String getContextName(javax.servlet.http.HttpServletRequest request)

Return the context name of the target web resource.

Parameters:

request - web request

Returns:

the context name of the target web resource.

afterCompletion

public void afterCompletion(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            Object handler,
                            Exception ex)
                     throws Exception

Specified by:

afterCompletion in interface org.springframework.web.servlet.HandlerInterceptor

Throws:

Exception

postHandle

public void postHandle(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       Object handler,
                       org.springframework.web.servlet.ModelAndView modelAndView)
                throws Exception

Specified by:

postHandle in interface org.springframework.web.servlet.HandlerInterceptor

Throws:

Exception

getEntryInRequest

protected Entry getEntryInRequest(javax.servlet.http.HttpServletRequest request,
                                  String attrKey)

removeEntryInRequest

protected void removeEntryInRequest(javax.servlet.http.HttpServletRequest request)

traceExceptionAndExit

protected void traceExceptionAndExit(Entry entry,
                                     Exception ex)

handleBlockException

protected void handleBlockException(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    BlockException e)
                             throws Exception

Throws:

Exception

parseOrigin

protected String parseOrigin(javax.servlet.http.HttpServletRequest request)