org.opencms.workplace

类 CmsLogin

java.lang.Object

org.opencms.jsp.CmsJspBean

org.opencms.jsp.CmsJspActionElement

org.opencms.jsp.CmsJspLoginBean

org.opencms.workplace.CmsLogin

public class CmsLogin
extends CmsJspLoginBean

Handles the login of Users to the OpenCms workplace.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static int	ACTION_DISPLAY Action constant: Default action, display the dialog.
static int	ACTION_LOGIN Action constant: Login successful.
static int	ACTION_LOGOUT Action constant: Logout.
static java.lang.String	PARAM_ACTION_GETOULIST The parameter name for the "getoulist" action.
static java.lang.String	PARAM_ACTION_LOGIN The parameter name for the "login" action.
static java.lang.String	PARAM_ACTION_LOGOUT The parameter name for the "logout" action.
static java.lang.String	PARAM_FORM The html id for the login form.
static java.lang.String	PARAM_OUFQN The parameter name for the organizational unit.
static java.lang.String	PARAM_OUSEARCH The parameter name for the search organizational unit.
static java.lang.String	PARAM_PASSWORD The parameter name for the password.
static java.lang.String	PARAM_PCTYPE The parameter name for the PC type.
static java.lang.String	PARAM_PREDEF_OUFQN The parameter name for the organizational unit.
static java.lang.String	PARAM_USERNAME The parameter name for the user name.
static java.lang.String	PARAM_WPDATA The parameter name for the workplace data.
static java.lang.String	PCTYPE_PRIVATE PC type constant: private PC.
static java.lang.String	PCTYPE_PUBLIC PC type constant: public PC.

从类继承的字段 org.opencms.jsp.CmsJspActionElement

NOT_INITIALIZED

构造器概要

构造器

构造器和说明
CmsLogin(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor for login page.

方法概要

方法

限定符和类型	方法和说明
protected void	appendDefaultLoginScript(java.lang.StringBuffer html, CmsMessageContainer message) Appends the JavaScript for the login screen to the given HTML buffer.
protected void	appendDirectEditOpenerScript(java.lang.StringBuffer html) Appends the JavaScript that opens the Direct Edit window after a successful login to the given HTML buffer.
protected void	appendId(java.lang.StringBuffer html, java.lang.String id) Appends the HTML form name/id code for the given id to the given html.
protected void	appendWorkplaceOpenerScript(java.lang.StringBuffer html, java.lang.String requestedResource, CmsMessageContainer message) Appends the JavaScript that opens the Workplace window after a successful login to the given HTML buffer.
java.lang.String	buildOrgUnitSelector() Returns the HTML code for selecting an organizational unit.
java.lang.String	displayDialog() Returns the HTML for the login dialog in it's current state.
protected java.lang.String	displayLoginForm() Returns the HTML for the login form.
protected javax.servlet.http.Cookie	getCookie(java.lang.String name) Returns the cookie with the given name, if not cookie is found a new one is created.
void	getCookieData() Gets the login info from the cookies.
java.lang.String	getFormLink() Returns the link to the form that contains the login element.
java.lang.String	getJsonOrgUnitList() Returns the available organizational units as JSON array string.
protected java.util.List<CmsOrganizationalUnit>	getOus() Returns all organizational units in the system.
protected java.lang.String	getPreDefOuFqn() Returns the predefined organizational unit fqn.
protected void	setCookie(javax.servlet.http.Cookie cookie, boolean delete) Sets the cookie in the response.
void	setCookieData() Sets the login cookies.

从类继承的方法 org.opencms.jsp.CmsJspLoginBean

getLoginException, getUser, getUserName, isLoggedIn, isLoginSuccess, login, login, login, logout

从类继承的方法 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

从类继承的方法 org.opencms.jsp.CmsJspBean

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

从类继承的方法 java.lang.Object

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

字段详细资料

ACTION_DISPLAY

public static final int ACTION_DISPLAY

Action constant: Default action, display the dialog.

另请参阅:

常量字段值

ACTION_LOGIN

public static final int ACTION_LOGIN

Action constant: Login successful.

另请参阅:

常量字段值

ACTION_LOGOUT

public static final int ACTION_LOGOUT

Action constant: Logout.

另请参阅:

常量字段值

PARAM_ACTION_GETOULIST

public static final java.lang.String PARAM_ACTION_GETOULIST

The parameter name for the "getoulist" action.

另请参阅:

常量字段值

PARAM_ACTION_LOGIN

public static final java.lang.String PARAM_ACTION_LOGIN

The parameter name for the "login" action.

另请参阅:

常量字段值

PARAM_ACTION_LOGOUT

public static final java.lang.String PARAM_ACTION_LOGOUT

The parameter name for the "logout" action.

另请参阅:

常量字段值

PARAM_FORM

public static final java.lang.String PARAM_FORM

The html id for the login form.

另请参阅:

常量字段值

PARAM_OUFQN

public static final java.lang.String PARAM_OUFQN

The parameter name for the organizational unit.

另请参阅:

常量字段值

PARAM_OUSEARCH

public static final java.lang.String PARAM_OUSEARCH

The parameter name for the search organizational unit.

另请参阅:

常量字段值

PARAM_PASSWORD

public static final java.lang.String PARAM_PASSWORD

The parameter name for the password.

另请参阅:

常量字段值

PARAM_PCTYPE

public static final java.lang.String PARAM_PCTYPE

The parameter name for the PC type.

另请参阅:

常量字段值

PARAM_PREDEF_OUFQN

public static final java.lang.String PARAM_PREDEF_OUFQN

The parameter name for the organizational unit.

另请参阅:

常量字段值

PARAM_USERNAME

public static final java.lang.String PARAM_USERNAME

The parameter name for the user name.

另请参阅:

常量字段值

PARAM_WPDATA

public static final java.lang.String PARAM_WPDATA

The parameter name for the workplace data.

另请参阅:

常量字段值

PCTYPE_PRIVATE

public static final java.lang.String PCTYPE_PRIVATE

PC type constant: private PC.

另请参阅:

常量字段值

PCTYPE_PUBLIC

public static final java.lang.String PCTYPE_PUBLIC

PC type constant: public PC.

另请参阅:

常量字段值

构造器详细资料

CmsLogin

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

Public constructor for login page.

参数:

context - the JSP page context object

req - the JSP request

res - the JSP response

方法详细资料

buildOrgUnitSelector

public java.lang.String buildOrgUnitSelector()

Returns the HTML code for selecting an organizational unit.

返回:

the HTML code for selecting an organizational unit

displayDialog

public java.lang.String displayDialog()
                               throws java.io.IOException

Returns the HTML for the login dialog in it's current state.

返回:

the HTML for the login dialog

抛出:

java.io.IOException - in case a redirect fails

getCookieData

public void getCookieData()

Gets the login info from the cookies.

getFormLink

public java.lang.String getFormLink()

从类复制的说明: CmsJspLoginBean

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

覆盖:

getFormLink 在类中 CmsJspLoginBean

返回:

the link to the form that contains the login element

另请参阅:

CmsJspLoginBean.getFormLink()

getJsonOrgUnitList

public java.lang.String getJsonOrgUnitList()

Returns the available organizational units as JSON array string.

返回:

the available organizational units as JSON array string

setCookieData

public void setCookieData()

Sets the login cookies.

appendDefaultLoginScript

protected void appendDefaultLoginScript(java.lang.StringBuffer html,
                            CmsMessageContainer message)

Appends the JavaScript for the login screen to the given HTML buffer.

参数:

html - the HTML buffer to append the script to

message - the message to display after an unsuccessful login

appendDirectEditOpenerScript

protected void appendDirectEditOpenerScript(java.lang.StringBuffer html)

Appends the JavaScript that opens the Direct Edit window after a successful login to the given HTML buffer.

参数:

html - the html buffer to append the script to

appendId

protected void appendId(java.lang.StringBuffer html,
            java.lang.String id)

Appends the HTML form name/id code for the given id to the given html.

参数:

html - the html where to append the id to

id - the id to append

appendWorkplaceOpenerScript

protected void appendWorkplaceOpenerScript(java.lang.StringBuffer html,
                               java.lang.String requestedResource,
                               CmsMessageContainer message)

Appends the JavaScript that opens the Workplace window after a successful login to the given HTML buffer.

参数:

html - the html buffer to append the script to

requestedResource - the requested resource to open in a new window

message - the message to display if the originally requested resource is not available

displayLoginForm

protected java.lang.String displayLoginForm()

Returns the HTML for the login form.

返回:

the HTML for the login form

getCookie

protected javax.servlet.http.Cookie getCookie(java.lang.String name)

Returns the cookie with the given name, if not cookie is found a new one is created.

参数:

name - the name of the cookie

返回:

the cookie

getOus

protected java.util.List<CmsOrganizationalUnit> getOus()

Returns all organizational units in the system.

返回:

a list of CmsOrganizationalUnit objects

getPreDefOuFqn

protected java.lang.String getPreDefOuFqn()

Returns the predefined organizational unit fqn.

This is normally selected by url, and set by the CmsWorkplaceLoginHandler.

返回:

the predefined organizational unit fqn

setCookie

protected void setCookie(javax.servlet.http.Cookie cookie,
             boolean delete)

Sets the cookie in the response.

参数:

cookie - the cookie to set

delete - flag to determine if the cookir should be deleted