org.jasig.cas.web.support

Class AbstractThrottledSubmissionHandlerInterceptorAdapter

java.lang.Object

org.springframework.web.servlet.handler.HandlerInterceptorAdapter

org.jasig.cas.web.support.AbstractThrottledSubmissionHandlerInterceptorAdapter

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, org.springframework.web.servlet.AsyncHandlerInterceptor, org.springframework.web.servlet.HandlerInterceptor

Direct Known Subclasses:

AbstractInMemoryThrottledSubmissionHandlerInterceptorAdapter, InspektrThrottledSubmissionByIpAddressAndUsernameHandlerInterceptorAdapter

public abstract class AbstractThrottledSubmissionHandlerInterceptorAdapter
extends org.springframework.web.servlet.handler.HandlerInterceptorAdapter
implements org.springframework.beans.factory.InitializingBean

Abstract implementation of the handler that has all of the logic. Encapsulates the logic in case we get it wrong!

Since:

3.3.5

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger Logger object.

Constructor Summary

Constructors

Constructor and Description
AbstractThrottledSubmissionHandlerInterceptorAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected abstract boolean	exceedsThreshold(javax.servlet.http.HttpServletRequest request) Determine whether threshold has been exceeded.
protected int	getFailureRangeInSeconds()
protected int	getFailureThreshold()
protected abstract java.lang.String	getName() Gets name.
protected double	getThresholdRate()
protected java.lang.String	getUsernameParameter()
void	postHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object o, org.springframework.web.servlet.ModelAndView modelAndView)
boolean	preHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object o)
protected abstract void	recordSubmissionFailure(javax.servlet.http.HttpServletRequest request) Record submission failure.
protected void	recordThrottle(javax.servlet.http.HttpServletRequest request) Record throttling event.
void	setFailureRangeInSeconds(int failureRangeInSeconds)
void	setFailureThreshold(int failureThreshold)
void	setUsernameParameter(java.lang.String usernameParameter)
java.lang.String	toString()

Methods inherited from class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

afterCompletion, afterConcurrentHandlingStarted

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Logger object.

Constructor Detail

AbstractThrottledSubmissionHandlerInterceptorAdapter

public AbstractThrottledSubmissionHandlerInterceptorAdapter()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

preHandle

public final boolean preHandle(javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response,
                java.lang.Object o)
                        throws java.lang.Exception

Specified by:

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

Overrides:

preHandle in class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

Throws:

java.lang.Exception

postHandle

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

Specified by:

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

Overrides:

postHandle in class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

Throws:

java.lang.Exception

setFailureThreshold

@Autowired
public final void setFailureThreshold(@Value(value="${cas.throttle.failure.threshold:100}")
                                 int failureThreshold)

setFailureRangeInSeconds

@Autowired
public final void setFailureRangeInSeconds(@Value(value="${cas.throttle.failure.range.seconds:60}")
                                      int failureRangeInSeconds)

setUsernameParameter

@Autowired
public final void setUsernameParameter(@Value(value="${cas.throttle.username.parameter:username}")
                                  java.lang.String usernameParameter)

getThresholdRate

protected double getThresholdRate()

getFailureThreshold

protected int getFailureThreshold()

getFailureRangeInSeconds

protected int getFailureRangeInSeconds()

getUsernameParameter

protected java.lang.String getUsernameParameter()

recordThrottle

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

Record throttling event.

Parameters:

request - the request

recordSubmissionFailure

protected abstract void recordSubmissionFailure(javax.servlet.http.HttpServletRequest request)

Record submission failure.

Parameters:

request - the request

exceedsThreshold

protected abstract boolean exceedsThreshold(javax.servlet.http.HttpServletRequest request)

Determine whether threshold has been exceeded.

Parameters:

request - the request

Returns:

true, if successful

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

protected abstract java.lang.String getName()

Gets name.

Returns:

the name