org.mule.runtime.ast.api.xml

Interface AstXmlParser

All Known Implementing Classes:

DefaultAstXmlParser

public interface AstXmlParser

Provides a mechanism to parse a XML config for a deployable mule artifact into an ArtifactAst.

This parser needs to know the extension models that are used by the artifact in order to generate the ArtifactAst correctly.

A single parser instance may be used to generate more than one ArtifactAst from different configs, since no state specific to a parsing process is kept by this parser. The same parser may be used to parse different configs concurrently, as well.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AstXmlParser.Builder A builder for creating AstXmlParser instances.

Field Summary

Fields

Modifier and Type	Field and Description
static org.mule.runtime.api.component.ComponentIdentifier	ANNOTATIONS_IDENTIFIER
static org.mule.runtime.api.component.ComponentIdentifier	DOMAIN_ROOT_IDENTIFIER
static org.mule.runtime.api.component.ComponentIdentifier	IMPORT_IDENTIFIER
static org.mule.runtime.api.component.ComponentIdentifier	MULE_ROOT_IDENTIFIER

Method Summary

Modifier and Type	Method and Description
static AstXmlParser.Builder	builder() Creates a builder for an AstXmlParser.
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 resourceName, InputStream appXmlConfigInputStream) Generate a new ArtifactAst representation form the XML read from the provided inputStream.
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.

Field Detail

IMPORT_IDENTIFIER

static final org.mule.runtime.api.component.ComponentIdentifier IMPORT_IDENTIFIER

MULE_ROOT_IDENTIFIER

static final org.mule.runtime.api.component.ComponentIdentifier MULE_ROOT_IDENTIFIER

DOMAIN_ROOT_IDENTIFIER

static final org.mule.runtime.api.component.ComponentIdentifier DOMAIN_ROOT_IDENTIFIER

ANNOTATIONS_IDENTIFIER

static final org.mule.runtime.api.component.ComponentIdentifier ANNOTATIONS_IDENTIFIER

Method Detail

builder

static AstXmlParser.Builder builder()

Creates a builder for an AstXmlParser.

Returns:

a builder for an AstXmlParser.

parse

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.

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

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

ArtifactAst parse(String resourceName,
                  InputStream appXmlConfigInputStream)

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.

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

ArtifactAst parse(URI... appXmlConfigUris)

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.

Parameters:

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

Returns:

the ArtifactAst representation of the provided XML config.

parse

ArtifactAst parse(URL... appXmlConfigUrls)

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.

Parameters:

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

Returns:

the ArtifactAst representation of the provided XML config.