Class LoginFormBean
- java.lang.Object
-
- net.sf.basedb.clients.web.extensions.login.LoginFormBean
-
- All Implemented Interfaces:
LoginFormAction
,Action
public class LoginFormBean extends Object implements LoginFormAction
A simple implementation of theLoginFormAction
interface.- Since:
- 3.3
- Author:
- Nicklas
-
-
Field Summary
Fields Modifier and Type Field Description private String
displayName
private FieldInfo
extraField
private String
help
private String
id
private FieldInfo
loginField
private FieldInfo
passwordField
private boolean
rememberLastLogin
-
Constructor Summary
Constructors Constructor Description LoginFormBean()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDisplayName()
Get a name that can be displayed for users in a selection list or similar to switch between different login methods.FieldInfo
getExtraField()
An optional extra field on the login form.String
getHelp()
Optional help text that is displayed on the login form to aid the user when logging in.String
getId()
Get the ID of this login form.FieldInfo
getLoginField()
Get attributes for the login field on the form.FieldInfo
getPasswordField()
Get attributes for the password field on the form.boolean
rememberLastLogin()
If TRUE, the browser is asked to remember the last login used.void
setDisplayName(String displayName)
void
setExtraField(FieldInfo extraField)
void
setHelp(String help)
void
setId(String id)
void
setLoginField(FieldInfo loginField)
void
setPasswordField(FieldInfo passwordField)
void
setRememberLastLogin(boolean remember)
-
-
-
Method Detail
-
getId
public String getId()
Description copied from interface:LoginFormAction
Get the ID of this login form. It's main use it to enable support for multiple installed authentication managers. Clients that supports this should submit the id of the login form via the "login-form"LoginRequest
attribute. Authentication managers should check this id before determining if they should handle the login request or not. Since this is a new method in BASE 3.14 a default implementation that returns null is provided for backwards compatibility. If this method returns null, the id from the extension is used instead.- Specified by:
getId
in interfaceLoginFormAction
-
setId
public void setId(String id)
-
getDisplayName
public String getDisplayName()
Description copied from interface:LoginFormAction
Get a name that can be displayed for users in a selection list or similar to switch between different login methods. Since this is a new method in BASE 3.14 a default implementation that returns null is provided for backwards compatibility. If this method returns null, the name from the extension is used instead.- Specified by:
getDisplayName
in interfaceLoginFormAction
-
setDisplayName
public void setDisplayName(String displayName)
-
getHelp
public String getHelp()
Description copied from interface:LoginFormAction
Optional help text that is displayed on the login form to aid the user when logging in.- Specified by:
getHelp
in interfaceLoginFormAction
-
setHelp
public void setHelp(String help)
-
getLoginField
public FieldInfo getLoginField()
Description copied from interface:LoginFormAction
Get attributes for the login field on the form.- Specified by:
getLoginField
in interfaceLoginFormAction
-
setLoginField
public void setLoginField(FieldInfo loginField)
-
getPasswordField
public FieldInfo getPasswordField()
Description copied from interface:LoginFormAction
Get attributes for the password field on the form.- Specified by:
getPasswordField
in interfaceLoginFormAction
-
setPasswordField
public void setPasswordField(FieldInfo passwordField)
-
getExtraField
public FieldInfo getExtraField()
Description copied from interface:LoginFormAction
An optional extra field on the login form. A default implementation that returns null is provided by this interface to provide backwards compatibility.- Specified by:
getExtraField
in interfaceLoginFormAction
-
setExtraField
public void setExtraField(FieldInfo extraField)
-
rememberLastLogin
public boolean rememberLastLogin()
Description copied from interface:LoginFormAction
If TRUE, the browser is asked to remember the last login used.- Specified by:
rememberLastLogin
in interfaceLoginFormAction
-
setRememberLastLogin
public void setRememberLastLogin(boolean remember)
-
-