org.mule.runtime.ast.internal.xml

Class DefaultAstXmlParser

java.lang.Object

org.mule.runtime.ast.internal.xml.DefaultAstXmlParser

All Implemented Interfaces:

AstXmlParser

public class DefaultAstXmlParser
extends Object
implements AstXmlParser

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.ast.api.xml.AstXmlParser

AstXmlParser.Builder

Field Summary

Fields inherited from interface org.mule.runtime.ast.api.xml.AstXmlParser

ANNOTATIONS_IDENTIFIER, DOMAIN_ROOT_IDENTIFIER, IMPORT_IDENTIFIER, MULE_ROOT_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
DefaultAstXmlParser(ArtifactType artifactType, Set<org.mule.runtime.api.meta.model.ExtensionModel> extensionModels, ArtifactAst parentArtifact, Optional<org.mule.runtime.extension.api.dsl.syntax.resources.spi.ExtensionSchemaGenerator> schemaGenerator, org.mule.runtime.dsl.api.xml.parser.ParsingPropertyResolver propertyResolver, ResolveEntityFailStrategy resolveEntityFailStrategy)

Method Summary

Modifier and Type	Method and Description
protected ArtifactAst	doParse(String artifactName, Document document, String resourceName, URL resourceUrl, List<ImportedResource> importChain)
ArtifactAst	parse(org.mule.runtime.dsl.api.ConfigResource... appXmlConfigResources) Generate a new ArtifactAst representation form the XML read from the provided inputStreams.
ArtifactAst	parse(List<org.mule.runtime.api.util.Pair<String,InputStream>> appXmlConfigInputStreams) Generate a new ArtifactAst representation form the XML read from the provided inputStreams.
ArtifactAst	parse(String artifactName, org.mule.runtime.dsl.api.ConfigResource... appXmlConfigResources) Generate a new ArtifactAst representation form the XML read from the provided inputStreams.
ArtifactAst	parse(String resourceName, InputStream appXmlConfigInputStream) Generate a new ArtifactAst representation form the XML read from the provided inputStream.
ArtifactAst	parse(String artifactName, List<org.mule.runtime.api.util.Pair<String,InputStream>> appXmlConfigInputStreams) Generate a new ArtifactAst representation form the XML read from the provided inputStreams.
ArtifactAst	parse(String artifactName, String resourceName, InputStream appXmlConfigInputStream) Generate a new ArtifactAst representation form the XML read from the provided inputStream.
ArtifactAst	parse(String artifactName, URI... appXmlConfigUris) Generate a new ArtifactAst representation form the XML read from the provided uris.
ArtifactAst	parse(String artifactName, URL... appXmlConfigUrls) Generate a new ArtifactAst representation form the XML read from the provided urls.
ArtifactAst	parse(URI... appXmlConfigUris) Generate a new ArtifactAst representation form the XML read from the provided uris.
ArtifactAst	parse(URL... appXmlConfigUrls) Generate a new ArtifactAst representation form the XML read from the provided urls.
ArtifactAst	parseDocument(List<org.mule.runtime.api.util.Pair<String,Document>> appXmlConfigDocuments) Generate a new ArtifactAst representation form the XML DOM tree.
ArtifactAst	parseDocument(String artifactName, List<org.mule.runtime.api.util.Pair<String,Document>> appXmlConfigDocuments) Generate a new ArtifactAst representation from the XML DOM tree.
protected ArtifactAst	resolveImports(ArtifactAst base, Map<org.mule.runtime.dsl.api.ConfigResource,ArtifactAst> importedConfigs)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.ast.api.xml.AstXmlParser

builder

Constructor Detail

DefaultAstXmlParser

public DefaultAstXmlParser(ArtifactType artifactType,
                           Set<org.mule.runtime.api.meta.model.ExtensionModel> extensionModels,
                           ArtifactAst parentArtifact,
                           Optional<org.mule.runtime.extension.api.dsl.syntax.resources.spi.ExtensionSchemaGenerator> schemaGenerator,
                           org.mule.runtime.dsl.api.xml.parser.ParsingPropertyResolver propertyResolver,
                           ResolveEntityFailStrategy resolveEntityFailStrategy)

Method Detail

parseDocument

public ArtifactAst parseDocument(String artifactName,
                                 List<org.mule.runtime.api.util.Pair<String,Document>> appXmlConfigDocuments)

Description copied from interface: AstXmlParser

Generate a new ArtifactAst representation from the XML DOM tree.

The parsing process will resolve references in import tags. Relative paths will be resolved using the currently set ThreadContextClassLoader.

Note: The component metadata that is generated relies on data populated at the time of parsing the config XML into its Document. In the case of this method, the provided Document must be of level 3 and have that data populated for the component metadata about the underlying DSL to be accurate. The required data is a userData with key XmlMetadataAnnotations.METADATA_ANNOTATIONS_KEY and value of type XmlMetadataAnnotations on every node of the DOM tree.

Specified by:

parseDocument in interface AstXmlParser

Parameters:

artifactName - the name of the artifact to parse

appXmlConfigDocuments - the XML content to be parsed. The first part of each pair is the name to be used as fileName in the metadata of the generates ArtifactAst.

Returns:

the ArtifactAst representation of the provided XML config.

parseDocument

public ArtifactAst parseDocument(List<org.mule.runtime.api.util.Pair<String,Document>> appXmlConfigDocuments)

Description copied from interface: AstXmlParser

Generate a new ArtifactAst representation form the XML DOM tree.

The parsing process will resolve references in import tags. Relative paths will be resolved using the currently set ThreadContextClassLoader.

Note: The component metadata that is generated relies on data populated at the time of parsing the config XML into its Document. In the case of this method, the provided Document must be of level 3 and have that data populated for the component metadata about the underlying DSL to be accurate. The required data is a userData with key XmlMetadataAnnotations.METADATA_ANNOTATIONS_KEY and value of type XmlMetadataAnnotations on every node of the DOM tree.

Specified by:

parseDocument in interface AstXmlParser

Parameters:

appXmlConfigDocuments - the XML content to be parsed. The first part of each pair is the name to be used as fileName in the metadata of the generates ArtifactAst.

Returns:

the ArtifactAst representation of the provided XML config.

parse

public ArtifactAst parse(String artifactName,
                         List<org.mule.runtime.api.util.Pair<String,InputStream>> appXmlConfigInputStreams)

Description copied from interface: AstXmlParser

Generate a new ArtifactAst representation form the XML read from the provided inputStreams.

The parsing process will resolve references in import tags. Relative paths will be resolved using the currently set ThreadContextClassLoader.

Specified by:

parse in interface AstXmlParser

Parameters:

artifactName - the name of the artifact to parse

appXmlConfigInputStreams - the streams that will provide the XML content to be parsed. The first part of each pair is the name to be used as fileName in the metadata of the generates ArtifactAst.

Returns:

the ArtifactAst representation of the provided XML config.

parse

public ArtifactAst parse(List<org.mule.runtime.api.util.Pair<String,InputStream>> appXmlConfigInputStreams)

Description copied from interface: AstXmlParser

Generate a new ArtifactAst representation form the XML read from the provided inputStreams.

The parsing process will resolve references in import tags. Relative paths will be resolved using the currently set ThreadContextClassLoader.

Specified by:

parse in interface AstXmlParser

Parameters:

appXmlConfigInputStreams - the streams that will provide the XML content to be parsed. The first part of each pair is the name to be used as fileName in the metadata of the generates ArtifactAst.

Returns:

the ArtifactAst representation of the provided XML config.

parse

public ArtifactAst parse(String artifactName,
                         org.mule.runtime.dsl.api.ConfigResource... appXmlConfigResources)

Description copied from interface: AstXmlParser

Generate a new ArtifactAst representation form the XML read from the provided inputStreams.

The parsing process will resolve references in import tags. Relative paths will be resolved using the currently set ThreadContextClassLoader.

Specified by:

parse in interface AstXmlParser

Parameters:

artifactName - the name of the artifact to parse

appXmlConfigResources - the resources that will provide the XML content to be parsed.

Returns:

the ArtifactAst representation of the provided XML config.

parse

public ArtifactAst parse(org.mule.runtime.dsl.api.ConfigResource... appXmlConfigResources)

Description copied from interface: AstXmlParser

Generate a new ArtifactAst representation form the XML read from the provided inputStreams.

The parsing process will resolve references in import tags. Relative paths will be resolved using the currently set ThreadContextClassLoader.

Specified by:

parse in interface AstXmlParser

Parameters:

appXmlConfigResources - the resources that will provide the XML content to be parsed.

Returns:

the ArtifactAst representation of the provided XML config.

parse

public ArtifactAst parse(String artifactName,
                         String resourceName,
                         InputStream appXmlConfigInputStream)

Description copied from interface: AstXmlParser

Generate a new ArtifactAst representation form the XML read from the provided inputStream.

The parsing process will resolve references in import tags. Relative paths will be resolved using the currently set ThreadContextClassLoader.

Specified by:

parse in interface AstXmlParser

Parameters:

artifactName - the name of the artifact to parse

resourceName - the name to be used as fileName in the metadata of the generates ArtifactAst.

appXmlConfigInputStream - the stream that will provide the XML content to be parsed.

Returns:

the ArtifactAst representation of the provided XML config.

parse

public ArtifactAst parse(String resourceName,
                         InputStream appXmlConfigInputStream)

Description copied from interface: AstXmlParser

Generate a new ArtifactAst representation form the XML read from the provided inputStream.

The parsing process will resolve references in import tags. Relative paths will be resolved using the currently set ThreadContextClassLoader.

Specified by:

parse in interface AstXmlParser

Parameters:

resourceName - the name to be used as fileName in the metadata of the generates ArtifactAst.

appXmlConfigInputStream - the stream that will provide the XML content to be parsed.

Returns:

the ArtifactAst representation of the provided XML config.

parse

public ArtifactAst parse(String artifactName,
                         URI... appXmlConfigUris)

Description copied from interface: AstXmlParser

Generate a new ArtifactAst representation form the XML read from the provided uris.

The parsing process will resolve references in import tags. Relative paths will be resolved using the currently set ThreadContextClassLoader.

Specified by:

parse in interface AstXmlParser

Parameters:

artifactName - the name of the artifact to parse

appXmlConfigUris - the uris that will provide the XML content to be parsed.

Returns:

the ArtifactAst representation of the provided XML config.

parse

public ArtifactAst parse(URI... appXmlConfigUris)

Description copied from interface: AstXmlParser

Generate a new ArtifactAst representation form the XML read from the provided uris.

The parsing process will resolve references in import tags. Relative paths will be resolved using the currently set ThreadContextClassLoader.

Specified by:

parse in interface AstXmlParser

Parameters:

appXmlConfigUris - the uris that will provide the XML content to be parsed.

Returns:

the ArtifactAst representation of the provided XML config.

parse

public ArtifactAst parse(String artifactName,
                         URL... appXmlConfigUrls)

Description copied from interface: AstXmlParser

Generate a new ArtifactAst representation form the XML read from the provided urls.

The parsing process will resolve references in import tags. Relative paths will be resolved using the currently set ThreadContextClassLoader.

Specified by:

parse in interface AstXmlParser

Parameters:

artifactName - the name of the artifact to parse

appXmlConfigUrls - the urls that will provide the XML content to be parsed.

Returns:

the ArtifactAst representation of the provided XML config.

parse

public ArtifactAst parse(URL... appXmlConfigUrls)

Description copied from interface: AstXmlParser

Generate a new ArtifactAst representation form the XML read from the provided urls.

The parsing process will resolve references in import tags. Relative paths will be resolved using the currently set ThreadContextClassLoader.

Specified by:

parse in interface AstXmlParser

Parameters:

appXmlConfigUrls - the urls that will provide the XML content to be parsed.

Returns:

the ArtifactAst representation of the provided XML config.

resolveImports

protected ArtifactAst resolveImports(ArtifactAst base,
                                     Map<org.mule.runtime.dsl.api.ConfigResource,ArtifactAst> importedConfigs)

doParse

protected ArtifactAst doParse(String artifactName,
                              Document document,
                              String resourceName,
                              URL resourceUrl,
                              List<ImportedResource> importChain)