org.opencms.workplace

类 CmsLoginUserAgreement

java.lang.Object

org.opencms.workplace.CmsWorkplace

org.opencms.workplace.tools.CmsToolDialog

org.opencms.workplace.CmsDialog

org.opencms.workplace.CmsLoginUserAgreement

public class CmsLoginUserAgreement
extends CmsDialog

Provides methods to show a configurable user agreement dialog after a successful workplace login.

从以下版本开始:

8.0

字段概要

字段

限定符和类型	字段和说明
static int	ACTION_ACCEPT Value for the action: accept the user agreement.
static java.lang.String	DIALOG_TYPE The dialog type.
protected static java.lang.String	KEY_ACCEPTED_COUNT JSON key name to store the count of the accepted agreement.
protected static java.lang.String	KEY_ACCEPTED_VERSION JSON key name to store the version of the accepted agreement.
protected static java.lang.String	NODE_AGREE_COUNT Node name for the element: AgreeCount.
protected static java.lang.String	NODE_BUTTON_ACCEPT Node name for the element: ButtonAccept.
protected static java.lang.String	NODE_BUTTON_DECLINE Node name for the element: ButtonDecline.
protected static java.lang.String	NODE_DIALOG_TITLE Node name for the element: DialogTitle.
static java.lang.String	NODE_MESSAGE_DECLINED Node name for the element: MessageDeclined.
static java.lang.String	NODE_TEXT Node name for the element: Text.
protected static java.lang.String	NODE_VERSION Node name for the element: Version.
static java.lang.String	PARAM_WPRES Request parameter name for the originally requested resource.
protected static java.lang.String	VFS_PATH_CONFIGFOLDER The VFS path to the folder containing the user agreement configuration files.

从类继承的字段 org.opencms.workplace.CmsDialog

ACTION_CANCEL, ACTION_CLOSEPOPUP, ACTION_CLOSEPOPUP_SAVE, ACTION_CONFIRMED, ACTION_CONTINUE, ACTION_DEFAULT, ACTION_LOCKS_CONFIRMED, ACTION_OK, ACTION_REPORT_BEGIN, ACTION_REPORT_END, ACTION_REPORT_UPDATE, ACTION_SET, ACTION_WAIT, ATTRIBUTE_THROWABLE, BUTTON_ADVANCED, BUTTON_BACK, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_CONTINUE, BUTTON_DETAILS, BUTTON_DISCARD, BUTTON_EDIT, BUTTON_OK, BUTTON_OK_NO_SUBMIT, BUTTON_SET, DIALOG_BACK, DIALOG_CANCEL, DIALOG_CONFIRMED, DIALOG_CONTINUE, DIALOG_INITIAL, DIALOG_LOCKS_CONFIRMED, DIALOG_OK, DIALOG_SET, DIALOG_WAIT, PARAM_ACTION, PARAM_CLOSELINK, PARAM_DIALOGTYPE, PARAM_ERRORSTACK, PARAM_FILE, PARAM_FRAMENAME, PARAM_ISPOPUP, PARAM_LOCK, PARAM_MESSAGE, PARAM_ORIGINALPARAMS, PARAM_PREACTIONDONE, PARAM_REDIRECT, PARAM_RESOURCE, PARAM_TARGET, PARAM_THREAD, PARAM_THREAD_HASNEXT, PARAM_TITLE, REPORT_BEGIN, REPORT_END, REPORT_UPDATE

从类继承的字段 org.opencms.workplace.tools.CmsToolDialog

PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW

从类继承的字段 org.opencms.workplace.CmsWorkplace

DEBUG, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_DIRECT_EDIT, VIEW_WORKPLACE

构造器概要

构造器

构造器和说明
CmsLoginUserAgreement(CmsJspActionElement jsp) Public constructor with JSP action element.
CmsLoginUserAgreement(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Public constructor with JSP variables.

方法概要

方法

限定符和类型	方法和说明
void	acceptAgreement() Stores the information about the accepted user agreement in the current users additional info.
void	actionAccept() Performs the the user agreement accept action, will be called by the JSP page.
void	actionDecline() Performs the user agreement declined action, will be called by the JSP page.
protected void	dialogButtonsHtml(java.lang.StringBuffer result, int button, java.lang.String attribute) The standard "OK" and "Cancel" buttons are overridden to show other labels.
java.lang.String	dialogScriptSubmit() The standard JavaScript for submitting the dialog is overridden to show an alert in case that an agreement is declined.
int	getAcceptedCount() Returns the number of times the user accepted the agreement.
double	getAcceptedVersion() Returns the version of the user accepted agreement.
protected CmsXmlContent	getConfigurationContent() Returns the user agreement configuration content.
java.lang.String	getConfigurationContentStringValue(java.lang.String path) Returns the content value of the given path as String.
java.lang.String	getConfigurationVfsPath() Returns the absolute path in the OpenCms VFS to the user agreement configuration file.
java.lang.String	getParamWpres() Returns the originally requested workplace resource path parameter.
double	getRequiredVersion() Returns the required version of the user accepted agreement.
protected void	initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
boolean	isShowUserAgreement() Returns if the user agreement page should be shown for the current user.
void	setAcceptedCount(int acceptedCount) Sets the number of times the user accepted the agreement.
void	setAcceptedVersion(double acceptedVersion) Sets the version of the user accepted agreement.
void	setParamWpres(java.lang.String paramWpres) Sets the originally requested workplace resource path parameter.
void	setRequiredVersion(double requiredVersion) Sets the required version of the user accepted agreement.

从类继承的方法 org.opencms.workplace.CmsDialog

actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, buildLockDialog, buildLockDialog, buildLockHeaderBox, checkResourcePermissions, checkResourcePermissions, computeCurrentFolder, dialog, dialogBlock, dialogBlockEnd, dialogBlockStart, dialogButtonRow, dialogButtonRowEnd, dialogButtonRowStart, dialogButtons, dialogButtonsClose, dialogButtonsClose, dialogButtonsCloseDetails, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogSeparator, dialogSpacer, dialogStart, dialogStart, dialogSubheadline, dialogToggleStart, dialogWhiteBox, dialogWhiteBoxEnd, dialogWhiteBoxStart, getAction, getAdministrationBackLink, getCancelAction, getDialogRealUri, getDialogUri, getOnlineHelpUriCustom, getParamAction, getParamCloseLink, getParamDialogtype, getParamFramename, getParamIsPopup, getParamMessage, getParamOriginalParams, getParamPreActionDone, getParamRedirect, getParamResource, getParamTitle, getState, hasCorrectLockstate, hasSiblings, htmlStart, htmlStart, htmlStart, htmlStartStyle, includeErrorpage, initCmsDialog, isPopup, isPreEditor, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle

从类继承的方法 org.opencms.workplace.tools.CmsToolDialog

computeUpLevelLink, dialogTitle, getAdminTool, getCurrentToolPath, getParamBase, getParamForce, getParamPath, getParamRoot, getParamStyle, getParentPath, getToolManager, iconsBlockArea, iconsBlockAreaEnd, iconsBlockAreaStart, initAdminTool, pageBody, pageHtmlStyle, setParamBase, setParamForce, setParamPath, setParamRoot, setParamStyle, useNewStyle

从类继承的方法 org.opencms.workplace.CmsWorkplace

addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

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

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

字段详细资料

ACTION_ACCEPT

public static final int ACTION_ACCEPT

Value for the action: accept the user agreement.

另请参阅:

常量字段值

DIALOG_TYPE

public static final java.lang.String DIALOG_TYPE

The dialog type.

另请参阅:

常量字段值

NODE_MESSAGE_DECLINED

public static final java.lang.String NODE_MESSAGE_DECLINED

Node name for the element: MessageDeclined.

另请参阅:

常量字段值

NODE_TEXT

public static final java.lang.String NODE_TEXT

Node name for the element: Text.

另请参阅:

常量字段值

PARAM_WPRES

public static final java.lang.String PARAM_WPRES

Request parameter name for the originally requested resource.

另请参阅:

常量字段值

KEY_ACCEPTED_COUNT

protected static final java.lang.String KEY_ACCEPTED_COUNT

JSON key name to store the count of the accepted agreement.

另请参阅:

常量字段值

KEY_ACCEPTED_VERSION

protected static final java.lang.String KEY_ACCEPTED_VERSION

JSON key name to store the version of the accepted agreement.

另请参阅:

常量字段值

NODE_AGREE_COUNT

protected static final java.lang.String NODE_AGREE_COUNT

Node name for the element: AgreeCount.

另请参阅:

常量字段值

NODE_BUTTON_ACCEPT

protected static final java.lang.String NODE_BUTTON_ACCEPT

Node name for the element: ButtonAccept.

另请参阅:

常量字段值

NODE_BUTTON_DECLINE

protected static final java.lang.String NODE_BUTTON_DECLINE

Node name for the element: ButtonDecline.

另请参阅:

常量字段值

NODE_DIALOG_TITLE

protected static final java.lang.String NODE_DIALOG_TITLE

Node name for the element: DialogTitle.

另请参阅:

常量字段值

NODE_VERSION

protected static final java.lang.String NODE_VERSION

Node name for the element: Version.

另请参阅:

常量字段值

VFS_PATH_CONFIGFOLDER

protected static final java.lang.String VFS_PATH_CONFIGFOLDER

The VFS path to the folder containing the user agreement configuration files.

另请参阅:

常量字段值

构造器详细资料

CmsLoginUserAgreement

public CmsLoginUserAgreement(CmsJspActionElement jsp)

Public constructor with JSP action element.

参数:

jsp - an initialized JSP action element

CmsLoginUserAgreement

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

Public constructor with JSP variables.

参数:

context - the JSP page context

req - the JSP request

res - the JSP response

方法详细资料

acceptAgreement

public void acceptAgreement()

Stores the information about the accepted user agreement in the current users additional info.

actionAccept

public void actionAccept()
                  throws java.io.IOException

Performs the the user agreement accept action, will be called by the JSP page.

抛出:

java.io.IOException - if problems while redirecting occur

actionDecline

public void actionDecline()
                   throws java.io.IOException

Performs the user agreement declined action, will be called by the JSP page.

抛出:

java.io.IOException - if problems while redirecting occur

dialogScriptSubmit

public java.lang.String dialogScriptSubmit()

The standard JavaScript for submitting the dialog is overridden to show an alert in case that an agreement is declined.

See also CmsDialog.dialogScriptSubmit()

覆盖:

dialogScriptSubmit 在类中 CmsDialog

返回:

the standard JavaScript for submitting the dialog

getAcceptedCount

public int getAcceptedCount()

Returns the number of times the user accepted the agreement.

返回:

the number of times the user accepted the agreement

getAcceptedVersion

public double getAcceptedVersion()

Returns the version of the user accepted agreement.

返回:

the version of the user accepted agreement

getConfigurationContentStringValue

public java.lang.String getConfigurationContentStringValue(java.lang.String path)

Returns the content value of the given path as String.

参数:

path - the path to get the content value for

返回:

the content value of the given path as String

getParamWpres

public java.lang.String getParamWpres()

Returns the originally requested workplace resource path parameter.

返回:

the originally requested workplace resource path parameter

getRequiredVersion

public double getRequiredVersion()

Returns the required version of the user accepted agreement.

返回:

the required version of the user accepted agreement

isShowUserAgreement

public boolean isShowUserAgreement()

Returns if the user agreement page should be shown for the current user.

返回:

true if the user agreement page should be shown for the current user, otherwise false

setAcceptedCount

public void setAcceptedCount(int acceptedCount)

Sets the number of times the user accepted the agreement.

参数:

acceptedCount - the number of times the user accepted the agreement

setAcceptedVersion

public void setAcceptedVersion(double acceptedVersion)

Sets the version of the user accepted agreement.

参数:

acceptedVersion - the version of the user accepted agreement

setParamWpres

public void setParamWpres(java.lang.String paramWpres)

Sets the originally requested workplace resource path parameter.

参数:

paramWpres - the originally requested workplace resource path parameter

setRequiredVersion

public void setRequiredVersion(double requiredVersion)

Sets the required version of the user accepted agreement.

参数:

requiredVersion - the required version of the user accepted agreement

dialogButtonsHtml

protected void dialogButtonsHtml(java.lang.StringBuffer result,
                     int button,
                     java.lang.String attribute)

The standard "OK" and "Cancel" buttons are overridden to show other labels.

See also CmsDialog.dialogButtonsHtml(StringBuffer, int, String)

覆盖:

dialogButtonsHtml 在类中 CmsDialog

参数:

result - a string buffer where the rendered HTML gets appended to

button - a integer key to identify the button

attribute - an optional string with possible tag attributes, or null

getConfigurationContent

protected CmsXmlContent getConfigurationContent()

Returns the user agreement configuration content.

返回:

the user agreement configuration content

getConfigurationVfsPath

public java.lang.String getConfigurationVfsPath()

Returns the absolute path in the OpenCms VFS to the user agreement configuration file.

返回:

the absolute path in the OpenCms VFS to the user agreement configuration file

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                              javax.servlet.http.HttpServletRequest request)

从类复制的说明: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

覆盖:

initWorkplaceRequestValues 在类中 CmsDialog

参数:

settings - the workplace settings

request - the current request

另请参阅:

CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)