Package org.opencms.workplace.commons
Class CmsSecure
- java.lang.Object
-
- org.opencms.workplace.CmsWorkplace
-
- org.opencms.workplace.tools.CmsToolDialog
-
- org.opencms.workplace.CmsDialog
-
- org.opencms.workplace.commons.CmsSecure
-
public class CmsSecure extends org.opencms.workplace.CmsDialog
Provides methods for building the security and export settings dialog.The following files use this class:
- /commons/secure.jsp
- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description static int
ACTION_CHSECEXP
Value for the action: change the security and export setting.static java.lang.String
DIALOG_TYPE
The dialog type.-
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 CmsSecure(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables.CmsSecure(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
actionChangeSecureExport()
Performs the Security and Export Change.java.lang.String
buildRadio(java.lang.String propName)
Builds the radio input to set the export and secure property.boolean
exportUserHasReadPermission()
Returns true if the export user has read permission on a specified resource.java.lang.String
getParamExport()
Returns the value of the export parameter.java.lang.String
getParamExportname()
Returns the value of the export name parameter.java.lang.String
getParamIntern()
Returns the value of the intern parameter.java.lang.String
getParamSecure()
Returns the value of the secure parameter.java.lang.String
getPropertyInheritanceInfo(java.lang.String propName)
Returns the information from which the property is inherited.java.lang.String
getResourceUrl()
Returns the path under which the resource is accessible.protected void
initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
java.lang.String
readInternProp()
Returns value of the the intern property of the resource.java.lang.String
readProperty(java.lang.String propertyName)
Returns value of the property of the resource.boolean
resourceIsFolder()
returns if the resource to be changed is a folder.void
setParamExport(java.lang.String value)
Sets the value of the export parameter.void
setParamExportname(java.lang.String value)
Sets the value of the export name parameter.void
setParamIntern(java.lang.String value)
Sets the value of the intern parameter.void
setParamSecure(java.lang.String value)
Sets the value of the secure parameter.boolean
showExportSettings()
Determines whether to show the export settings dialog depending on the users settings.protected void
writeProperty(java.lang.String propertyName, java.lang.String propertyValue)
Writes a property value for a resource.-
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, dialogButtonsHtml, dialogButtonsOk, dialogButtonsOk, dialogButtonsOkCancel, dialogButtonsOkCancel, dialogButtonsOkCancelAdvanced, dialogButtonsSetOkCancel, dialogContent, dialogContentEnd, dialogContentStart, dialogEnd, dialogHead, dialogHorizontalSpacer, dialogLockButtons, dialogRow, dialogRowEnd, dialogRowStart, dialogScriptSubmit, 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_CHSECEXP
public static final int ACTION_CHSECEXP
Value for the action: change the security and export setting.- See Also:
- Constant Field Values
-
DIALOG_TYPE
public static final java.lang.String DIALOG_TYPE
The dialog type.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsSecure
public CmsSecure(org.opencms.jsp.CmsJspActionElement jsp)
Public constructor.- Parameters:
jsp
- an initialized JSP action element
-
CmsSecure
public CmsSecure(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
-
actionChangeSecureExport
public void actionChangeSecureExport() throws javax.servlet.jsp.JspException
Performs the Security and Export Change.- Throws:
javax.servlet.jsp.JspException
- if including a JSP sub element is not successful
-
buildRadio
public java.lang.String buildRadio(java.lang.String propName) throws org.opencms.main.CmsException
Builds the radio input to set the export and secure property.- Parameters:
propName
- the name of the property to build the radio input for- Returns:
- html for the radio input
- Throws:
org.opencms.main.CmsException
- if the reading of a property fails
-
getParamExport
public java.lang.String getParamExport()
Returns the value of the export parameter.- Returns:
- the value of the export parameter
-
getParamExportname
public java.lang.String getParamExportname()
Returns the value of the export name parameter.- Returns:
- the value of the export name parameter
-
getParamIntern
public java.lang.String getParamIntern()
Returns the value of the intern parameter.- Returns:
- the value of the intern parameter
-
getParamSecure
public java.lang.String getParamSecure()
Returns the value of the secure parameter.- Returns:
- the value of the secure parameter
-
getPropertyInheritanceInfo
public java.lang.String getPropertyInheritanceInfo(java.lang.String propName) throws org.opencms.main.CmsException
Returns the information from which the property is inherited.- Parameters:
propName
- the name of the property- Returns:
- a String containing the information from which the property is inherited and inherited value
- Throws:
org.opencms.main.CmsException
- if the reading of the Property fails
-
getResourceUrl
public java.lang.String getResourceUrl()
Returns the path under which the resource is accessible.- Returns:
- the path under which the resource is accessible
-
exportUserHasReadPermission
public boolean exportUserHasReadPermission()
Returns true if the export user has read permission on a specified resource.- Returns:
- true, if the export user has the permission to read the resource
-
readInternProp
public java.lang.String readInternProp()
Returns value of the the intern property of the resource.- Returns:
- the value of the intern property of the resource
-
readProperty
public java.lang.String readProperty(java.lang.String propertyName)
Returns value of the property of the resource.- Parameters:
propertyName
- the name of the property to read- Returns:
- the value of the secure property of the resource
-
resourceIsFolder
public boolean resourceIsFolder() throws org.opencms.main.CmsException
returns if the resource to be changed is a folder.- Returns:
- true if the resource is a folder
- Throws:
org.opencms.main.CmsException
- if the reading of the resource fails
-
setParamExport
public void setParamExport(java.lang.String value)
Sets the value of the export parameter.- Parameters:
value
- for the export parameter
-
setParamExportname
public void setParamExportname(java.lang.String value)
Sets the value of the export name parameter.- Parameters:
value
- for the export name parameter
-
setParamIntern
public void setParamIntern(java.lang.String value)
Sets the value of the intern parameter.- Parameters:
value
- for the intern parameter
-
setParamSecure
public void setParamSecure(java.lang.String value)
Sets the value of the secure parameter.- Parameters:
value
- for the secure parameter
-
showExportSettings
public boolean showExportSettings()
Determines whether to show the export settings dialog depending on the users settings.- Returns:
- true if dialogs should be shown, otherwise false
-
initWorkplaceRequestValues
protected void initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
- Overrides:
initWorkplaceRequestValues
in classorg.opencms.workplace.CmsDialog
- See Also:
CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
-
writeProperty
protected void writeProperty(java.lang.String propertyName, java.lang.String propertyValue) throws org.opencms.main.CmsException
Writes a property value for a resource.- Parameters:
propertyName
- the name of the propertypropertyValue
- the new value of the property- Throws:
org.opencms.main.CmsException
- if something goes wrong
-
-