org.opencms.ui.login

Class CmsLoginController

java.lang.Object

org.opencms.ui.login.CmsLoginController

public class CmsLoginController
extends java.lang.Object

Controller class which actually handles the login dialog logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmsLoginController.CmsLoginTargetInfo Represents the login target information.
protected static class	CmsLoginController.UserAgreementHelper Helper subclass of CmsLoginUserAgreement which can be used without a page context.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_ACCOUNT_LOCKED Additional info key to mark accounts as locked due to inactivity.

Constructor Summary

Constructors

Constructor and Description
CmsLoginController(CmsObject adminCms, CmsLoginHelper.LoginParameters params) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getFormLink(CmsObject cms) Returns the link to the login form.
static java.lang.String	getLoginTarget(CmsObject currentCms, CmsWorkplaceSettings settings, java.lang.String requestedResource) Gets the login target link.
java.lang.String	getPcType() Gets the PC type.
java.lang.String	getResetPasswordLink() Returns the reset password link.
boolean	isShowSecure() Returns true if the security option should be displayed in the login dialog.
static void	logout() Logs the current user out by invalidating the session an reloading the current URI.
static void	logout(CmsObject cms, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Logs out the current user redirecting to the login form afterwards.
void	onClickForgotPassword() Called when the user clicks on the 'forgot password' button.
void	onClickLogin() Called when the user clicks on the login button.
void	onInit() Called on initialization.
void	setUi(I_CmsLoginUI ui) Sets the login ui reference.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_ACCOUNT_LOCKED

public static final java.lang.String KEY_ACCOUNT_LOCKED

Additional info key to mark accounts as locked due to inactivity.

See Also:

Constant Field Values

Constructor Detail

CmsLoginController

public CmsLoginController(CmsObject adminCms,
                  CmsLoginHelper.LoginParameters params)

Creates a new instance.

Parameters:

adminCms - the admin cms context

params - the parameters for the UI

Method Detail

getFormLink

public static java.lang.String getFormLink(CmsObject cms)

Returns the link to the login form.

Parameters:

cms - the current cms context

Returns:

the login form link

getLoginTarget

public static java.lang.String getLoginTarget(CmsObject currentCms,
                              CmsWorkplaceSettings settings,
                              java.lang.String requestedResource)
                                       throws CmsException

Gets the login target link.

Parameters:

currentCms - the current CMS context

settings - the workplace settings

requestedResource - the requested resource parameter

Returns:

the login target

Throws:

CmsException - in case the user has insufficient permissions to access the login target

getPcType

public java.lang.String getPcType()

Gets the PC type.

Returns:

the PC type

getResetPasswordLink

public java.lang.String getResetPasswordLink()

Returns the reset password link.

Returns:

the reset password link

isShowSecure

public boolean isShowSecure()

Returns true if the security option should be displayed in the login dialog.

Returns:

true if the security option should be displayed in the login dialog

logout

public static void logout()

Logs the current user out by invalidating the session an reloading the current URI.

Important: This works only within vaadin apps.

logout

public static void logout(CmsObject cms,
          javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response)
                   throws java.io.IOException

Logs out the current user redirecting to the login form afterwards.

Parameters:

cms - the cms context

request - the servlet request

response - the servlet response

Throws:

java.io.IOException - if writing to the response fails

onClickForgotPassword

public void onClickForgotPassword()

Called when the user clicks on the 'forgot password' button.

onClickLogin

public void onClickLogin()

Called when the user clicks on the login button.

onInit

public void onInit()

Called on initialization.

setUi

public void setUi(I_CmsLoginUI ui)

Sets the login ui reference.

Parameters:

ui - the login ui