org.opencms.setup.xml
Class A_CmsXmlWorkplace

java.lang.Object
  extended byorg.opencms.setup.xml.A_CmsSetupXmlUpdate
      extended byorg.opencms.setup.xml.A_CmsXmlWorkplace
All Implemented Interfaces:
I_CmsSetupXmlUpdate
Direct Known Subclasses:
CmsXmlAddAutoSetFeatures, CmsXmlAddAvailabilityContextMenu, CmsXmlAddImgGalleryContextMenues, CmsXmlAddPublishButtonAppearance, CmsXmlUpdateDefaultPermissions, CmsXmlUpdateLocalizationKeys

public abstract class A_CmsXmlWorkplace
extends A_CmsSetupXmlUpdate

Skeleton for handling opencms-workplace.xml.

Since:
6.1.8
Version:
$Revision: 1.2 $
Author:
Michael Moossen

Constructor Summary
A_CmsXmlWorkplace()
           
 
Method Summary
 java.lang.String getXmlFilename()
          Returns the affected xml configuration file name.
protected  boolean setAccessEntry(org.dom4j.Document document, java.lang.String xpath, java.lang.String principal, java.lang.String permissions)
          Creates a new access control entry node.
protected  void setMenuEntry(org.dom4j.Document document, java.lang.String xpath, java.lang.String key, java.lang.String uri, java.lang.String rules, java.lang.String order)
          Creates a new context menu entry node.
 
Methods inherited from class org.opencms.setup.xml.A_CmsSetupXmlUpdate
execute, executeUpdate, getCodeToChange, getCommonPath, getXPathsToRemove, getXPathsToUpdate, prepareDoc, updateDoc, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opencms.setup.xml.I_CmsSetupXmlUpdate
getName
 

Constructor Detail

A_CmsXmlWorkplace

public A_CmsXmlWorkplace()
Method Detail

getXmlFilename

public java.lang.String getXmlFilename()
Description copied from interface: I_CmsSetupXmlUpdate
Returns the affected xml configuration file name.

Returns:
the xml file name
See Also:
I_CmsSetupXmlUpdate.getXmlFilename()

setAccessEntry

protected boolean setAccessEntry(org.dom4j.Document document,
                                 java.lang.String xpath,
                                 java.lang.String principal,
                                 java.lang.String permissions)
Creates a new access control entry node.

Parameters:
document - the xml document to change
xpath - the base xpath
principal - the principal
permissions - the permissions string
Returns:
if a modification has been needed

setMenuEntry

protected void setMenuEntry(org.dom4j.Document document,
                            java.lang.String xpath,
                            java.lang.String key,
                            java.lang.String uri,
                            java.lang.String rules,
                            java.lang.String order)
Creates a new context menu entry node.

Parameters:
document - the xml document to change
xpath - the base xpath
key - the localization key name
uri - the entry uri
rules - the permissions rules
order - the relative order