cn.net.wanmo.security.filter

类 FormAuthenticationFilter

java.lang.Object

org.apache.shiro.web.servlet.ServletContextSupport

org.apache.shiro.web.servlet.AbstractFilter

org.apache.shiro.web.servlet.NameableFilter

org.apache.shiro.web.servlet.OncePerRequestFilter

org.apache.shiro.web.servlet.AdviceFilter

org.apache.shiro.web.filter.PathMatchingFilter

org.apache.shiro.web.filter.AccessControlFilter

org.apache.shiro.web.filter.authc.AuthenticationFilter

org.apache.shiro.web.filter.authc.AuthenticatingFilter

org.apache.shiro.web.filter.authc.FormAuthenticationFilter

cn.net.wanmo.security.filter.FormAuthenticationFilter

所有已实现的接口:

javax.servlet.Filter, org.apache.shiro.util.Nameable, org.apache.shiro.web.filter.PathConfigProcessor

public class FormAuthenticationFilter
extends org.apache.shiro.web.filter.authc.FormAuthenticationFilter

表单登录过滤器

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_CAPTCHA_PARAM
static String	DEFAULT_MESSAGE_PARAM
(专用程序包) org.slf4j.Logger	logger

从类继承的字段 org.apache.shiro.web.filter.authc.FormAuthenticationFilter

DEFAULT_ERROR_KEY_ATTRIBUTE_NAME, DEFAULT_PASSWORD_PARAM, DEFAULT_REMEMBER_ME_PARAM, DEFAULT_USERNAME_PARAM

从类继承的字段 org.apache.shiro.web.filter.authc.AuthenticatingFilter

PERMISSIVE

从类继承的字段 org.apache.shiro.web.filter.authc.AuthenticationFilter

DEFAULT_SUCCESS_URL

从类继承的字段 org.apache.shiro.web.filter.AccessControlFilter

DEFAULT_LOGIN_URL, GET_METHOD, POST_METHOD

从类继承的字段 org.apache.shiro.web.filter.PathMatchingFilter

appliedPaths, pathMatcher

从类继承的字段 org.apache.shiro.web.servlet.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

从类继承的字段 org.apache.shiro.web.servlet.AbstractFilter

filterConfig

构造器概要

构造器

构造器和说明
FormAuthenticationFilter()

方法概要

限定符和类型	方法和说明
protected org.apache.shiro.authc.AuthenticationToken	createToken(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) 可以根据不同的登录方式返回不同的 token
protected String	getCaptcha(javax.servlet.ServletRequest request) 验证码
String	getCaptchaParam()
String	getMessageParam()
protected String	getPassword(javax.servlet.ServletRequest request) 获取登录密码，如果获取不到则返回空
String	getPasswordParam()
String	getSuccessUrl() 登录成功之后跳转URL
protected String	getUsername(javax.servlet.ServletRequest request) 获取登录用户名，如果获取不到则返回空
String	getUsernameParam()
protected boolean	isRememberMe(javax.servlet.ServletRequest request) 获取记住我
protected boolean	onAccessDenied(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) 表示当访问拒绝时是否已经处理了；如果返回true表示需要继续处理；如果返回false表示该拦截器实例已经处理了，将直接返回即可。
protected boolean	onLoginFailure(org.apache.shiro.authc.AuthenticationToken token, org.apache.shiro.authc.AuthenticationException e, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) 当登录失败
protected boolean	onLoginSuccess(org.apache.shiro.authc.AuthenticationToken token, org.apache.shiro.subject.Subject subject, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) 当登录成功

从类继承的方法 org.apache.shiro.web.filter.authc.FormAuthenticationFilter

getFailureKeyAttribute, getRememberMeParam, isLoginSubmission, setFailureAttribute, setFailureKeyAttribute, setLoginUrl, setPasswordParam, setRememberMeParam, setUsernameParam

从类继承的方法 org.apache.shiro.web.filter.authc.AuthenticatingFilter

cleanup, createToken, createToken, executeLogin, getHost, isAccessAllowed, isPermissive

从类继承的方法 org.apache.shiro.web.filter.authc.AuthenticationFilter

issueSuccessRedirect, setSuccessUrl

从类继承的方法 org.apache.shiro.web.filter.AccessControlFilter

getLoginUrl, getSubject, isLoginRequest, onAccessDenied, onPreHandle, redirectToLogin, saveRequest, saveRequestAndRedirectToLogin

从类继承的方法 org.apache.shiro.web.filter.PathMatchingFilter

getPathWithinApplication, isEnabled, pathsMatch, pathsMatch, preHandle, processPathConfig

从类继承的方法 org.apache.shiro.web.servlet.AdviceFilter

afterCompletion, doFilterInternal, executeChain, postHandle

从类继承的方法 org.apache.shiro.web.servlet.OncePerRequestFilter

doFilter, getAlreadyFilteredAttributeName, isEnabled, isEnabled, setEnabled, shouldNotFilter

从类继承的方法 org.apache.shiro.web.servlet.NameableFilter

getName, setName, toStringBuilder

从类继承的方法 org.apache.shiro.web.servlet.AbstractFilter

destroy, getFilterConfig, getInitParam, init, onFilterConfigSet, setFilterConfig

从类继承的方法 org.apache.shiro.web.servlet.ServletContextSupport

getContextAttribute, getContextInitParam, getServletContext, removeContextAttribute, setContextAttribute, setServletContext, toString

从类继承的方法 java.lang.Object

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

字段详细资料

logger

org.slf4j.Logger logger

DEFAULT_CAPTCHA_PARAM

public static final String DEFAULT_CAPTCHA_PARAM

另请参阅:

常量字段值

DEFAULT_MESSAGE_PARAM

public static final String DEFAULT_MESSAGE_PARAM

另请参阅:

常量字段值

构造器详细资料

FormAuthenticationFilter

public FormAuthenticationFilter()

方法详细资料

createToken

protected org.apache.shiro.authc.AuthenticationToken createToken(javax.servlet.ServletRequest request,
                                                                 javax.servlet.ServletResponse response)

可以根据不同的登录方式返回不同的 token

覆盖:

createToken 在类中 org.apache.shiro.web.filter.authc.FormAuthenticationFilter

getUsername

protected String getUsername(javax.servlet.ServletRequest request)

获取登录用户名，如果获取不到则返回空

覆盖:

getUsername 在类中 org.apache.shiro.web.filter.authc.FormAuthenticationFilter

getPassword

protected String getPassword(javax.servlet.ServletRequest request)

获取登录密码，如果获取不到则返回空

覆盖:

getPassword 在类中 org.apache.shiro.web.filter.authc.FormAuthenticationFilter

isRememberMe

protected boolean isRememberMe(javax.servlet.ServletRequest request)

获取记住我

覆盖:

isRememberMe 在类中 org.apache.shiro.web.filter.authc.FormAuthenticationFilter

getCaptcha

protected String getCaptcha(javax.servlet.ServletRequest request)

验证码

参数:

request -

返回:

getUsernameParam

public String getUsernameParam()

覆盖:

getUsernameParam 在类中 org.apache.shiro.web.filter.authc.FormAuthenticationFilter

getPasswordParam

public String getPasswordParam()

覆盖:

getPasswordParam 在类中 org.apache.shiro.web.filter.authc.FormAuthenticationFilter

getCaptchaParam

public String getCaptchaParam()

getMessageParam

public String getMessageParam()

getSuccessUrl

public String getSuccessUrl()

登录成功之后跳转URL

覆盖:

getSuccessUrl 在类中 org.apache.shiro.web.filter.authc.AuthenticationFilter

onLoginSuccess

protected boolean onLoginSuccess(org.apache.shiro.authc.AuthenticationToken token,
                                 org.apache.shiro.subject.Subject subject,
                                 javax.servlet.ServletRequest request,
                                 javax.servlet.ServletResponse response)
                          throws Exception

当登录成功

覆盖:

onLoginSuccess 在类中 org.apache.shiro.web.filter.authc.FormAuthenticationFilter

抛出:

Exception

onLoginFailure

protected boolean onLoginFailure(org.apache.shiro.authc.AuthenticationToken token,
                                 org.apache.shiro.authc.AuthenticationException e,
                                 javax.servlet.ServletRequest request,
                                 javax.servlet.ServletResponse response)

当登录失败

覆盖:

onLoginFailure 在类中 org.apache.shiro.web.filter.authc.FormAuthenticationFilter

onAccessDenied

protected boolean onAccessDenied(javax.servlet.ServletRequest request,
                                 javax.servlet.ServletResponse response)
                          throws Exception

表示当访问拒绝时是否已经处理了；如果返回true表示需要继续处理；如果返回false表示该拦截器实例已经处理了，将直接返回即可。 onAccessDenied是否执行取决于isAccessAllowed的值，如果返回true则onAccessDenied不会执行；如果返回false，执行onAccessDenied 如果onAccessDenied也返回false，则直接返回，不会进入请求的方法（只有isAccessAllowed和onAccessDenied的情况下）

覆盖:

onAccessDenied 在类中 org.apache.shiro.web.filter.authc.FormAuthenticationFilter

抛出:

Exception