org.mule.runtime.module.extension.internal.config.dsl

Class ExtensionDefinitionParser

java.lang.Object

org.mule.runtime.module.extension.internal.config.dsl.ExtensionDefinitionParser

Direct Known Subclasses:

AbstractComponentDefinitionParser, ConfigurationDefinitionParser, ConnectionProviderDefinitionParser, ObjectTypeParameterParser, ParameterGroupParser, RouteComponentParser, SourceDefinitionParser

public abstract class ExtensionDefinitionParser
extends Object

Base class for parsers delegates which generate ComponentBuildingDefinition instances for the specific components types (configs, operations, providers, etc) which constitute an extension.

It works under the premise that this parser will be used to generate an instance of AbstractExtensionObjectFactory, using the AbstractExtensionObjectFactory.setParameters(Map) to provide a map of values containing the parsed attributes.

It also gives the opportunity to generate extra ComponentBuildingDefinition which can also be registered by invoking addDefinition(ComponentBuildingDefinition)

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected org.mule.runtime.dsl.api.component.ComponentBuildingDefinition.Builder	baseDefinitionBuilder
protected static String	CONFIG_PROVIDER_ATTRIBUTE_NAME
protected static String	CURSOR_PROVIDER_FACTORY_FIELD_NAME
protected org.mule.runtime.extension.api.dsl.syntax.resolver.DslSyntaxResolver	dslResolver
protected Map<String,String>	infrastructureParameterMap
protected List<ObjectParsingDelegate>	objectParsingDelegates
protected ExtensionParsingContext	parsingContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExtensionDefinitionParser(org.mule.runtime.dsl.api.component.ComponentBuildingDefinition.Builder baseDefinitionBuilder, org.mule.runtime.extension.api.dsl.syntax.resolver.DslSyntaxResolver dslSyntaxResolver, ExtensionParsingContext parsingContext) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected void	addDefinition(org.mule.runtime.dsl.api.component.ComponentBuildingDefinition definition) Adds the given definition to the list of definitions that the parse() method generates by default
protected void	addParameter(String key, org.mule.runtime.dsl.api.component.AttributeDefinition.Builder definitionBuilder)
protected abstract org.mule.runtime.dsl.api.component.ComponentBuildingDefinition.Builder	doParse(org.mule.runtime.dsl.api.component.ComponentBuildingDefinition.Builder definitionBuilder) Implementations place their custom parsing logic here.
protected String	getChildKey(String key)
protected ClassLoader	getContextClassLoader()
protected List<org.mule.runtime.api.meta.model.parameter.ParameterModel>	getFlatParameters(List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> inlineGroups, List<org.mule.runtime.api.meta.model.parameter.ParameterModel> parameters)
protected Optional<String>	getInfrastructureParameterName(org.mule.metadata.api.model.MetadataType fieldType)
protected List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel>	getInlineGroups(org.mule.runtime.api.meta.model.parameter.ParameterizedModel model)
List<org.mule.runtime.dsl.api.component.ComponentBuildingDefinition>	parse() Creates a list of ComponentBuildingDefinition built on copies of baseDefinitionBuilder.
protected org.mule.runtime.dsl.api.component.AttributeDefinition.Builder	parseAttributeParameter(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel) Registers a definition for parsing the given parameterModel as an element attribute
protected org.mule.runtime.dsl.api.component.AttributeDefinition.Builder	parseAttributeParameter(String key, String name, org.mule.metadata.api.model.MetadataType type, Object defaultValue, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, boolean required, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties) Registers a definition for parsing the given parameterModel as an element attribute
protected void	parseCollectionParameter(org.mule.runtime.api.meta.model.parameter.ParameterModel parameter, org.mule.metadata.api.model.ArrayType arrayType, org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax parameterDsl) Registers a definition for a ParameterModel which represents an ArrayType
protected void	parseCollectionParameter(String key, String name, org.mule.metadata.api.model.ArrayType arrayType, Object defaultValue, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, boolean required, org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax parameterDsl, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties) Registers a definition for a ParameterModel which represents an ArrayType
protected void	parseFields(org.mule.metadata.api.model.ObjectType type, org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax typeDsl)
protected void	parseFields(org.mule.metadata.api.model.ObjectType type, org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax typeDsl, Map<String,org.mule.runtime.api.meta.model.parameter.ParameterRole> parametersRole)
protected void	parseFromTextExpression(org.mule.runtime.api.meta.model.parameter.ParameterModel parameter, org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax paramDsl, Supplier<org.mule.runtime.dsl.api.component.TypeConverter> typeConverter)
protected void	parseFromTextExpression(String key, org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax paramDsl, Supplier<org.mule.runtime.dsl.api.component.TypeConverter> typeConverter)
protected void	parseInlineParameterGroup(org.mule.runtime.api.meta.model.parameter.ParameterGroupModel group)
protected void	parseMapParameters(org.mule.runtime.api.meta.model.parameter.ParameterModel parameter, org.mule.metadata.api.model.ObjectType objectType, org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax paramDsl) Registers a definition for a ParameterModel which represents an open ObjectType
protected void	parseMapParameters(String key, String name, org.mule.metadata.api.model.ObjectType dictionaryType, Object defaultValue, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, boolean required, org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax paramDsl, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties) Registers a definition for a ParameterModel which represents an open ObjectType
protected void	parseNestedComponents(List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents) Parses the given nestedComponents and generates matching definitions
protected void	parseObject(String key, String name, org.mule.metadata.api.model.ObjectType type, Object defaultValue, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, boolean required, boolean acceptsReferences, org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax elementDsl, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)
protected void	parseObjectParameter(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel, org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax paramDsl) Registers a definition for a ParameterModel which represents an ObjectType
protected void	parseObjectParameter(String key, String name, org.mule.metadata.api.model.ObjectType type, Object defaultValue, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, boolean required, boolean acceptsReferences, org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax elementDsl, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties) Registers a definition for a ParameterModel which represents an ObjectType
protected void	parseParameters(List<org.mule.runtime.api.meta.model.parameter.ParameterModel> parameters) Parsers the given parameters and generates matching definitions
protected void	parseParameters(org.mule.runtime.api.meta.model.parameter.ParameterizedModel parameterizedModel)
protected <T> ValueResolver<T>	resolverOf(String parameterName, org.mule.metadata.api.model.MetadataType expectedType, Object value, Object defaultValue, org.mule.runtime.api.meta.ExpressionSupport expressionSupport, boolean required, Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties, boolean acceptsReferences)

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_PROVIDER_ATTRIBUTE_NAME

protected static final String CONFIG_PROVIDER_ATTRIBUTE_NAME

See Also:

Constant Field Values

CURSOR_PROVIDER_FACTORY_FIELD_NAME

protected static final String CURSOR_PROVIDER_FACTORY_FIELD_NAME

See Also:

Constant Field Values

parsingContext

protected final ExtensionParsingContext parsingContext

objectParsingDelegates

protected final List<ObjectParsingDelegate> objectParsingDelegates

dslResolver

protected final org.mule.runtime.extension.api.dsl.syntax.resolver.DslSyntaxResolver dslResolver

baseDefinitionBuilder

protected final org.mule.runtime.dsl.api.component.ComponentBuildingDefinition.Builder baseDefinitionBuilder

infrastructureParameterMap

protected final Map<String,String> infrastructureParameterMap

Constructor Detail

ExtensionDefinitionParser

protected ExtensionDefinitionParser(org.mule.runtime.dsl.api.component.ComponentBuildingDefinition.Builder baseDefinitionBuilder,
                                    org.mule.runtime.extension.api.dsl.syntax.resolver.DslSyntaxResolver dslSyntaxResolver,
                                    ExtensionParsingContext parsingContext)

Creates a new instance

Parameters:

baseDefinitionBuilder - a ComponentBuildingDefinition.Builder used as a prototype to generate new definitions

dslSyntaxResolver - a DslSyntaxResolver instance associated with the ExtensionModel being parsed

parsingContext - the ExtensionParsingContext in which this parser operates

Method Detail

parse

public final List<org.mule.runtime.dsl.api.component.ComponentBuildingDefinition> parse()
                                                                                 throws ConfigurationException

Creates a list of ComponentBuildingDefinition built on copies of baseDefinitionBuilder. It also sets the parsed parsed parameters on the backing AbstractExtensionObjectFactory

Returns:

a list with the generated ComponentBuildingDefinition

Throws:

ConfigurationException - if a parsing error occurs

doParse

protected abstract org.mule.runtime.dsl.api.component.ComponentBuildingDefinition.Builder doParse(org.mule.runtime.dsl.api.component.ComponentBuildingDefinition.Builder definitionBuilder)
                                                                                           throws ConfigurationException

Implementations place their custom parsing logic here.

Parameters:

definitionBuilder - the ComponentBuildingDefinition.Builder on which implementation are to define their stuff

Throws:

ConfigurationException - if a parsing error occurs

parseNestedComponents

protected void parseNestedComponents(List<? extends org.mule.runtime.api.meta.model.nested.NestableElementModel> nestedComponents)

Parses the given nestedComponents and generates matching definitions

Parameters:

nestedComponents - a list of NestableElementModel

parseParameters

protected void parseParameters(List<org.mule.runtime.api.meta.model.parameter.ParameterModel> parameters)

Parsers the given parameters and generates matching definitions

Parameters:

parameters - a list of ParameterModel

parseMapParameters

protected void parseMapParameters(org.mule.runtime.api.meta.model.parameter.ParameterModel parameter,
                                  org.mule.metadata.api.model.ObjectType objectType,
                                  org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax paramDsl)

Registers a definition for a ParameterModel which represents an open ObjectType

Parameters:

parameter - a ParameterModel

objectType - a ObjectType

parseMapParameters

protected void parseMapParameters(String key,
                                  String name,
                                  org.mule.metadata.api.model.ObjectType dictionaryType,
                                  Object defaultValue,
                                  org.mule.runtime.api.meta.ExpressionSupport expressionSupport,
                                  boolean required,
                                  org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax paramDsl,
                                  Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)

Registers a definition for a ParameterModel which represents an open ObjectType

Parameters:

key - the key that the parsed value should have on the parsed parameter's map

name - the parameter's name

dictionaryType - the parameter's open ObjectType

defaultValue - the parameter's default value

expressionSupport - the parameter's ExpressionSupport

required - whether the parameter is required

parseFields

protected void parseFields(org.mule.metadata.api.model.ObjectType type,
                           org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax typeDsl,
                           Map<String,org.mule.runtime.api.meta.model.parameter.ParameterRole> parametersRole)

parseFields

protected void parseFields(org.mule.metadata.api.model.ObjectType type,
                           org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax typeDsl)

parseCollectionParameter

protected void parseCollectionParameter(org.mule.runtime.api.meta.model.parameter.ParameterModel parameter,
                                        org.mule.metadata.api.model.ArrayType arrayType,
                                        org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax parameterDsl)

Registers a definition for a ParameterModel which represents an ArrayType

Parameters:

parameter - a ParameterModel

arrayType - an ArrayType

parseCollectionParameter

protected void parseCollectionParameter(String key,
                                        String name,
                                        org.mule.metadata.api.model.ArrayType arrayType,
                                        Object defaultValue,
                                        org.mule.runtime.api.meta.ExpressionSupport expressionSupport,
                                        boolean required,
                                        org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax parameterDsl,
                                        Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)

Registers a definition for a ParameterModel which represents an ArrayType

Parameters:

key - the key that the parsed value should have on the parsed parameter's map

name - the parameter's name

arrayType - the parameter's ArrayType

defaultValue - the parameter's default value

expressionSupport - the parameter's ExpressionSupport

required - whether the parameter is required

getContextClassLoader

protected ClassLoader getContextClassLoader()

resolverOf

protected <T> ValueResolver<T> resolverOf(String parameterName,
                                          org.mule.metadata.api.model.MetadataType expectedType,
                                          Object value,
                                          Object defaultValue,
                                          org.mule.runtime.api.meta.ExpressionSupport expressionSupport,
                                          boolean required,
                                          Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties,
                                          boolean acceptsReferences)

parseFromTextExpression

protected void parseFromTextExpression(org.mule.runtime.api.meta.model.parameter.ParameterModel parameter,
                                       org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax paramDsl,
                                       Supplier<org.mule.runtime.dsl.api.component.TypeConverter> typeConverter)

parseFromTextExpression

protected void parseFromTextExpression(String key,
                                       org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax paramDsl,
                                       Supplier<org.mule.runtime.dsl.api.component.TypeConverter> typeConverter)

parseAttributeParameter

protected org.mule.runtime.dsl.api.component.AttributeDefinition.Builder parseAttributeParameter(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel)

Registers a definition for parsing the given parameterModel as an element attribute

Parameters:

parameterModel - a ParameterModel

Returns:

an AttributeDefinition.Builder

parseAttributeParameter

protected org.mule.runtime.dsl.api.component.AttributeDefinition.Builder parseAttributeParameter(String key,
                                                                                                 String name,
                                                                                                 org.mule.metadata.api.model.MetadataType type,
                                                                                                 Object defaultValue,
                                                                                                 org.mule.runtime.api.meta.ExpressionSupport expressionSupport,
                                                                                                 boolean required,
                                                                                                 Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)

Registers a definition for parsing the given parameterModel as an element attribute

Parameters:

key - the key that the parsed value should have on the parsed parameter's map

name - the parameter's name

type - the parameter's type

defaultValue - the parameter's default value

expressionSupport - the parameter's ExpressionSupport

required - whether the parameter is required or not

Returns:

an AttributeDefinition.Builder

parseObjectParameter

protected void parseObjectParameter(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel,
                                    org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax paramDsl)

Registers a definition for a ParameterModel which represents an ObjectType

Parameters:

parameterModel - a ParameterModel

parseObjectParameter

protected void parseObjectParameter(String key,
                                    String name,
                                    org.mule.metadata.api.model.ObjectType type,
                                    Object defaultValue,
                                    org.mule.runtime.api.meta.ExpressionSupport expressionSupport,
                                    boolean required,
                                    boolean acceptsReferences,
                                    org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax elementDsl,
                                    Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)

Registers a definition for a ParameterModel which represents an ObjectType

Parameters:

key - the key that the parsed value should have on the parsed parameter's map

name - the parameter's name

type - an ObjectType

defaultValue - the parameter's default value

expressionSupport - the parameter's ExpressionSupport

required - whether the parameter is required or not

modelProperties - parameter's ModelPropertys

parseObject

protected void parseObject(String key,
                           String name,
                           org.mule.metadata.api.model.ObjectType type,
                           Object defaultValue,
                           org.mule.runtime.api.meta.ExpressionSupport expressionSupport,
                           boolean required,
                           boolean acceptsReferences,
                           org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax elementDsl,
                           Set<org.mule.runtime.api.meta.model.ModelProperty> modelProperties)

addDefinition

protected void addDefinition(org.mule.runtime.dsl.api.component.ComponentBuildingDefinition definition)

Adds the given definition to the list of definitions that the parse() method generates by default

Parameters:

definition - a ComponentBuildingDefinition

addParameter

protected void addParameter(String key,
                            org.mule.runtime.dsl.api.component.AttributeDefinition.Builder definitionBuilder)

getInlineGroups

protected List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> getInlineGroups(org.mule.runtime.api.meta.model.parameter.ParameterizedModel model)

getChildKey

protected String getChildKey(String key)

parseParameters

protected void parseParameters(org.mule.runtime.api.meta.model.parameter.ParameterizedModel parameterizedModel)
                        throws ConfigurationException

Throws:

ConfigurationException

parseInlineParameterGroup

protected void parseInlineParameterGroup(org.mule.runtime.api.meta.model.parameter.ParameterGroupModel group)
                                  throws ConfigurationException

Throws:

ConfigurationException

getFlatParameters

protected List<org.mule.runtime.api.meta.model.parameter.ParameterModel> getFlatParameters(List<org.mule.runtime.api.meta.model.parameter.ParameterGroupModel> inlineGroups,
                                                                                           List<org.mule.runtime.api.meta.model.parameter.ParameterModel> parameters)

getInfrastructureParameterName

protected Optional<String> getInfrastructureParameterName(org.mule.metadata.api.model.MetadataType fieldType)