org.jboss.as.server.parsing

Class CommonXml

java.lang.Object

org.jboss.as.server.parsing.CommonXml

All Implemented Interfaces:

org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>>, org.jboss.staxmapper.XMLElementWriter<ModelMarshallingContext>

Direct Known Subclasses:

StandaloneXml

public abstract class CommonXml
extends Object
implements org.jboss.staxmapper.XMLElementReader<List<org.jboss.dmr.ModelNode>>, org.jboss.staxmapper.XMLElementWriter<ModelMarshallingContext>

Bits of parsing and marshalling logic that are common across more than one of standalone.xml, domain.xml and host.xml. Note: On adding version specific parse methods to this class these MUST be private and the existing non-versioned method handle the version switch. This class is used by WildFly so we need to ensure the methods made accessible are those that can be used and will not be renamed.

Author:

David M. Lloyd, Darran Lofthouse

Field Summary

Fields

Modifier and Type	Field and Description
protected static Set<String>	RESTRICTED_PATHS The restricted path names.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommonXml()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	parseCompoundInterfaceCriterion(org.jboss.staxmapper.XMLExtendedStreamReader reader, Namespace expectedNs, org.jboss.dmr.ModelNode subModel)
protected void	parseContentOverride(String name, org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode baseAddress, List<org.jboss.dmr.ModelNode> list)
protected void	parseContentType(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode parent)
protected void	parseDeploymentOverlay(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode baseAddress, List<org.jboss.dmr.ModelNode> list, boolean allowContent, boolean allowDeployment)
protected void	parseDeploymentOverlayDeployment(String name, org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode baseAddress, List<org.jboss.dmr.ModelNode> list)
protected void	parseDeploymentOverlays(org.jboss.staxmapper.XMLExtendedStreamReader reader, Namespace namespace, org.jboss.dmr.ModelNode baseAddress, List<org.jboss.dmr.ModelNode> list, boolean allowContent, boolean allowDeployment)
protected void	parseDeployments(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode address, Namespace expectedNs, List<org.jboss.dmr.ModelNode> list, Set<Attribute> allowedAttributes, Set<Element> allowedElements, boolean validateUniqueRuntimeNames)
protected void	parseFSBaseType(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode parent, boolean isArchive)
protected void	parseInterfaceCriteria(org.jboss.staxmapper.XMLExtendedStreamReader reader, Namespace expectedNs, org.jboss.dmr.ModelNode interfaceModel)
protected void	parseInterfaces(org.jboss.staxmapper.XMLExtendedStreamReader reader, Set<String> names, org.jboss.dmr.ModelNode address, Namespace expectedNs, List<org.jboss.dmr.ModelNode> list, boolean checkSpecified)
protected void	parseModuleOption(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode moduleOptions)
protected void	parseNamespaces(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode address, List<org.jboss.dmr.ModelNode> nodes)
protected String	parseOutboundSocketBinding(org.jboss.staxmapper.XMLExtendedStreamReader reader, Set<String> interfaces, org.jboss.dmr.ModelNode address, List<org.jboss.dmr.ModelNode> updates)
protected void	parsePath(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode address, List<org.jboss.dmr.ModelNode> list, boolean requirePath, Set<String> defined)
protected void	parsePaths(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode address, Namespace expectedNs, List<org.jboss.dmr.ModelNode> list, boolean requirePath)
protected void	parseSchemaLocations(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode address, List<org.jboss.dmr.ModelNode> updateList, int idx)
protected void	parseSimpleInterfaceCriterion(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode subModel, boolean nested) Creates the appropriate AbstractInterfaceCriteriaElement for simple criterion.
protected String	parseSocketBinding(org.jboss.staxmapper.XMLExtendedStreamReader reader, Set<String> interfaces, org.jboss.dmr.ModelNode address, List<org.jboss.dmr.ModelNode> updates)
protected void	parseSocketBindingGroupRef(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode addOperation, SimpleAttributeDefinition socketBindingGroup, SimpleAttributeDefinition portOffset, SimpleAttributeDefinition defaultInterface)
protected void	parseSystemProperties(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode address, Namespace expectedNs, List<org.jboss.dmr.ModelNode> updates, boolean standalone)
protected void	parseVault(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode address, Namespace expectedNs, List<org.jboss.dmr.ModelNode> list)
protected void	parseVaultOption(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode vaultOptions)
protected void	readHeadComment(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode address, List<org.jboss.dmr.ModelNode> nodes)
protected void	readTailComment(org.jboss.staxmapper.XMLExtendedStreamReader reader, org.jboss.dmr.ModelNode address, List<org.jboss.dmr.ModelNode> nodes)
protected static void	writeAttribute(org.jboss.staxmapper.XMLExtendedStreamWriter writer, Attribute attribute, String value)
protected static void	writeContentItem(org.jboss.staxmapper.XMLExtendedStreamWriter writer, org.jboss.dmr.ModelNode contentItem)
protected void	writeDeploymentOverlays(org.jboss.staxmapper.XMLExtendedStreamWriter writer, org.jboss.dmr.ModelNode modelNode)
protected static void	writeElement(org.jboss.staxmapper.XMLExtendedStreamWriter writer, Element element)
protected void	writeInterfaces(org.jboss.staxmapper.XMLExtendedStreamWriter writer, org.jboss.dmr.ModelNode modelNode) Write the interfaces including the criteria elements.
protected void	writeNamespaces(org.jboss.staxmapper.XMLExtendedStreamWriter writer, org.jboss.dmr.ModelNode modelNode)
protected static void	writeNewLine(org.jboss.staxmapper.XMLExtendedStreamWriter writer)
protected void	writePaths(org.jboss.staxmapper.XMLExtendedStreamWriter writer, org.jboss.dmr.ModelNode node, boolean namedPath)
protected void	writeProperties(org.jboss.staxmapper.XMLExtendedStreamWriter writer, org.jboss.dmr.ModelNode modelNode, Element element, boolean standalone)
protected void	writeSchemaLocation(org.jboss.staxmapper.XMLExtendedStreamWriter writer, org.jboss.dmr.ModelNode modelNode)
protected void	writeSocketBindingGroup(org.jboss.staxmapper.XMLExtendedStreamWriter writer, org.jboss.dmr.ModelNode bindingGroup, boolean fromServer)
protected void	writeVault(org.jboss.staxmapper.XMLExtendedStreamWriter writer, org.jboss.dmr.ModelNode vault)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.staxmapper.XMLElementReader

readElement

Methods inherited from interface org.jboss.staxmapper.XMLElementWriter

writeContent

Field Detail

RESTRICTED_PATHS

protected static final Set<String> RESTRICTED_PATHS

The restricted path names.

Constructor Detail

CommonXml

protected CommonXml()

Method Detail

parseNamespaces

protected void parseNamespaces(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                   org.jboss.dmr.ModelNode address,
                   List<org.jboss.dmr.ModelNode> nodes)

readHeadComment

protected void readHeadComment(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                   org.jboss.dmr.ModelNode address,
                   List<org.jboss.dmr.ModelNode> nodes)
                        throws XMLStreamException

Throws:

XMLStreamException

readTailComment

protected void readTailComment(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                   org.jboss.dmr.ModelNode address,
                   List<org.jboss.dmr.ModelNode> nodes)
                        throws XMLStreamException

Throws:

XMLStreamException

parseSchemaLocations

protected void parseSchemaLocations(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                        org.jboss.dmr.ModelNode address,
                        List<org.jboss.dmr.ModelNode> updateList,
                        int idx)
                             throws XMLStreamException

Throws:

XMLStreamException

writeSchemaLocation

protected void writeSchemaLocation(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                       org.jboss.dmr.ModelNode modelNode)
                            throws XMLStreamException

Throws:

XMLStreamException

writeNamespaces

protected void writeNamespaces(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                   org.jboss.dmr.ModelNode modelNode)
                        throws XMLStreamException

Throws:

XMLStreamException

writeElement

protected static void writeElement(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                Element element)
                            throws XMLStreamException

Throws:

XMLStreamException

writePaths

protected void writePaths(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
              org.jboss.dmr.ModelNode node,
              boolean namedPath)
                   throws XMLStreamException

Throws:

XMLStreamException

parseFSBaseType

protected void parseFSBaseType(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                   org.jboss.dmr.ModelNode parent,
                   boolean isArchive)
                        throws XMLStreamException

Throws:

XMLStreamException

parsePaths

protected void parsePaths(org.jboss.staxmapper.XMLExtendedStreamReader reader,
              org.jboss.dmr.ModelNode address,
              Namespace expectedNs,
              List<org.jboss.dmr.ModelNode> list,
              boolean requirePath)
                   throws XMLStreamException

Throws:

XMLStreamException

parsePath

protected void parsePath(org.jboss.staxmapper.XMLExtendedStreamReader reader,
             org.jboss.dmr.ModelNode address,
             List<org.jboss.dmr.ModelNode> list,
             boolean requirePath,
             Set<String> defined)
                  throws XMLStreamException

Throws:

XMLStreamException

parseSystemProperties

protected void parseSystemProperties(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                         org.jboss.dmr.ModelNode address,
                         Namespace expectedNs,
                         List<org.jboss.dmr.ModelNode> updates,
                         boolean standalone)
                              throws XMLStreamException

Throws:

XMLStreamException

parseInterfaceCriteria

protected void parseInterfaceCriteria(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                          Namespace expectedNs,
                          org.jboss.dmr.ModelNode interfaceModel)
                               throws XMLStreamException

Throws:

XMLStreamException

parseCompoundInterfaceCriterion

protected void parseCompoundInterfaceCriterion(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                                   Namespace expectedNs,
                                   org.jboss.dmr.ModelNode subModel)
                                        throws XMLStreamException

Throws:

XMLStreamException

parseContentType

protected void parseContentType(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                    org.jboss.dmr.ModelNode parent)
                         throws XMLStreamException

Throws:

XMLStreamException

parseSimpleInterfaceCriterion

protected void parseSimpleInterfaceCriterion(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                                 org.jboss.dmr.ModelNode subModel,
                                 boolean nested)
                                      throws XMLStreamException

Creates the appropriate AbstractInterfaceCriteriaElement for simple criterion.

Note! changes/additions made here will likely need to be added to the corresponding write method that handles the write of the element. Failure to do so will result in a configuration that can be read, but not written out.

Throws:

XMLStreamException - if an error occurs

See Also:

#writeInterfaceCriteria(org.jboss.staxmapper.XMLExtendedStreamWriter, org.jboss.dmr.ModelNode, boolean)}

parseInterfaces

protected void parseInterfaces(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                   Set<String> names,
                   org.jboss.dmr.ModelNode address,
                   Namespace expectedNs,
                   List<org.jboss.dmr.ModelNode> list,
                   boolean checkSpecified)
                        throws XMLStreamException

Throws:

XMLStreamException

parseSocketBindingGroupRef

protected void parseSocketBindingGroupRef(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                              org.jboss.dmr.ModelNode addOperation,
                              SimpleAttributeDefinition socketBindingGroup,
                              SimpleAttributeDefinition portOffset,
                              SimpleAttributeDefinition defaultInterface)
                                   throws XMLStreamException

Throws:

XMLStreamException

parseSocketBinding

protected String parseSocketBinding(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                        Set<String> interfaces,
                        org.jboss.dmr.ModelNode address,
                        List<org.jboss.dmr.ModelNode> updates)
                             throws XMLStreamException

Throws:

XMLStreamException

parseOutboundSocketBinding

protected String parseOutboundSocketBinding(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                                Set<String> interfaces,
                                org.jboss.dmr.ModelNode address,
                                List<org.jboss.dmr.ModelNode> updates)
                                     throws XMLStreamException

Throws:

XMLStreamException

parseDeployments

protected void parseDeployments(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                    org.jboss.dmr.ModelNode address,
                    Namespace expectedNs,
                    List<org.jboss.dmr.ModelNode> list,
                    Set<Attribute> allowedAttributes,
                    Set<Element> allowedElements,
                    boolean validateUniqueRuntimeNames)
                         throws XMLStreamException

Throws:

XMLStreamException

parseDeploymentOverlays

protected void parseDeploymentOverlays(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                           Namespace namespace,
                           org.jboss.dmr.ModelNode baseAddress,
                           List<org.jboss.dmr.ModelNode> list,
                           boolean allowContent,
                           boolean allowDeployment)
                                throws XMLStreamException

Throws:

XMLStreamException

parseDeploymentOverlay

protected void parseDeploymentOverlay(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                          org.jboss.dmr.ModelNode baseAddress,
                          List<org.jboss.dmr.ModelNode> list,
                          boolean allowContent,
                          boolean allowDeployment)
                               throws XMLStreamException

Throws:

XMLStreamException

parseContentOverride

protected void parseContentOverride(String name,
                        org.jboss.staxmapper.XMLExtendedStreamReader reader,
                        org.jboss.dmr.ModelNode baseAddress,
                        List<org.jboss.dmr.ModelNode> list)
                             throws XMLStreamException

Throws:

XMLStreamException

parseDeploymentOverlayDeployment

protected void parseDeploymentOverlayDeployment(String name,
                                    org.jboss.staxmapper.XMLExtendedStreamReader reader,
                                    org.jboss.dmr.ModelNode baseAddress,
                                    List<org.jboss.dmr.ModelNode> list)
                                         throws XMLStreamException

Throws:

XMLStreamException

parseVault

protected void parseVault(org.jboss.staxmapper.XMLExtendedStreamReader reader,
              org.jboss.dmr.ModelNode address,
              Namespace expectedNs,
              List<org.jboss.dmr.ModelNode> list)
                   throws XMLStreamException

Throws:

XMLStreamException

parseVaultOption

protected void parseVaultOption(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                    org.jboss.dmr.ModelNode vaultOptions)
                         throws XMLStreamException

Throws:

XMLStreamException

parseModuleOption

protected void parseModuleOption(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                     org.jboss.dmr.ModelNode moduleOptions)
                          throws XMLStreamException

Throws:

XMLStreamException

writeInterfaces

protected void writeInterfaces(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                   org.jboss.dmr.ModelNode modelNode)
                        throws XMLStreamException

Write the interfaces including the criteria elements.

Parameters:

writer - the xml stream writer

modelNode - the model

Throws:

XMLStreamException

writeSocketBindingGroup

protected void writeSocketBindingGroup(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                           org.jboss.dmr.ModelNode bindingGroup,
                           boolean fromServer)
                                throws XMLStreamException

Throws:

XMLStreamException

writeProperties

protected void writeProperties(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                   org.jboss.dmr.ModelNode modelNode,
                   Element element,
                   boolean standalone)
                        throws XMLStreamException

Throws:

XMLStreamException

writeAttribute

protected static void writeAttribute(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                  Attribute attribute,
                  String value)
                              throws XMLStreamException

Throws:

XMLStreamException

writeContentItem

protected static void writeContentItem(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                    org.jboss.dmr.ModelNode contentItem)
                                throws XMLStreamException

Throws:

XMLStreamException

writeVault

protected void writeVault(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
              org.jboss.dmr.ModelNode vault)
                   throws XMLStreamException

Throws:

XMLStreamException

writeNewLine

protected static void writeNewLine(org.jboss.staxmapper.XMLExtendedStreamWriter writer)
                            throws XMLStreamException

Throws:

XMLStreamException

writeDeploymentOverlays

protected void writeDeploymentOverlays(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                           org.jboss.dmr.ModelNode modelNode)
                                throws XMLStreamException

Throws:

XMLStreamException