Uses of Class
org.opencms.xml.CmsXmlException

Packages that use CmsXmlException

Package	Description
org.opencms.ade.contenteditor	Contains server side classes for the XML content editor.
org.opencms.configuration	Reads and writes the XML based OpenCms configuration files.
org.opencms.importexport	Contains functions to import and export resources from the OpenCms VFS.
org.opencms.module	OpenCms modules provide a powerful, standardized way to extend the core OpenCms functionality.
org.opencms.ugc
org.opencms.util	Utility functions for String manipulation and other often used tasks.
org.opencms.workplace.editors	Base classes for the editors (WYSIWYG, plain text, XML content) used in the OpenCms Workplace.
org.opencms.xml	Basic XML functionality and utilities used by OpenCms to maintain XML documents and content.
org.opencms.xml.containerpage	Contains functions for the ADE main pages, commonly called "Container Pages" in OpenCms.
org.opencms.xml.content	Contains functions for structured content storage using XML, commonly called "XML content" in OpenCms.
org.opencms.xml.page	Contains functions for unstructured content storage using XML, commonly called "XML pages" in OpenCms.

Uses of CmsXmlException in org.opencms.ade.contenteditor

Methods in org.opencms.ade.contenteditor that throw CmsXmlException

Modifier and Type	Method	Description
boolean	CmsContentTypeVisitor.isEditorCompatible(CmsXmlContentDefinition xmlContentDefinition)	Checks if the content type widgets are compatible with the new content editor.
protected void	CmsContentService.synchronizeLocaleIndependentFields(CmsFile file, CmsXmlContent content, Collection<String> skipPaths, Collection<CmsEntity> entities, Locale lastEdited)	Synchronizes the locale independent fields.

Uses of CmsXmlException in org.opencms.configuration

Methods in org.opencms.configuration that throw CmsXmlException

Modifier and Type	Method	Description
static Map<String,CmsParameterStore.WeightedValue>	CmsParameterStore.parse(byte[] data, String source)	Helper method for parsing a parameter file from a byte array.

Uses of CmsXmlException in org.opencms.importexport

Methods in org.opencms.importexport that throw CmsXmlException

Modifier and Type	Method	Description
static CmsXmlPage	CmsXmlPageConverter.convertToXmlPage(CmsObject cms, byte[] content, Locale locale, String encoding)	Deprecated. Converts the contents of a page into an xml page.
void	CmsImport.importData(CmsImportParameters parameters)	Imports the resources and writes them to the cms VFS, even if there already exist files with the same name.
void	CmsImportExportManager.importData(CmsObject cms, String importFile, String importPath, I_CmsReport report)	Deprecated. use CmsImportExportManager.importData(CmsObject, I_CmsReport, CmsImportParameters) instead
void	CmsImportExportManager.importData(CmsObject cms, I_CmsReport report, CmsImportParameters parameters)	Checks if the current user has permissions to import data into the Cms, and if so, creates a new import handler instance that imports the data.
void	CmsImportVersion2.importData(CmsObject cms, I_CmsReport report, CmsImportParameters params)	Deprecated.
void	CmsImportVersion3.importData(CmsObject cms, I_CmsReport report, CmsImportParameters params)	Deprecated.
void	CmsImportVersion4.importData(CmsObject cms, I_CmsReport report, CmsImportParameters params)	Deprecated.
void	CmsImportVersion5.importData(CmsObject cms, I_CmsReport report, CmsImportParameters params)	Deprecated.
void	CmsVfsImportExportHandler.importData(CmsObject cms, String importFile, String importPath, I_CmsReport report)	Deprecated. use CmsVfsImportExportHandler.importData(CmsObject, I_CmsReport) instead
void	CmsVfsImportExportHandler.importData(CmsObject cms, I_CmsReport report)
void	I_CmsImport.importData(CmsObject cms, I_CmsReport report, CmsImportParameters parameters)	Imports the data.
void	I_CmsImportExportHandler.importData(CmsObject cms, String importFile, String importPath, I_CmsReport report)	Deprecated. use I_CmsImportExportHandler.importData(CmsObject, I_CmsReport) instead
void	I_CmsImportExportHandler.importData(CmsObject cms, I_CmsReport report)	Imports the data into the Cms.

Uses of CmsXmlException in org.opencms.module

Methods in org.opencms.module that throw CmsXmlException

Modifier and Type	Method	Description
void	CmsModuleImportExportHandler.importData(CmsObject cms, String importFile, String importPath, I_CmsReport report)	Deprecated. use CmsModuleImportExportHandler.importData(CmsObject, I_CmsReport) instead
void	CmsModuleImportExportHandler.importData(CmsObject cms, I_CmsReport report)

Uses of CmsXmlException in org.opencms.ugc

Methods in org.opencms.ugc that throw CmsXmlException

Modifier and Type	Method	Description
protected void	CmsUgcSession.addContentValues(CmsXmlContent content, Locale locale, Map<String,String> contentValues)	Adds the given values to the content document.

Uses of CmsXmlException in org.opencms.util

Methods in org.opencms.util that throw CmsXmlException

Modifier and Type	Method	Description
static Map<String,String[]>	CmsMacroResolver.getBundleMapFromResources(Properties resourceBundle, CmsResource descriptor, CmsObject clonedCms)	Reads a bundle (key, value, descriptor) from Descriptor Resource and property resource.
static String	CmsXsltUtil.transformCsvContent(CmsObject cms, String xsltFile, String csvContent, String delimiter)	Changes content from CSV to xml/html.
static String	CmsXsltUtil.transformXmlContent(CmsObject cms, String xsltFile, String xmlContent)	Applies a XSLT Transformation to the content.

Uses of CmsXmlException in org.opencms.workplace.editors

Methods in org.opencms.workplace.editors that throw CmsXmlException

Modifier and Type	Method	Description
void	CmsXmlContentEditor.setEditorValues(Locale locale)	Sets the editor values for the locale with the parameters from the request.

Uses of CmsXmlException in org.opencms.xml

Methods in org.opencms.xml that throw CmsXmlException

Modifier and Type	Method	Description
I_CmsXmlSchemaType	CmsXmlContentTypeManager.addContentType(Class<?> clazz)	Adds a XML content schema type class to the registered XML content types.
void	I_CmsXmlDocument.addLocale(CmsObject cms, Locale locale)	Adds the given locale to this XML document.
void	CmsXmlContentDefinition.addType(I_CmsXmlSchemaType type)	Adds the given content type.
void	A_CmsXmlDocument.copyLocale(List<Locale> possibleSources, Locale destination)
void	A_CmsXmlDocument.copyLocale(Locale source, Locale destination)
void	I_CmsXmlDocument.copyLocale(List<Locale> possibleSources, Locale destination)	Copies the content from the first matching source locale that exists in this XML document to the given destination locale in this XML document.
void	I_CmsXmlDocument.copyLocale(Locale source, Locale destination)	Copies the content of the given source locale to the given destination locale in this XML document.
CmsFile	A_CmsXmlDocument.correctXmlStructure(CmsObject cms)	Corrects the structure of this XML document.
I_CmsXmlContentHandler	CmsXmlContentTypeManager.getContentHandler(String className, String schemaLocation)	Returns the XML content handler instance class for the specified class name.
I_CmsXmlSchemaType	CmsXmlContentTypeManager.getContentType(org.dom4j.Element typeElement, Set<CmsXmlContentDefinition> nestedDefinitions)	Generates an initialized instance of a XML content type definition from the given XML schema element.
I_CmsXmlContentHandler	CmsXmlContentTypeManager.getFreshContentHandler(String className)	Returns a fresh XML content handler instance for the specified class name.
String	I_CmsXmlDocument.getStringValue(CmsObject cms, String path, Locale locale)	Returns the first content value for the given path as a String, or null if no such value exists.
String	I_CmsXmlDocument.getStringValue(CmsObject cms, String path, Locale locale, int index)	Returns the content value for the given path and the selected index as a String, or null if no such value exists.
byte[]	A_CmsXmlDocument.marshal()	Marshals (writes) the content of the current XML document into a byte array using the selected encoding.
protected OutputStream	A_CmsXmlDocument.marshal(OutputStream out, String encoding)	Marshals (writes) the content of the current XML document into an output stream.
static OutputStream	CmsXmlUtils.marshal(org.dom4j.Document document, OutputStream out, String encoding)	Marshals (writes) an XML document into an output stream using XML pretty-print formatting.
static String	CmsXmlUtils.marshal(org.dom4j.Document document, String encoding)	Marshals (writes) an XML document to a String using XML pretty-print formatting.
static String	CmsXmlUtils.marshal(org.dom4j.Node node, String encoding)	Marshals (writes) an XML node into an output stream using XML pretty-print formatting.
void	A_CmsXmlDocument.moveLocale(Locale source, Locale destination)
void	I_CmsXmlDocument.moveLocale(Locale source, Locale destination)	Moves the content of the given source locale to the given destination locale in this XML document.
void	A_CmsXmlDocument.removeLocale(Locale locale)
void	I_CmsXmlDocument.removeLocale(Locale locale)	Removes the given locale from this XML document.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(byte[] xmlData, String schemaLocation, EntityResolver resolver)	Factory method to unmarshal (read) a XML content definition instance from a byte array that contains XML data.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(String xmlData, String schemaLocation, EntityResolver resolver)	Factory method to unmarshal (read) a XML content definition instance from a String that contains XML data.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(String schemaLocation, EntityResolver resolver)	Factory method to unmarshal (read) a XML content definition instance from a given XML schema location.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(org.dom4j.Document document, String schemaLocation)	Factory method to unmarshal (read) a XML content definition instance from a XML document.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(CmsObject cms, String resourcename)	Factory method to unmarshal (read) a XML content definition instance from the OpenCms VFS resource name.
static CmsXmlContentDefinition	CmsXmlContentDefinition.unmarshal(InputSource source, String schemaLocation, EntityResolver resolver)	Factory method to unmarshal (read) a XML content definition instance from a XML InputSource.
static org.dom4j.Document	CmsXmlUtils.unmarshalHelper(byte[] xmlData, EntityResolver resolver)	Helper to unmarshal (read) xml contents from a byte array into a document.
static org.dom4j.Document	CmsXmlUtils.unmarshalHelper(byte[] xmlData, EntityResolver resolver, boolean validate)	Helper to unmarshal (read) xml contents from a byte array into a document.
static org.dom4j.Document	CmsXmlUtils.unmarshalHelper(String xmlData, EntityResolver resolver)	Helper to unmarshal (read) xml contents from a String into a document.
static org.dom4j.Document	CmsXmlUtils.unmarshalHelper(InputSource source, EntityResolver resolver)	Helper to unmarshal (read) xml contents from an input source into a document.
static org.dom4j.Document	CmsXmlUtils.unmarshalHelper(InputSource source, EntityResolver resolver, boolean validate)	Helper to unmarshal (read) xml contents from an input source into a document.
protected static String	CmsXmlContentDefinition.validateAttribute(org.dom4j.Element element, String attributeName, String requiredValue)	Validates if a given attribute exists at the given element with an (optional) specified value.
protected static void	CmsXmlContentDefinition.validateAttributesExists(org.dom4j.Element element, String[] requiredAttributes, String[] optionalAttributes)	Validates if a given element has exactly the required attributes set.
protected static org.opencms.xml.CmsXmlComplexTypeSequence	CmsXmlContentDefinition.validateComplexTypeSequence(org.dom4j.Element element, Set<CmsXmlContentDefinition> includes)	Validates the given element as a complex type sequence.
void	A_CmsXmlDocument.validateXmlStructure(EntityResolver resolver)	Validates the XML structure of the document with the DTD or XML schema used by the document.
static void	CmsXmlUtils.validateXmlStructure(byte[] xmlData, EntityResolver resolver)	Validates the structure of a XML document contained in a byte array with the DTD or XML schema used by the document.
static void	CmsXmlUtils.validateXmlStructure(InputStream xmlStream, EntityResolver resolver)	Validates the structure of a XML document contained in a byte array with the DTD or XML schema used by the document.
static void	CmsXmlUtils.validateXmlStructure(org.dom4j.Document document, String encoding, EntityResolver resolver)	Validates the structure of a XML document with the DTD or XML schema used by the document.

Uses of CmsXmlException in org.opencms.xml.containerpage

Methods in org.opencms.xml.containerpage that throw CmsXmlException

Modifier and Type	Method	Description
void	CmsXmlGroupContainer.clearLocales()	Removes all locales from the element group XML.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, byte[] xmlData, String encoding, EntityResolver resolver)	Factory method to unmarshal (generate) a container page instance from a byte array that contains XML data.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, String xmlData, String encoding, EntityResolver resolver)	Factory method to unmarshal (generate) a container page instance from a String that contains XML data.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsFile file)	Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding)	Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding, boolean noCache)	Factory method to unmarshal (read) a container page instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
static CmsXmlContainerPage	CmsXmlContainerPageFactory.unmarshal(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)	Factory method to unmarshal (read) a container page instance from a resource, using the request attributes as cache.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, byte[] xmlData, String encoding, EntityResolver resolver)	Factory method to unmarshal (generate) a group container instance from a byte array that contains XML data.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, String xmlData, String encoding, EntityResolver resolver)	Factory method to unmarshal (generate) a group container instance from a String that contains XML data.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsFile file)	Factory method to unmarshal (read) a group container instance from a OpenCms VFS file that contains XML data.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding)	Factory method to unmarshal (read) a group container instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
static CmsXmlGroupContainer	CmsXmlGroupContainerFactory.unmarshal(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)	Factory method to unmarshal (read) a group container instance from a resource, using the request attributes as cache.
protected void	CmsXmlContainerPageHandler.validateNames(CmsObject cms, I_CmsXmlContentValue value, CmsXmlContent content)	Validates container names, so that they are unique in the page.

Uses of CmsXmlException in org.opencms.xml.content

Methods in org.opencms.xml.content that throw CmsXmlException

Modifier and Type	Method	Description
protected void	CmsDefaultXmlContentHandler.addCheckRule(CmsXmlContentDefinition contentDefinition, String elementName, String invalidate, String type)	Adds a check rule for a specified element.
protected void	CmsDefaultXmlContentHandler.addConfiguration(CmsXmlContentDefinition contentDefinition, String elementName, String configurationValue)	Adds a configuration value for an element widget.
protected void	CmsDefaultXmlContentHandler.addDefault(CmsXmlContentDefinition contentDefinition, String elementName, String defaultValue, String resolveMacrosValue)	Adds a default value for an element.
protected void	CmsDefaultXmlContentHandler.addDefaultCheckRules(CmsXmlContentDefinition rootContentDefinition, I_CmsXmlSchemaType schemaType, String elementPath)	Adds all needed default check rules recursively for the given schema type.
protected void	CmsDefaultXmlContentHandler.addDisplayType(CmsXmlContentDefinition contentDefinition, String elementName, I_CmsXmlContentHandler.DisplayType displayType)	Adds the given element to the compact view set.
void	CmsXmlContent.addLocale(CmsObject cms, Locale locale)
protected void	CmsDefaultXmlContentHandler.addMapping(CmsXmlContentDefinition contentDefinition, String elementName, String mapping, String useDefault)	Adds an element mapping.
protected void	CmsDefaultXmlContentHandler.addNestedFormatter(String elementName, CmsXmlContentDefinition contentDefinition)	Adds a nested formatter element.
protected void	CmsDefaultXmlContentHandler.addSearchSetting(CmsXmlContentDefinition contentDefinition, String elementName, I_CmsXmlContentValue.SearchContentType value)	Adds a search setting for an element.
protected void	CmsDefaultXmlContentHandler.addSimpleSearchSetting(CmsXmlContentDefinition contentDef, String name, String value)	Adds search settings as defined by 'simple' syntax in fields.
protected void	CmsDefaultXmlContentHandler.addValidationRule(CmsXmlContentDefinition contentDefinition, String elementName, String regex, String message, boolean isWarning)	Adds a validation rule for a specified element.
protected void	CmsDefaultXmlContentHandler.addWidget(CmsXmlContentDefinition contentDefinition, String elementName, String name)	Adds a GUI widget for a specified element.
void	CmsXmlContent.copyLocale(Locale source, Locale destination, Set<String> elements)	Copies the content of the given source locale to the given destination locale in this XML document.
static CmsXmlContent	CmsXmlContentFactory.createDocument(CmsObject cms, Locale locale, CmsResourceTypeXmlContent resourceType)	Creates a new XML content based on a resource type.
I_CmsWidget	I_CmsXmlContentHandler.getWidget(I_CmsXmlSchemaType value)	Deprecated.
protected void	CmsDefaultXmlContentHandler.initDefaultValues(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the default values for this content handler.
protected void	CmsDefaultXmlContentHandler.initField(org.dom4j.Element elem, CmsXmlContentDefinition contentDef)	Processes a single field definition.
protected void	CmsDefaultXmlContentHandler.initFields(org.dom4j.Element parent, CmsXmlContentDefinition contentDef)	Processes all field declarations in the schema.
void	CmsDefaultXmlContentHandler.initialize(org.dom4j.Element appInfoElement, CmsXmlContentDefinition contentDefinition)
void	I_CmsXmlContentHandler.initialize(org.dom4j.Element appInfoElement, CmsXmlContentDefinition contentDefinition)	Initializes this content handler for the given XML content definition by analyzing the "appinfo" node.
protected void	CmsDefaultXmlContentHandler.initLayouts(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the layout for this content handler.
protected void	CmsDefaultXmlContentHandler.initMappings(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the element mappings for this content handler.
protected void	CmsDefaultXmlContentHandler.initModelFolder(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the folder containing the model file(s) for this content handler.
protected void	CmsDefaultXmlContentHandler.initNestedFormatters(org.dom4j.Element element, CmsXmlContentDefinition contentDefinition)	Initializes the nested formatter fields.
protected void	CmsDefaultXmlContentHandler.initPreview(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the preview location for this content handler.
protected void	CmsDefaultXmlContentHandler.initRelations(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the relation configuration for this content handler.
protected void	CmsDefaultXmlContentHandler.initResourceBundle(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition, boolean single)	Initializes the resource bundle to use for localized messages in this content handler.
protected void	CmsDefaultXmlContentHandler.initSearchSettings(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the search exclusions values for this content handler.
protected void	CmsDefaultXmlContentHandler.initValidationRules(org.dom4j.Element root, CmsXmlContentDefinition contentDefinition)	Initializes the validation rules this content handler.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(String xmlData, String encoding, EntityResolver resolver)	Factory method to unmarshal (generate) a XML content instance from a String that contains XML data.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, byte[] xmlData, String encoding, EntityResolver resolver)	Factory method to unmarshal (generate) a XML content instance from a byte array that contains XML data.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, String xmlData, String encoding, EntityResolver resolver)	Factory method to unmarshal (generate) a XML content instance from a String that contains XML data.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsFile file)	Factory method to unmarshal (read) a XML content instance from a OpenCms VFS file that contains XML data.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding)	Factory method to unmarshal (read) a XML content instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.
static CmsXmlContent	CmsXmlContentFactory.unmarshal(CmsObject cms, CmsResource resource, javax.servlet.ServletRequest req)	Factory method to unmarshal (read) a XML content instance from a resource, using the request attributes as cache.
protected void	CmsDefaultXmlContentHandler.validateAppinfoElement(org.dom4j.Element appinfoElement)	Validates if the given appinfo element node from the XML content definition schema is valid according the the capabilities of this content handler.

Uses of CmsXmlException in org.opencms.xml.page

Methods in org.opencms.xml.page that throw CmsXmlException

Modifier and Type	Method	Description
void	CmsXmlPage.addLocale(CmsObject cms, Locale locale)
void	CmsXmlPage.setStringValue(CmsObject cms, String name, Locale locale, String content)	Sets the data of an already existing value.
static CmsXmlPage	CmsXmlPageFactory.unmarshal(byte[] xmlData, String encoding, EntityResolver resolver)	Factory method to unmarshal (read) a XML page instance from a byte array that contains XML data.
static CmsXmlPage	CmsXmlPageFactory.unmarshal(String xmlData, String encoding, EntityResolver resolver)	Factory method to unmarshal (read) a XML page instance from a String that contains XML data.
static CmsXmlPage	CmsXmlPageFactory.unmarshal(CmsObject cms, CmsFile file)	Factory method to unmarshal (read) a XML page instance from a OpenCms VFS file that contains XML data.
static CmsXmlPage	CmsXmlPageFactory.unmarshal(CmsObject cms, CmsFile file, boolean keepEncoding)	Factory method to unmarshal (read) a XML page instance from a OpenCms VFS file that contains XML data, using wither the encoding set in the XML file header, or the encoding set in the VFS file property.