e4s.application.appmodule
Class E4ModuleLogin

java.lang.Object
  e4s.util.E4Object
      e4s.html.E4HtmlObject
          e4s.servlet.E4ModuleImplementation
              e4s.application.appmodule.E4ModuleImplementationApplication
                  e4s.application.appmodule.E4ModuleLogin

public class E4ModuleLogin
extends E4ModuleImplementationApplication

Login handling (company/user -> client). This module is used to perform a login form, ask for client, company, user and password. Lookup in the database tables T_E4S_CLIENT_Sel, T_E4S_COMPANY_Sel and T_E4S_COMPANY_USER_Sel to check if client, company and user exist and are valid, if password matches. If everything is o.k., then an E4ApplObj_Intf object is instanciated for this session.

Since:

JDK 1.4

Nested Class Summary

static class

E4ModuleLogin.E4TempApplObj Temporary application object during login

Field Summary

static E4Method	changePassword
static E4Method	changePassword_Save
static CLASS_Name	CLASS_LOGIN_BODY
static E4Method	login
static E4Method	logOut
static E4Method	lostPassword
static E4Method	lostPassword_Go
static E4InputFieldName	PARAM_CLIENT
static E4InputFieldName	PARAM_COMPANY_LOGIN_NAME
static E4InputFieldName	PARAM_EMAIL
static E4InputFieldName	PARAM_HIDE_CLIENT
static E4InputFieldName	PARAM_LANGUAGE
static java.lang.String	PARAM_MREF_ALIAS_FAILED
static E4InputFieldName	PARAM_PASSWORD
static E4InputFieldName	PARAM_PASSWORD_NEW
static E4InputFieldName	PARAM_PASSWORD_OLD
static E4InputFieldName	PARAM_PASSWORD_RETYPE
static E4InputFieldName	PARAM_RANDOM_CODE
static E4InputFieldName	PARAM_REMEMBER_PASSWORD
static E4InputFieldName	PARAM_USER_LOGIN
static E4Method	sessionTimedOut This Method is called on a session timeout.
static E4Method	start
static java.lang.String	TXT_MSG_TIMEOUT

Fields inherited from class e4s.application.appmodule.E4ModuleImplementationApplication

RESTRICTED_COMPANY_DOOR2SOLUTION_LOGIN, RESTRICTED_COMPANY_DOOR2SOLUTION_NAME, RESTRICTED_USER_DOOR2SOLUTION_LOGIN

Fields inherited from class e4s.html.E4HtmlObject

m_parent_e4sID

Fields inherited from class e4s.util.E4Object

CRLF, E4S_CORE_SYSTEM_LANGUAGE, NBSP, NULLSTR, URL_ENCODING_CHARSET

Constructor Summary

E4ModuleLogin()

Method Summary

static java.lang.String	_getSVNVersionString() Get version info string from subversion.
void	changePassword_Save(HTML html, E4CgiParams params)
void	changePassword(HTML html)
static E4Method	getSessionTimeoutMethod() Get the session-timeout function which is called when a session was terminated.
static E4FrameName	getStartupFrame()
static E4Method	getStartupMethod() Get the default method that is called after the login (it is the entry point to your application).
static E4Method	getStartupMethodTimeout()
static void	initRedirectionFile()
void	login(HTML html, E4CgiParams params)
void	logOut(HTML html)
void	lostPassword_Go(HTML html, E4CgiParams params)
void	lostPassword(BODY body, E4CgiParams params)
void	lostPassword(HTML html, E4CgiParams params)
void	sessionTimedOut(HTML html, E4CgiParams params)
static void	setSessionTimeoutMethod(E4Method mref) Set the session-timeout function which is called when a session was terminated.
static void	setStartupFrame(E4FrameName frame)
static void	setStartupMethod(E4Method mref) Set the default method that is called after the login (it is the entry point to your application).
static void	setStartupMethodTimeout(E4Method mref)
void	start(BODY body, E4CgiParams params)
void	start(HTML html, E4CgiParams params)

Methods inherited from class e4s.application.appmodule.E4ModuleImplementationApplication

find_T_E4S_COMPANY_GROUP, find_T_E4S_COMPANY, find_T_E4S_PERMISSION_COMPANY, find_T_E4S_PERMISSION_GROUP, find_T_E4S_PERMISSION_USER, Format, Format, getName, subE4MenuItem

Methods inherited from class e4s.servlet.E4ModuleImplementation

canDo, canDo, canRun, closeHtmlOutput, empty2nbsp, empty2nbsp, getApplication_Permissions, getApplication, getApplObj, getClient, getClientImage, getClientObject, getClientObject, getClientObject, getClientValue, getClientValueBool, getClientValueDate, getClientValueFloat, getClientValueInt, getClientValueLong, getCookie, getCookieArr, getCookieBool, getCookieDate, getCookieLong, getCountryCode, getCSS, getDateFormat, getDbConnection, getDecimalSign, getE4ClientLogo, getE4S_Permissions, getLanguage_App, getLanguage_Sys, getLanguage, getParameters, getPersistantParameter, getPersistantParameterBoolean, getPersistantParameterDate, getPersistantParameterInt, getPersistantParameterIntArr, getPersistantParameterLong, getPickParams, getRemoteAddr, getRequiredModulePermission, getServlet, getSession, getSessionId, getSessionObject_Boolean, getSessionObject_Long, getSessionObject_String, getSessionObject, getSessionObject, getSessionObjects, getTimeFormat, getTimeZone, getUrl, getUserEmail, getUserValue, getUserValue, getUserValueArr, getUserValueBool, getUserValueBool, getUserValueDate, getUserValueDate, getUserValueInt, getUserValueInt, getUserValueLong, getUserValueLong, isok, isPersistant, isRunningWindow, isTimeout, ok, openHtmlOutput, removeApplicationObject, removeClientObject, removeClientObject, removeClientObject, removeClientValue, removeSessionObject, removeSessionObject, removeUserValue, removeUserValue, resetClientLogo, setAjaxTrace, setApplication, setApplicationObject, setClientObject, setClientObject, setClientObject, setClientValue, setClientValue, setClientValue, setClientValue, setClientValue, setClientValue, setClientValue, setCookie, setCookie, setCookie, setCookie, setCookie, setCookie, setCookie, setCookie, setPersistantParameter, setPersistantParameter, setPersistantParameter, setPersistantParameter, setPersistantParameter, setPersistantParameter, setServlet, setSessionObject, setSessionObject, setSessionObject, setSessionObject, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, setUserValue, SystemError, write, write, write, write, write, writeln, writeln, writeln, writeln

Methods inherited from class e4s.html.E4HtmlObject

E4ID, E4ID, set_e4sID

Methods inherited from class e4s.util.E4Object

Calendar, CName, CName, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelSys, E4LabelSys, e4sCopyright, e4sVersion, encode, encode, encode, encodeHtml, encodeHtml, encodeHtml, encodeURL, encodeURL, encodeURL, finalize, getLINE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTraceMemory, HtmlEncode, HtmlEncode, HtmlEncode, isdecimal, isdigit, isnotok, isnotok, isnumeric, isok, isok, isok, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingStack, mkdirs, null2nbsp, null2nbsp, null2nbsp, ok, ok, ok, outPrintln, setLogFile4Trace, setTraceMemory, STACKTRACE, toDebug, toDouble, toFloat, toFloat, toString, TRACE_CALLS, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, wait

Methods inherited from class java.lang.Object

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

Field Detail

start

public static E4Method start

login

public static E4Method login

logOut

public static E4Method logOut

lostPassword

public static E4Method lostPassword

lostPassword_Go

public static E4Method lostPassword_Go

changePassword

public static E4Method changePassword

changePassword_Save

public static E4Method changePassword_Save

sessionTimedOut

public static E4Method sessionTimedOut

This Method is called on a session timeout.

See Also:

FRAMESET.addKeepAliveScript(e4s.servlet.E4ServletImplementation_Intf)

PARAM_MREF_ALIAS_FAILED

public static java.lang.String PARAM_MREF_ALIAS_FAILED

PARAM_CLIENT

public static final E4InputFieldName PARAM_CLIENT

PARAM_HIDE_CLIENT

public static final E4InputFieldName PARAM_HIDE_CLIENT

PARAM_COMPANY_LOGIN_NAME

public static final E4InputFieldName PARAM_COMPANY_LOGIN_NAME

PARAM_USER_LOGIN

public static final E4InputFieldName PARAM_USER_LOGIN

PARAM_PASSWORD

public static final E4InputFieldName PARAM_PASSWORD

PARAM_RANDOM_CODE

public static final E4InputFieldName PARAM_RANDOM_CODE

PARAM_PASSWORD_NEW

public static final E4InputFieldName PARAM_PASSWORD_NEW

PARAM_PASSWORD_OLD

public static final E4InputFieldName PARAM_PASSWORD_OLD

PARAM_PASSWORD_RETYPE

public static final E4InputFieldName PARAM_PASSWORD_RETYPE

PARAM_LANGUAGE

public static final E4InputFieldName PARAM_LANGUAGE

PARAM_EMAIL

public static final E4InputFieldName PARAM_EMAIL

PARAM_REMEMBER_PASSWORD

public static final E4InputFieldName PARAM_REMEMBER_PASSWORD

CLASS_LOGIN_BODY

public static final CLASS_Name CLASS_LOGIN_BODY

TXT_MSG_TIMEOUT

public static final java.lang.String TXT_MSG_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

E4ModuleLogin

public E4ModuleLogin()

Method Detail

start

public void start(HTML html,
                  E4CgiParams params)

start

public void start(BODY body,
                  E4CgiParams params)

login

public void login(HTML html,
                  E4CgiParams params)
           throws java.lang.Exception

Throws:

java.lang.Exception

logOut

public void logOut(HTML html)

setStartupMethod

public static void setStartupMethod(E4Method mref)

Set the default method that is called after the login (it is the entry point to your application).

Parameters:

mref - the method to be called

See Also:

E4ModuleSystem.mainStart, getStartupMethod(), setStartupFrame(e4s.html.E4FrameName), setSessionTimeoutMethod(e4s.html.E4Method)

getStartupMethod

public static E4Method getStartupMethod()

Get the default method that is called after the login (it is the entry point to your application).

Returns:

the method to be called or null to use default method E4ModuleSystem.mainStart.

See Also:

E4ModuleSystem.mainStart, setStartupMethod(e4s.html.E4Method), setStartupFrame(e4s.html.E4FrameName), getSessionTimeoutMethod()

setStartupFrame

public static void setStartupFrame(E4FrameName frame)

getStartupFrame

public static E4FrameName getStartupFrame()

setStartupMethodTimeout

public static void setStartupMethodTimeout(E4Method mref)

getStartupMethodTimeout

public static E4Method getStartupMethodTimeout()

lostPassword

public void lostPassword(HTML html,
                         E4CgiParams params)

lostPassword

public void lostPassword(BODY body,
                         E4CgiParams params)

lostPassword_Go

public void lostPassword_Go(HTML html,
                            E4CgiParams params)
                     throws E4DBException

Throws:

E4DBException

sessionTimedOut

public void sessionTimedOut(HTML html,
                            E4CgiParams params)
                     throws java.lang.Exception

Throws:

java.lang.Exception

initRedirectionFile

public static void initRedirectionFile()
                                throws java.lang.Exception

Throws:

java.lang.Exception

getSessionTimeoutMethod

public static E4Method getSessionTimeoutMethod()

Get the session-timeout function which is called when a session was terminated.

Returns:

the method

See Also:

sessionTimedOut, setSessionTimeoutMethod(e4s.html.E4Method), getStartupMethod()

setSessionTimeoutMethod

public static void setSessionTimeoutMethod(E4Method mref)

Set the session-timeout function which is called when a session was terminated. A value of null indicates that the default method sessionTimedOut shall be used.

Parameters:

mref - the method or null to use default

See Also:

sessionTimedOut, getSessionTimeoutMethod(), setStartupMethod(e4s.html.E4Method)

changePassword

public void changePassword(HTML html)
                    throws java.lang.Exception

Throws:

java.lang.Exception

changePassword_Save

public void changePassword_Save(HTML html,
                                E4CgiParams params)
                         throws java.lang.Exception

Throws:

java.lang.Exception

_getSVNVersionString

public static java.lang.String _getSVNVersionString()

Get version info string from subversion.

Returns:

the version info string.

See Also:

E4Util.getRevisionCodeFromSVN(Class)