org.opencms.jsp

Class CmsJspLoginBean

java.lang.Object

org.opencms.jsp.CmsJspBean

org.opencms.jsp.CmsJspActionElement

org.opencms.jsp.CmsJspLoginBean

Direct Known Subclasses:

CmsJspLoginPersistingBean, CmsLoginHelper

public class CmsJspLoginBean
extends CmsJspActionElement

Provides convenient wrappers useful to create user login pages.

Initialize this bean at the beginning of your JSP like this:

 <jsp:useBean id="cmslogin" class="org.opencms.jsp.CmsJspLoginBean">
 <% cmslogin.init(pageContext, request, response); %>
 </jsp:useBean>
 

Since:

6.0.0

Field Summary

Fields inherited from class org.opencms.jsp.CmsJspActionElement

NOT_INITIALIZED

Constructor Summary

Constructors

Constructor and Description
CmsJspLoginBean() Empty constructor, required for every JavaBean.
CmsJspLoginBean(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Constructor, with parameters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormLink() Returns the link to the form that contains the login element.
CmsException	getLoginException() Returns the exception that was thrown after login, or null if no Exception was thrown (i.e.
CmsUser	getUser() Returns the currently logged in user.
java.lang.String	getUserName() Returns the user name of the currently logged in user.
boolean	isLoggedIn() Returns true if the current user is not the guest user, i.e.
boolean	isLoginSuccess() Indicates if a login was successful or not.
void	login(java.lang.String userName, java.lang.String password) Logs a system user in to OpenCms.
void	login(java.lang.String userName, java.lang.String password, java.lang.String projectName) Logs a system user into OpenCms.
void	login(java.lang.String userName, java.lang.String password, java.lang.String projectName, java.lang.String redirectUri) Logs a system user in to OpenCms.
static void	logLoginException(CmsRequestContext requestContext, java.lang.String userName, CmsException currentLoginException)
void	logout() Logs a user out, i.e.

Methods inherited from class org.opencms.jsp.CmsJspActionElement

editable, editable, editable, editableManualClose, editableManualOpen, getContent, getContent, getMessages, getMessages, getMessages, getMessages, getNavigation, getNavigationUri, img, img, include, include, include, include, include, include, includeSilent, includeSilent, includeSilent, includeSilent, info, label, link, link, properties, properties, property, property, property, property, template, template, template, toAbsolute, user

Methods inherited from class org.opencms.jsp.CmsJspBean

getCmsObject, getController, getJspContext, getMessage, getRequest, getRequestContext, getResponse, handleException, handleMissingFlexController, init, isNotInitialized, isSupressingExceptions, setContentType, setStatus, setSupressingExceptions

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsJspLoginBean

public CmsJspLoginBean()

Empty constructor, required for every JavaBean.

CmsJspLoginBean

public CmsJspLoginBean(javax.servlet.jsp.PageContext context,
                       javax.servlet.http.HttpServletRequest req,
                       javax.servlet.http.HttpServletResponse res)

Constructor, with parameters.

Parameters:

context - the JSP page context object

req - the JSP request

res - the JSP response

Method Detail

logLoginException

public static void logLoginException(CmsRequestContext requestContext,
                                     java.lang.String userName,
                                     CmsException currentLoginException)

getFormLink

public java.lang.String getFormLink()

Returns the link to the form that contains the login element.

Returns:

the link to the form that contains the login element

getLoginException

public CmsException getLoginException()

Returns the exception that was thrown after login, or null if no Exception was thrown (i.e. login was successful or not attempted).

Returns:

the exception thrown after login

getUser

public CmsUser getUser()

Returns the currently logged in user.

Returns:

the currently logged in user

getUserName

public java.lang.String getUserName()

Returns the user name of the currently logged in user.

Returns:

the user name of the currently logged in user

isLoggedIn

public boolean isLoggedIn()

Returns true if the current user is not the guest user, i.e. if he already has logged in with some other user account.

Returns:

true if the current user is already logged in

isLoginSuccess

public boolean isLoginSuccess()

Indicates if a login was successful or not.

Returns:

true if the login was successful

login

public void login(java.lang.String userName,
                  java.lang.String password)

Logs a system user in to OpenCms.

Parameters:

userName - the users name

password - the password

login

public void login(java.lang.String userName,
                  java.lang.String password,
                  java.lang.String projectName)

Logs a system user into OpenCms.

Note that if a login project name is provided, this project must exist, otherwise the login is regarded as a failure even if the user data was correct.

Parameters:

userName - the users name

password - the password

projectName - the project to switch to after login (if null project is not switched)

login

public void login(java.lang.String userName,
                  java.lang.String password,
                  java.lang.String projectName,
                  java.lang.String redirectUri)
           throws java.io.IOException

Logs a system user in to OpenCms.

Note that if a login project name is provided, this project must exist, otherwise the login is regarded as a failure even if the user data was correct.

Parameters:

userName - the users name

password - the password

projectName - the project to switch to after login (if null project is not switched)

redirectUri - the URI to redirect to after login (if null the current URI is used)

Throws:

java.io.IOException - in case redirect after login was not successful

logout

public void logout()
            throws java.io.IOException

Logs a user out, i.e. destroys the current users session, after that the current page will be redirected to itself one time to ensure that the users session is truly destroyed.

Throws:

java.io.IOException - if redirect after logout fails