org.jasig.cas.web.support

Class AbstractInMemoryThrottledSubmissionHandlerInterceptorAdapter

java.lang.Object

org.springframework.web.servlet.handler.HandlerInterceptorAdapter

org.jasig.cas.web.support.AbstractThrottledSubmissionHandlerInterceptorAdapter

org.jasig.cas.web.support.AbstractInMemoryThrottledSubmissionHandlerInterceptorAdapter

All Implemented Interfaces:

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

Direct Known Subclasses:

InMemoryThrottledSubmissionByIpAddressAndUsernameHandlerInterceptorAdapter, InMemoryThrottledSubmissionByIpAddressHandlerInterceptorAdapter

public abstract class AbstractInMemoryThrottledSubmissionHandlerInterceptorAdapter
extends AbstractThrottledSubmissionHandlerInterceptorAdapter
implements org.quartz.Job

Implementation of a HandlerInterceptorAdapter that keeps track of a mapping of IP Addresses to number of failures to authenticate.

Note, this class relies on an external method for decrementing the counts (i.e. a Quartz Job) and runs independent of the threshold of the parent.

Since:

3.0.0

Field Summary

Fields inherited from class org.jasig.cas.web.support.AbstractThrottledSubmissionHandlerInterceptorAdapter

logger

Constructor Summary

Constructors

Constructor and Description
AbstractInMemoryThrottledSubmissionHandlerInterceptorAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract java.lang.String	constructKey(javax.servlet.http.HttpServletRequest request) Construct key to be used by the throttling agent to track requests.
void	decrementCounts() This class relies on an external configuration to clean it up.
protected boolean	exceedsThreshold(javax.servlet.http.HttpServletRequest request) Determine whether threshold has been exceeded.
void	execute(org.quartz.JobExecutionContext jobExecutionContext)
protected void	recordSubmissionFailure(javax.servlet.http.HttpServletRequest request) Record submission failure.
void	scheduleThrottleJob() Schedule throttle job.

Methods inherited from class org.jasig.cas.web.support.AbstractThrottledSubmissionHandlerInterceptorAdapter

afterPropertiesSet, getFailureRangeInSeconds, getFailureThreshold, getName, getThresholdRate, getUsernameParameter, postHandle, preHandle, recordThrottle, setFailureRangeInSeconds, setFailureThreshold, setUsernameParameter, 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

Constructor Detail

AbstractInMemoryThrottledSubmissionHandlerInterceptorAdapter

public AbstractInMemoryThrottledSubmissionHandlerInterceptorAdapter()

Method Detail

exceedsThreshold

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

Description copied from class: AbstractThrottledSubmissionHandlerInterceptorAdapter

Determine whether threshold has been exceeded.

Specified by:

exceedsThreshold in class AbstractThrottledSubmissionHandlerInterceptorAdapter

Parameters:

request - the request

Returns:

true, if successful

recordSubmissionFailure

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

Description copied from class: AbstractThrottledSubmissionHandlerInterceptorAdapter

Record submission failure.

Specified by:

recordSubmissionFailure in class AbstractThrottledSubmissionHandlerInterceptorAdapter

Parameters:

request - the request

constructKey

protected abstract java.lang.String constructKey(javax.servlet.http.HttpServletRequest request)

Construct key to be used by the throttling agent to track requests.

Parameters:

request - the request

Returns:

the string

decrementCounts

public final void decrementCounts()

This class relies on an external configuration to clean it up. It ignores the threshold data in the parent class.

scheduleThrottleJob

@PostConstruct
public void scheduleThrottleJob()

Schedule throttle job.

execute

public void execute(org.quartz.JobExecutionContext jobExecutionContext)
             throws org.quartz.JobExecutionException

Specified by:

execute in interface org.quartz.Job

Throws:

org.quartz.JobExecutionException