|
||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||
java.lang.Objectorg.opencms.workplace.CmsWorkplace
org.opencms.workplace.tools.CmsToolDialog
org.opencms.workplace.CmsDialog
org.opencms.workplace.CmsMultiDialog
org.opencms.workplace.commons.CmsLock
public class CmsLock
Creates the dialogs for locking, unlocking or steal lock operations on a resource.
The following files use this class:
| Field Summary | |
|---|---|
static int |
ACTION_SUBMIT_NOCONFIRMATION
Value for the action: confirmed. |
static java.lang.String |
DIALOG_SUBMIT_NOCONFIRMATION
Request parameter value for the action: submit form without user interaction. |
static java.lang.String |
DIALOG_TYPE_LOCK
The dialog type: lock a resource. |
static java.lang.String |
DIALOG_TYPE_LOCKCHANGE
The dialog type: Steal a lock. |
static java.lang.String |
DIALOG_TYPE_LOCKS
The dialog type: locked subresources. |
static java.lang.String |
DIALOG_TYPE_UNLOCK
The dialog type: unlock a resource. |
static java.lang.String |
PARAM_INCLUDERELATED
Request parameter name for the 'include unpublished related resources' flag. |
static java.lang.String |
PARAM_PROJECT_ID
Request parameter name for the project id. |
static java.lang.String |
PARAM_PUBLISHSIBLINGS
Request parameter name for the publishsiblings parameter. |
static java.lang.String |
PARAM_SHOWOWNLOCKS
Request parameter name for the 'show own locked resources' flag. |
static java.lang.String |
PARAM_SOURCE_DIALOG
Request parameter name for the source dialog uri. |
static java.lang.String |
PARAM_SUBRESOURCES
Request parameter name for the subresources parameter. |
static int |
TYPE_LOCK
Type of the operation which is performed: lock resource. |
static int |
TYPE_LOCKCHANGE
Type of the operation which is performed: steal a lock. |
static int |
TYPE_LOCKS
Type of the operation which is performed: locked subresources. |
static int |
TYPE_UNLOCK
Type of the operation which is performed: unlock resource. |
static java.lang.String |
URI_LOCK_DIALOG
The lock dialog URI. |
static java.lang.String |
URI_LOCKCHANGE_DIALOG
The steal lock dialog URI. |
static java.lang.String |
URI_LOCKS_DIALOG
The locks dialog URI. |
static java.lang.String |
URI_UNLOCK_DIALOG
The unlock dialog URI. |
| Fields inherited from class org.opencms.workplace.CmsMultiDialog |
|---|
DELIMITER_RESOURCES, PARAM_RESOURCELIST |
| Fields inherited from class org.opencms.workplace.tools.CmsToolDialog |
|---|
PARAM_BASE, PARAM_FORCE, PARAM_PATH, PARAM_ROOT, PARAM_STYLE, STYLE_NEW |
| Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler |
|---|
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD |
| Constructor Summary | |
|---|---|
CmsLock()
Default constructor needed for dialog handler implementation. |
|
CmsLock(CmsJspActionElement jsp)
Public constructor. |
|
CmsLock(javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Public constructor with JSP variables. |
|
| Method Summary | |
|---|---|
void |
actionToggleLock()
Performs the lock/unlock operation, will be called by the JSP page. |
void |
addConfigurationParameter(java.lang.String paramName,
java.lang.String paramValue)
Adds a configuration parameter to this parameter configurable class instance. |
java.lang.String |
buildDefaultConfirmationJS()
Returns the html code to build the dialogs default confirmation message js. |
java.lang.String |
buildIncludeJs()
Returns the html code to include the needed js code. |
java.lang.String |
buildLockRequest()
Returns the html code to build the lock request. |
java.lang.String |
buildLockRequest(int hiddenTimeout,
boolean includeRelated)
Returns the html code to build the lock request. |
java.lang.String |
buildReport()
Returns the report of all locked subresources. |
java.lang.String |
dialogButtons()
Builds the necessary button row. |
CmsLockFilter |
getBlockingFilter()
Returns the filter to get all blocking locks. |
java.util.Set |
getBlockingLockedResources()
Returns locked resources that do not belong to the current user. |
int |
getBlockingLocks()
Returns the number of blocking locks. |
java.util.Map |
getConfiguration()
Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured. |
java.lang.String |
getConfirmationMessage(boolean state)
Returns the confirmation message. |
static int |
getDialogAction(CmsObject cms)
Determines if the resource should be locked, unlocked or if the lock should be stolen. |
java.lang.String |
getDialogHandler()
Returns the name of the handler which is used as key for the OpenCms runtime properties. |
java.lang.String |
getDialogUri(java.lang.String resource,
CmsJspActionElement jsp)
Returns the dialog URI in the OpenCms VFS to the dialog selector class. |
java.util.List |
getLockedResources()
Returns all the locked Resources. |
CmsLockFilter |
getNonBlockingFilter()
Returns the filter to get all non blocking locks. |
java.lang.String |
getParamIncluderelated()
Returns the 'include unpublished related resources' parameter value. |
java.lang.String |
getParamProjectid()
Returns the project id parameter value. |
java.lang.String |
getParamShowownlocks()
Returns the 'show own locked resources' parameter value. |
void |
initConfiguration()
Initializes a configuration after all parameters have been added. |
protected void |
initWorkplaceRequestValues(CmsWorkplaceSettings settings,
javax.servlet.http.HttpServletRequest request)
Analyzes the request for workplace parameters and adjusts the workplace settings accordingly. |
protected boolean |
performDialogOperation()
Performs the lock/unlock/steal lock operation. |
protected void |
performSingleResourceOperation(java.lang.String resourceName,
int dialogAction)
Performs the lock state operation on a single resource. |
void |
setBlockingFilter(CmsLockFilter blockingFilter)
Sets the filter to get all blocking locks. |
void |
setNonBlockingFilter(CmsLockFilter nonBlockingFilter)
Sets the filter to get all non blocking locks. |
void |
setParamIncluderelated(java.lang.String paramIncluderelated)
Sets the 'include unpublished related resources' parameter value. |
void |
setParamProjectid(java.lang.String projectid)
Sets the project id parameter value. |
void |
setParamShowownlocks(java.lang.String paramShowownlocks)
Sets the 'show own locked resources' parameter value. |
boolean |
showConfirmation()
Determines whether to show the lock dialog depending on the users settings and the dilaog type. |
| Methods inherited from class org.opencms.workplace.CmsMultiDialog |
|---|
addMultiOperationException, buildLockHeaderBox, buildResourceList, checkMultiOperationException, checkResourcePermissions, getParamResourcelist, getResourceList, getResourceListAsParam, isMultiOperation, isOperationOnFolder, setDialogTitle, setParamResource, setParamResourcelist |
| Methods inherited from class org.opencms.workplace.tools.CmsToolDialog |
|---|
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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int ACTION_SUBMIT_NOCONFIRMATION
public static final java.lang.String DIALOG_SUBMIT_NOCONFIRMATION
public static final java.lang.String DIALOG_TYPE_LOCK
public static final java.lang.String DIALOG_TYPE_LOCKCHANGE
public static final java.lang.String DIALOG_TYPE_LOCKS
public static final java.lang.String DIALOG_TYPE_UNLOCK
public static final java.lang.String PARAM_INCLUDERELATED
public static final java.lang.String PARAM_PROJECT_ID
public static final java.lang.String PARAM_PUBLISHSIBLINGS
public static final java.lang.String PARAM_SHOWOWNLOCKS
public static final java.lang.String PARAM_SOURCE_DIALOG
public static final java.lang.String PARAM_SUBRESOURCES
public static final int TYPE_LOCK
public static final int TYPE_LOCKCHANGE
public static final int TYPE_LOCKS
public static final int TYPE_UNLOCK
public static final java.lang.String URI_LOCK_DIALOG
public static final java.lang.String URI_LOCKCHANGE_DIALOG
public static final java.lang.String URI_LOCKS_DIALOG
public static final java.lang.String URI_UNLOCK_DIALOG
| Constructor Detail |
|---|
public CmsLock()
public CmsLock(CmsJspActionElement jsp)
jsp - an initialized JSP action element
public CmsLock(javax.servlet.jsp.PageContext context,
javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
context - the JSP page contextreq - the JSP requestres - the JSP response| Method Detail |
|---|
public static int getDialogAction(CmsObject cms)
cms - the CmsObject
public void actionToggleLock()
throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException - if problems including sub-elements occur
public void addConfigurationParameter(java.lang.String paramName,
java.lang.String paramValue)
I_CmsConfigurationParameterHandler
addConfigurationParameter in interface I_CmsConfigurationParameterHandlerparamName - the name of the parameterparamValue - the value for the parameterI_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)public java.lang.String buildDefaultConfirmationJS()
public java.lang.String buildIncludeJs()
public java.lang.String buildLockRequest()
public java.lang.String buildLockRequest(int hiddenTimeout,
boolean includeRelated)
hiddenTimeout - the maximal number of millis the dialog will be hiddenincludeRelated - indicates if the report should include related resources
public java.lang.String buildReport()
throws javax.servlet.jsp.JspException,
javax.servlet.ServletException,
java.io.IOException
javax.servlet.jsp.JspException - if dialog actions fail
java.io.IOException - in case of errros forwarding to the required result page
javax.servlet.ServletException - in case of errros forwarding to the required result pagepublic java.lang.String dialogButtons()
public CmsLockFilter getBlockingFilter()
public java.util.Set getBlockingLockedResources()
public int getBlockingLocks()
public java.util.Map getConfiguration()
I_CmsConfigurationParameterHandlernull if the class does not need to be configured.
All elements in the configuration are key, value String pairs,
set using the I_CmsConfigurationParameterHandler.addConfigurationParameter(String, String) method
during initialization of the loader.
Implementations will (should) not to return a direct reference to the internal configuration but just a copy of it, to avoid unwanted external manipulation.
getConfiguration in interface I_CmsConfigurationParameterHandlernullI_CmsConfigurationParameterHandler.getConfiguration()public java.lang.String getConfirmationMessage(boolean state)
state - if true everything is ok
public java.lang.String getDialogHandler()
I_CmsDialogHandlerStore the name of the key as a public String constant in the CmsDialogSelector class.
getDialogHandler in interface I_CmsDialogHandlerI_CmsDialogHandler.getDialogHandler()
public java.lang.String getDialogUri(java.lang.String resource,
CmsJspActionElement jsp)
I_CmsDialogHandler
getDialogUri in interface I_CmsDialogHandlerresource - the selected resourcejsp - the CmsJspActionElement
I_CmsDialogHandler.getDialogUri(java.lang.String, CmsJspActionElement)public java.util.List getLockedResources()
public CmsLockFilter getNonBlockingFilter()
public java.lang.String getParamIncluderelated()
public java.lang.String getParamProjectid()
public java.lang.String getParamShowownlocks()
public void initConfiguration()
I_CmsConfigurationParameterHandler
initConfiguration in interface I_CmsConfigurationParameterHandlerI_CmsConfigurationParameterHandler.initConfiguration()public void setBlockingFilter(CmsLockFilter blockingFilter)
blockingFilter - the filter to setpublic void setNonBlockingFilter(CmsLockFilter nonBlockingFilter)
nonBlockingFilter - the filter to setpublic void setParamIncluderelated(java.lang.String paramIncluderelated)
paramIncluderelated - the 'include unpublished related resources' parameter value to setpublic void setParamProjectid(java.lang.String projectid)
projectid - the project id parameter value to setpublic void setParamShowownlocks(java.lang.String paramShowownlocks)
paramShowownlocks - the 'show own locked resources' parameter value to setpublic boolean showConfirmation()
In case of locking a folder, a confirmation dialog is needed if any sub resources are already locked.
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
javax.servlet.http.HttpServletRequest request)
CmsWorkplace
initWorkplaceRequestValues in class CmsDialogsettings - the workplace settingsrequest - the current requestCmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
protected boolean performDialogOperation()
throws CmsException
performDialogOperation in class CmsMultiDialogCmsException - if operation is not successful
protected void performSingleResourceOperation(java.lang.String resourceName,
int dialogAction)
throws CmsException
resourceName - the resource name to perform the operation ondialogAction - the lock action: lock, unlock or change lock
CmsException - if the operation fails
|
||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||