cn.home1.oss.lib.security.internal.rest

Class RestfulLoginDisabledFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

cn.home1.oss.lib.security.internal.rest.RestfulLoginDisabledFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.web.context.ServletContextAware

public class RestfulLoginDisabledFilter
extends org.springframework.web.filter.GenericFilterBean

Note: Not a bean, avoid auto pick-up. see: UsernamePasswordAuthenticationFilter. Created by zhanghaolun on 16/7/5.

Field Summary

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Constructor Summary

Constructors

Constructor and Description
RestfulLoginDisabledFilter()

Method Summary

Modifier and Type	Method and Description
void	doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain chain)
protected boolean	requiresAuthentication(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Indicates whether this filter should attempt to process a login request for the current invocation.
void	setExceptionHandler(cn.home1.oss.lib.errorhandle.internal.RestfulExceptionHandler exceptionHandler)
void	setFilterProcessesUrl(String filterProcessesUrl) Sets the URL that determines if authentication is required.
void	setPostOnly(boolean postOnly) Defines whether only HTTP POST requests will be allowed by this filter.
void	setRequiresAuthenticationRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher requestMatcher)

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, destroy, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Detail

RestfulLoginDisabledFilter

public RestfulLoginDisabledFilter()

Method Detail

doFilter

public void doFilter(javax.servlet.ServletRequest req,
                     javax.servlet.ServletResponse res,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

requiresAuthentication

protected boolean requiresAuthentication(javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.http.HttpServletResponse response)

Indicates whether this filter should attempt to process a login request for the current invocation.

It strips any parameters from the "path" section of the request URL (such as the jsessionid parameter in http://host/myapp/index.html;jsessionid=blah) before matching against the filterProcessesUrl property.

Subclasses may override for special requirements, such as Tapestry integration.

Parameters:

request - request

response - response

Returns:

true if the filter should attempt authentication, false otherwise.

setFilterProcessesUrl

public void setFilterProcessesUrl(String filterProcessesUrl)

Sets the URL that determines if authentication is required.

Parameters:

filterProcessesUrl - filterProcessesUrl

setRequiresAuthenticationRequestMatcher

public final void setRequiresAuthenticationRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher requestMatcher)

setPostOnly

public void setPostOnly(boolean postOnly)

Defines whether only HTTP POST requests will be allowed by this filter. If set to true, and an authentication request is received which is not a POST request, an exception will be raised immediately and authentication will not be attempted. The unsuccessfulAuthentication() method will be called as if handling a failed authentication.

Defaults to true but may be overridden by subclasses.

Parameters:

postOnly - postOnly

setExceptionHandler

public void setExceptionHandler(cn.home1.oss.lib.errorhandle.internal.RestfulExceptionHandler exceptionHandler)