jodd.joy.auth

Class AuthUtil

java.lang.Object

jodd.joy.auth.AuthUtil

public class AuthUtil
extends java.lang.Object

Authentication utilities.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTH_COOKIE_NAME
static java.lang.String	AUTH_SESSION_NAME

Constructor Summary

Constructors

Constructor and Description
AuthUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	closeUserSession(javax.servlet.http.HttpServletRequest servletRequest)
static void	closeUserSession(javax.servlet.http.HttpSession httpSession) Closes user session.
static java.lang.Object	getNewUserSession(javax.servlet.http.HttpServletRequest servletRequest) Returns new session object from the request attributes, usually created during user registration.
static java.lang.Object	getUserSession(javax.servlet.http.HttpServletRequest servletRequest)
static java.lang.Object	getUserSession(javax.servlet.http.HttpSession httpSession) Returns user session or null if there is no authenticated user.
static java.lang.String[]	readAuthCookie(javax.servlet.http.HttpServletRequest request) Reads auth cookie and returns stored string array from cookie data.
static void	removeAuthCookie(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) Removes auth cookie.
static void	startUserSession(javax.servlet.http.HttpServletRequest servletRequest, java.lang.Object userSession)
static void	startUserSession(javax.servlet.http.HttpSession httpSession, java.lang.Object userSession) Starts user session by storing user session object into http session.
static void	storeAuthCookie(javax.servlet.http.HttpServletResponse response, int cookieMaxAge, java.lang.String... values) Stores string array into the cookie.

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_SESSION_NAME

public static final java.lang.String AUTH_SESSION_NAME

See Also:

Constant Field Values

AUTH_COOKIE_NAME

public static final java.lang.String AUTH_COOKIE_NAME

See Also:

Constant Field Values

Constructor Detail

AuthUtil

public AuthUtil()

Method Detail

getNewUserSession

public static java.lang.Object getNewUserSession(javax.servlet.http.HttpServletRequest servletRequest)

Returns new session object from the request attributes, usually created during user registration.

getUserSession

public static java.lang.Object getUserSession(javax.servlet.http.HttpSession httpSession)

Returns user session or null if there is no authenticated user.

getUserSession

public static java.lang.Object getUserSession(javax.servlet.http.HttpServletRequest servletRequest)

See Also:

getUserSession(javax.servlet.http.HttpSession)

closeUserSession

public static void closeUserSession(javax.servlet.http.HttpSession httpSession)

Closes user session.

closeUserSession

public static void closeUserSession(javax.servlet.http.HttpServletRequest servletRequest)

See Also:

closeUserSession(javax.servlet.http.HttpSession)

startUserSession

public static void startUserSession(javax.servlet.http.HttpSession httpSession,
                    java.lang.Object userSession)

Starts user session by storing user session object into http session.

startUserSession

public static void startUserSession(javax.servlet.http.HttpServletRequest servletRequest,
                    java.lang.Object userSession)

See Also:

startUserSession(javax.servlet.http.HttpServletRequest, Object)

readAuthCookie

public static java.lang.String[] readAuthCookie(javax.servlet.http.HttpServletRequest request)
                                         throws java.lang.Exception

Reads auth cookie and returns stored string array from cookie data. Returns null if cookie does not exist. Throws an exception if cookie data is invalid or corrupted.

Throws:

java.lang.Exception

storeAuthCookie

public static void storeAuthCookie(javax.servlet.http.HttpServletResponse response,
                   int cookieMaxAge,
                   java.lang.String... values)

Stores string array into the cookie.

removeAuthCookie

public static void removeAuthCookie(javax.servlet.http.HttpServletRequest servletRequest,
                    javax.servlet.http.HttpServletResponse servletResponse)

Removes auth cookie.