edu.cornell.mannlib.vitro.webapp.controller.login

Class LoginProcessBean

java.lang.Object

edu.cornell.mannlib.vitro.webapp.controller.login.LoginProcessBean

public class LoginProcessBean
extends Object

Where are we in the process of logging on? What message should we show to the user? TODO: the contents loginPageUrl is not explicitly defined, but it is assumed to be either null, absolute, or relative to the host. It would be better if it were explicitly defined, and either null, absolute or relative to the context path. Then, the context path could be applied when the URL is used. Later for that. TODO: similar for afterLoginUrl, I presume.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoginProcessBean.Message
static class	LoginProcessBean.MLevel
static class	LoginProcessBean.State

Constructor Summary

Constructors

Constructor and Description
LoginProcessBean()

Method Summary

Modifier and Type	Method and Description
void	clearMessage()
String	getAfterLoginUrl()
static LoginProcessBean	getBean(javax.servlet.http.HttpServletRequest request) Get the login process bean from the session.
String	getErrorMessageAndClear()
String	getInfoMessageAndClear()
String	getLoginPageUrl()
LoginProcessBean.State	getState()
String	getUsername()
static boolean	isBean(javax.servlet.http.HttpServletRequest request) Is there currently a login process bean in the session?
static void	removeBean(javax.servlet.http.HttpServletRequest request) Remove the login process bean from the session.
void	setAfterLoginUrl(String afterLoginUrl)
static void	setBean(javax.servlet.http.HttpServletRequest request, LoginProcessBean bean) Store this login process bean in the session.
void	setLoginPageUrl(String loginPageUrl)
void	setMessage(javax.servlet.http.HttpServletRequest req, LoginProcessBean.MLevel level, String textKey, Object... parameters)
void	setMessage(LoginProcessBean.Message message)
void	setState(LoginProcessBean.State newState)
void	setUsername(String username)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LoginProcessBean

public LoginProcessBean()

Method Detail

isBean

public static boolean isBean(javax.servlet.http.HttpServletRequest request)

Is there currently a login process bean in the session?

getBean

public static LoginProcessBean getBean(javax.servlet.http.HttpServletRequest request)

Get the login process bean from the session. If there is no bean, create one.

setBean

public static void setBean(javax.servlet.http.HttpServletRequest request,
                           LoginProcessBean bean)

Store this login process bean in the session.

removeBean

public static void removeBean(javax.servlet.http.HttpServletRequest request)

Remove the login process bean from the session. If there is no bean, do nothing.

setState

public void setState(LoginProcessBean.State newState)

getState

public LoginProcessBean.State getState()

clearMessage

public void clearMessage()

setMessage

public void setMessage(LoginProcessBean.Message message)

setMessage

public void setMessage(javax.servlet.http.HttpServletRequest req,
                       LoginProcessBean.MLevel level,
                       String textKey,
                       Object... parameters)

getInfoMessageAndClear

public String getInfoMessageAndClear()

getErrorMessageAndClear

public String getErrorMessageAndClear()

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getLoginPageUrl

public String getLoginPageUrl()

setLoginPageUrl

public void setLoginPageUrl(String loginPageUrl)

getAfterLoginUrl

public String getAfterLoginUrl()

setAfterLoginUrl

public void setAfterLoginUrl(String afterLoginUrl)

toString

public String toString()

Overrides:

toString in class Object