Package org.opencms.workplace
Class CmsLoginUserAgreement
- java.lang.Object
-
- org.opencms.workplace.CmsWorkplace
-
- org.opencms.workplace.tools.CmsToolDialog
-
- org.opencms.workplace.CmsDialog
-
- org.opencms.workplace.CmsLoginUserAgreement
-
- Direct Known Subclasses:
CmsLoginController.UserAgreementHelper
public class CmsLoginUserAgreement extends CmsDialog
Provides methods to show a configurable user agreement dialog after a successful workplace login.- Since:
- 8.0
-
-
Field Summary
Fields Modifier and Type Field Description 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.-
Fields inherited from class 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_ACTION_VALUE_FOR_CHANGED_INDEX, 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
-
Fields inherited from class org.opencms.workplace.tools.CmsToolDialog
PARAM_ADMIN_PROJECT, PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW
-
Fields inherited from class org.opencms.workplace.CmsWorkplace
DEBUG, DEFAULT_DATE_STRING, 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, INPUT_DEFAULT, INPUT_NONE, JSP_WORKPLACE_URI, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PARAM_WP_START, PARAM_WP_VIEW, 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_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE
-
-
Constructor Summary
Constructors Constructor Description CmsLoginUserAgreement(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables.CmsLoginUserAgreement(CmsJspActionElement jsp)
Public constructor with JSP action element.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
initAcceptData()
Initializes the 'accepted' data from the current user.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.-
Methods inherited from class org.opencms.workplace.CmsDialog
actionCloseDialog, appendDelimiter, buildAjaxResultContainer, buildAjaxWaitMessage, buildLockAdditionalOptions, buildLockConfirmationMessageJS, 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, openLaunchpad, openWorkplaceLink, pageHtml, pageHtml, setAction, setOnlineHelpUriCustom, setParamAction, setParamCloseLink, setParamDialogtype, setParamFramename, setParamIsPopup, setParamMessage, setParamOriginalParams, setParamPreActionDone, setParamRedirect, setParamResource, setParamTitle
-
Methods inherited from class 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
-
Methods inherited from class 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, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, initMessages, initSettings, initTimeWarp, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences
-
-
-
-
Field Detail
-
ACTION_ACCEPT
public static final int ACTION_ACCEPT
Value for the action: accept the user agreement.- See Also:
- Constant Field Values
-
DIALOG_TYPE
public static final java.lang.String DIALOG_TYPE
The dialog type.- See Also:
- Constant Field Values
-
NODE_MESSAGE_DECLINED
public static final java.lang.String NODE_MESSAGE_DECLINED
Node name for the element: MessageDeclined.- See Also:
- Constant Field Values
-
NODE_TEXT
public static final java.lang.String NODE_TEXT
Node name for the element: Text.- See Also:
- Constant Field Values
-
PARAM_WPRES
public static final java.lang.String PARAM_WPRES
Request parameter name for the originally requested resource.- See Also:
- Constant Field Values
-
KEY_ACCEPTED_COUNT
protected static final java.lang.String KEY_ACCEPTED_COUNT
JSON key name to store the count of the accepted agreement.- See Also:
- Constant Field Values
-
KEY_ACCEPTED_VERSION
protected static final java.lang.String KEY_ACCEPTED_VERSION
JSON key name to store the version of the accepted agreement.- See Also:
- Constant Field Values
-
NODE_AGREE_COUNT
protected static final java.lang.String NODE_AGREE_COUNT
Node name for the element: AgreeCount.- See Also:
- Constant Field Values
-
NODE_BUTTON_ACCEPT
protected static final java.lang.String NODE_BUTTON_ACCEPT
Node name for the element: ButtonAccept.- See Also:
- Constant Field Values
-
NODE_BUTTON_DECLINE
protected static final java.lang.String NODE_BUTTON_DECLINE
Node name for the element: ButtonDecline.- See Also:
- Constant Field Values
-
NODE_DIALOG_TITLE
protected static final java.lang.String NODE_DIALOG_TITLE
Node name for the element: DialogTitle.- See Also:
- Constant Field Values
-
NODE_VERSION
protected static final java.lang.String NODE_VERSION
Node name for the element: Version.- See Also:
- Constant Field Values
-
VFS_PATH_CONFIGFOLDER
protected static final java.lang.String VFS_PATH_CONFIGFOLDER
The VFS path to the folder containing the user agreement configuration files.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsLoginUserAgreement
public CmsLoginUserAgreement(CmsJspActionElement jsp)
Public constructor with JSP action element.- Parameters:
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.- Parameters:
context
- the JSP page contextreq
- the JSP requestres
- the JSP response
-
-
Method Detail
-
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.- Throws:
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.- Throws:
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()
- Overrides:
dialogScriptSubmit
in classCmsDialog
- Returns:
- the standard JavaScript for submitting the dialog
-
getAcceptedCount
public int getAcceptedCount()
Returns the number of times the user accepted the agreement.- Returns:
- the number of times the user accepted the agreement
-
getAcceptedVersion
public double getAcceptedVersion()
Returns the version of the user accepted agreement.- Returns:
- 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.- Parameters:
path
- the path to get the content value for- Returns:
- the content value of the given path as String
-
getConfigurationVfsPath
public java.lang.String getConfigurationVfsPath()
Returns the absolute path in the OpenCms VFS to the user agreement configuration file.- Returns:
- the absolute path in the OpenCms VFS to the user agreement configuration file
-
getParamWpres
public java.lang.String getParamWpres()
Returns the originally requested workplace resource path parameter.- Returns:
- the originally requested workplace resource path parameter
-
getRequiredVersion
public double getRequiredVersion()
Returns the required version of the user accepted agreement.- Returns:
- 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.- Returns:
true
if the user agreement page should be shown for the current user, otherwisefalse
-
setAcceptedCount
public void setAcceptedCount(int acceptedCount)
Sets the number of times the user accepted the agreement.- Parameters:
acceptedCount
- the number of times the user accepted the agreement
-
setAcceptedVersion
public void setAcceptedVersion(double acceptedVersion)
Sets the version of the user accepted agreement.- Parameters:
acceptedVersion
- the version of the user accepted agreement
-
setParamWpres
public void setParamWpres(java.lang.String paramWpres)
Sets the originally requested workplace resource path parameter.- Parameters:
paramWpres
- the originally requested workplace resource path parameter
-
setRequiredVersion
public void setRequiredVersion(double requiredVersion)
Sets the required version of the user accepted agreement.- Parameters:
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)
- Overrides:
dialogButtonsHtml
in classCmsDialog
- Parameters:
result
- a string buffer where the rendered HTML gets appended tobutton
- a integer key to identify the buttonattribute
- an optional string with possible tag attributes, or null
-
getConfigurationContent
protected CmsXmlContent getConfigurationContent()
Returns the user agreement configuration content.- Returns:
- the user agreement configuration content
-
initAcceptData
protected void initAcceptData()
Initializes the 'accepted' data from the current user.Returns the absolute path in the OpenCms VFS to the user agreement configuration file.
-
initWorkplaceRequestValues
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
Description copied from class:CmsWorkplace
Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.- Overrides:
initWorkplaceRequestValues
in classCmsDialog
- Parameters:
settings
- the workplace settingsrequest
- the current request- See Also:
CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
-
-