jodd.joy.auth

Class AuthenticationInterceptor<U>

java.lang.Object

jodd.madvoc.BaseActionWrapper

jodd.madvoc.interceptor.BaseActionInterceptor

jodd.joy.auth.AuthenticationInterceptor<U>

All Implemented Interfaces:

jodd.madvoc.ActionWrapper, jodd.madvoc.interceptor.ActionInterceptor

public abstract class AuthenticationInterceptor<U>
extends jodd.madvoc.interceptor.BaseActionInterceptor

Authentication checking interceptor. Usually invoked before AuthorizationInterceptor. Provides auto-login using cookies.

Authentication pertains to the question "Who are you?". Usually a user authenticates himself by successfully associating his "principal" (often a username) with his "credentials" (often a password).

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cookieMaxAge Cookie max age, when cookies are used.
protected boolean	recreateCookieOnLogin When user just logs in with cookie, should we recreate the cookie (and therefore prolong cookie valid time) or leave it as it is.
protected boolean	useCookie If true, cookie will be created for keeping user sessions.

Fields inherited from class jodd.madvoc.BaseActionWrapper

enabled

Constructor Summary

Constructors

Constructor and Description
AuthenticationInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeAuthSession(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) Closes auth session by removing auth session object from the http session and clearing the auth cookie.
protected abstract java.lang.String[]	createCookieData(U userSession) Prepares cookie data from session object.
java.lang.Object	intercept(jodd.madvoc.ActionRequest actionRequest)
protected boolean	isLoginAction(java.lang.String actionPath) Detects login path.
protected boolean	isLogoutAction(java.lang.String actionPath) Detects logout path.
protected boolean	isRegisterAction(java.lang.String actionPath) Detects registration path.
protected abstract U	loginUsernamePassword(java.lang.String username, java.lang.String password) Tries to login a user using username and password.
protected abstract U	loginViaCookie(java.lang.String[] cookieData) Tries to login user with cookie data.
protected U	loginViaRequest(javax.servlet.http.HttpServletRequest servletRequest) Tires to login user with form data.
protected java.lang.Object	resultLoginFailed(int reason) Prepares result for login failed page.
protected java.lang.Object	resultLoginSuccess(java.lang.String path) Prepares result to continue to, after success login.
protected java.lang.Object	resultLogoutSuccess() Prepares result for logout success page.
protected java.lang.Object	resultRegistrationSuccess() Prepares result for registration success page.
protected void	startAuthSession(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, U userSession, boolean isNew) Starts auth session by saving session auth object and optionally creating an auth cookie.

Methods inherited from class jodd.madvoc.interceptor.BaseActionInterceptor

invoke, toString

Methods inherited from class jodd.madvoc.BaseActionWrapper

init, isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface jodd.madvoc.ActionWrapper

init, isEnabled, setEnabled

Field Detail

useCookie

protected boolean useCookie

If true, cookie will be created for keeping user sessions.

cookieMaxAge

protected int cookieMaxAge

Cookie max age, when cookies are used. By default set to 14 days.

recreateCookieOnLogin

protected boolean recreateCookieOnLogin

When user just logs in with cookie, should we recreate the cookie (and therefore prolong cookie valid time) or leave it as it is.

Constructor Detail

AuthenticationInterceptor

public AuthenticationInterceptor()

Method Detail

intercept

public java.lang.Object intercept(jodd.madvoc.ActionRequest actionRequest)
                           throws java.lang.Exception

Throws:

java.lang.Exception

startAuthSession

protected void startAuthSession(javax.servlet.http.HttpServletRequest servletRequest,
                    javax.servlet.http.HttpServletResponse servletResponse,
                    U userSession,
                    boolean isNew)

Starts auth session by saving session auth object and optionally creating an auth cookie. Auth cookie is created for new auth sessions and for old ones if recreation is enabled.

Parameters:

servletRequest - http request

servletResponse - http response

userSession - created session object

isNew - if true indicated the session is new (i.e. user is either registered or signed in), if false means that session is continued (i.e. user is signed in via cookie).

closeAuthSession

protected void closeAuthSession(javax.servlet.http.HttpServletRequest servletRequest,
                    javax.servlet.http.HttpServletResponse servletResponse)

Closes auth session by removing auth session object from the http session and clearing the auth cookie.

isLoginAction

protected boolean isLoginAction(java.lang.String actionPath)

Detects login path.

isLogoutAction

protected boolean isLogoutAction(java.lang.String actionPath)

Detects logout path.

isRegisterAction

protected boolean isRegisterAction(java.lang.String actionPath)

Detects registration path.

resultLoginSuccess

protected java.lang.Object resultLoginSuccess(java.lang.String path)

Prepares result to continue to, after success login. If target path is empty, will continue to the index page.

resultLogoutSuccess

protected java.lang.Object resultLogoutSuccess()

Prepares result for logout success page.

resultRegistrationSuccess

protected java.lang.Object resultRegistrationSuccess()

Prepares result for registration success page.

resultLoginFailed

protected java.lang.Object resultLoginFailed(int reason)

Prepares result for login failed page.

loginViaCookie

protected abstract U loginViaCookie(java.lang.String[] cookieData)

Tries to login user with cookie data. Returns session object, otherwise returns null.

loginViaRequest

protected U loginViaRequest(javax.servlet.http.HttpServletRequest servletRequest)

Tires to login user with form data. Returns session object, otherwise returns null. By default, calls loginUsernamePassword(String, String).

loginUsernamePassword

protected abstract U loginUsernamePassword(java.lang.String username,
                      java.lang.String password)

Tries to login a user using username and password. Returns session object if login was successful.

Parameters:

username - entered user name from login form

password - entered raw password

createCookieData

protected abstract java.lang.String[] createCookieData(U userSession)

Prepares cookie data from session object.