org.mule.runtime.config.internal.model

Class ApplicationModel

java.lang.Object

org.mule.runtime.config.internal.model.ApplicationModel

All Implemented Interfaces:

org.mule.runtime.ast.api.ArtifactAst

public class ApplicationModel
extends Object
implements org.mule.runtime.ast.api.ArtifactAst

An ApplicationModel holds a representation of all the artifact configuration using an abstract model to represent any configuration option.

This model is represented by a set of ComponentModel. Each ComponentModel holds a piece of configuration and may have children ComponentModels as defined in the artifact configuration.

Once the set of ComponentModel gets created from the application ConfigFiles the ApplicationModel executes a set of common validations dictated by the configuration semantics.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static org.mule.runtime.api.component.ComponentIdentifier	ANNOTATIONS_ELEMENT_IDENTIFIER
static String	BATCH_NAMESPACE
static String	CLASS_ATTRIBUTE
static String	CUSTOM_TRANSFORMER
static org.mule.runtime.api.component.ComponentIdentifier	CUSTOM_TRANSFORMER_IDENTIFIER
static String	DESCRIPTION_ELEMENT
static org.mule.runtime.api.component.ComponentIdentifier	DESCRIPTION_IDENTIFIER
static org.mule.runtime.api.component.ComponentIdentifier	DOC_DESCRIPTION_IDENTIFIER
static String	DOC_NAMESPACE
static String	ERROR_MAPPING
static org.mule.runtime.api.component.ComponentIdentifier	ERROR_MAPPING_IDENTIFIER
static String	EXCEPTION_STRATEGY_REFERENCE_ELEMENT
static org.mule.runtime.api.component.ComponentIdentifier	EXCEPTION_STRATEGY_REFERENCE_IDENTIFIER
static String	GLOBAL_PROPERTY
static org.mule.runtime.api.component.ComponentIdentifier	GLOBAL_PROPERTY_IDENTIFIER
static String	HTTP_POLICY
static org.mule.runtime.api.component.ComponentIdentifier	HTTP_PROXY_OPERATION_IDENTIFIER
static org.mule.runtime.api.component.ComponentIdentifier	HTTP_PROXY_POLICY_IDENTIFIER
static org.mule.runtime.api.component.ComponentIdentifier	HTTP_PROXY_SOURCE_POLICY_IDENTIFIER
static String	MAX_REDELIVERY_ATTEMPTS_ROLLBACK_ES_ATTRIBUTE
static org.mule.runtime.api.component.ComponentIdentifier	MODULE_OPERATION_CHAIN
static org.mule.runtime.api.component.ComponentIdentifier	MULE_PROPERTIES_IDENTIFIER
static org.mule.runtime.api.component.ComponentIdentifier	MULE_PROPERTY_IDENTIFIER
static String	MULE_SECURITY_NAMESPACE
static String	MULE_XML_NAMESPACE
static org.mule.runtime.api.component.ComponentIdentifier	MUNIT_AFTER_SUITE_IDENTIFIER
static org.mule.runtime.api.component.ComponentIdentifier	MUNIT_AFTER_TEST_IDENTIFIER
static org.mule.runtime.api.component.ComponentIdentifier	MUNIT_BEFORE_SUITE_IDENTIFIER
static org.mule.runtime.api.component.ComponentIdentifier	MUNIT_BEFORE_TEST_IDENTIFIER
static String	MUNIT_PREFIX
static org.mule.runtime.api.component.ComponentIdentifier	MUNIT_TEST_IDENTIFIER
static String	NAME_ATTRIBUTE
static String	OBJECT_ELEMENT
static org.mule.runtime.api.component.ComponentIdentifier	OBJECT_IDENTIFIER
static String	ON_ERROR
static org.mule.runtime.api.component.ComponentIdentifier	ON_ERROR_IDENTIFIER
static String	PARSER_TEST_NAMESPACE
static String	PGP_NAMESPACE
static String	POLICY_ROOT_ELEMENT
static String	PROPERTIES_ELEMENT
static String	PROPERTY_ELEMENT
static String	REDELIVERY_POLICY_ELEMENT
static org.mule.runtime.api.component.ComponentIdentifier	REDELIVERY_POLICY_IDENTIFIER
static String	REFERENCE_ATTRIBUTE
static String	SECURITY_MANAGER
static org.mule.runtime.api.component.ComponentIdentifier	SECURITY_MANAGER_IDENTIFIER
static String	SPRING_SECURITY_NAMESPACE
static String	TEST_NAMESPACE
static org.mule.runtime.api.component.ComponentIdentifier	TRANSFORMER_IDENTIFIER
static String	TRANSFORMER_REFERENCE_ELEMENT
static String	TYPE_ES_ATTRIBUTE
static String	VALUE_ATTRIBUTE
static String	WHEN_CHOICE_ES_ATTRIBUTE
static String	XSL_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
ApplicationModel(ArtifactConfig artifactConfig, org.mule.runtime.app.declaration.api.ArtifactDeclaration artifactDeclaration, ResourceProvider externalResourceProvider) Creates an {code ApplicationModel} from a ArtifactConfig.
ApplicationModel(ArtifactConfig artifactConfig, org.mule.runtime.app.declaration.api.ArtifactDeclaration artifactDeclaration, Set<org.mule.runtime.api.meta.model.ExtensionModel> extensionModels, Map<String,String> deploymentProperties, Optional<org.mule.runtime.api.component.ConfigurationProperties> parentConfigurationProperties, Optional<ComponentBuildingDefinitionRegistry> componentBuildingDefinitionRegistry, ResourceProvider externalResourceProvider) Creates an {code ApplicationModel} from a ArtifactConfig.
ApplicationModel(ArtifactConfig artifactConfig, org.mule.runtime.app.declaration.api.ArtifactDeclaration artifactDeclaration, Set<org.mule.runtime.api.meta.model.ExtensionModel> extensionModels, Map<String,String> deploymentProperties, Optional<org.mule.runtime.api.component.ConfigurationProperties> parentConfigurationProperties, Optional<ComponentBuildingDefinitionRegistry> componentBuildingDefinitionRegistry, ResourceProvider externalResourceProvider, boolean runtimeMode)

Method Summary

Modifier and Type	Method and Description
void	close()
void	executeOnEveryComponentTree(Consumer<ComponentModel> task)
void	executeOnEveryFlow(Consumer<ComponentModel> task)
void	executeOnEveryMuleComponentTree(Consumer<ComponentModel> task)
void	executeOnEveryRootElement(Consumer<ComponentModel> task)
void	executeOnlyOnMuleRoot(Consumer<ComponentModel> task)
Optional<ComponentModel>	findComponentDefinitionModel(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier)
Optional<ComponentModel>	findNamedElement(String name) Find a named component.
Optional<ComponentModel>	findTopLevelNamedComponent(String name) Find a named component configuration.
org.mule.runtime.api.component.ConfigurationProperties	getConfigurationProperties()
ComponentModel	getRootComponentModel() TODO MULE-9688: When the model it's made immutable we will also provide the parent component for navigation and this will not be needed anymore.
void	macroExpandXmlSdkComponents(Set<org.mule.runtime.api.meta.model.ExtensionModel> extensionModels)
Spliterator<org.mule.runtime.ast.api.ComponentAst>	recursiveSpliterator()
Stream<org.mule.runtime.ast.api.ComponentAst>	recursiveStream()
Stream<org.mule.runtime.api.util.Pair<org.mule.runtime.ast.api.ComponentAst,List<org.mule.runtime.ast.api.ComponentAst>>>	recursiveStreamWithHierarchy()
void	resolveComponentTypes() Resolves the types of each component model when possible.
Spliterator<org.mule.runtime.ast.api.ComponentAst>	topLevelComponentsSpliterator()
Stream<org.mule.runtime.ast.api.ComponentAst>	topLevelComponentsStream()

Methods inherited from class java.lang.Object

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

Field Detail

POLICY_ROOT_ELEMENT

public static final String POLICY_ROOT_ELEMENT

See Also:

Constant Field Values

ERROR_MAPPING

public static final String ERROR_MAPPING

See Also:

Constant Field Values

ON_ERROR

public static final String ON_ERROR

See Also:

Constant Field Values

MAX_REDELIVERY_ATTEMPTS_ROLLBACK_ES_ATTRIBUTE

public static final String MAX_REDELIVERY_ATTEMPTS_ROLLBACK_ES_ATTRIBUTE

See Also:

Constant Field Values

WHEN_CHOICE_ES_ATTRIBUTE

public static final String WHEN_CHOICE_ES_ATTRIBUTE

See Also:

Constant Field Values

TYPE_ES_ATTRIBUTE

public static final String TYPE_ES_ATTRIBUTE

See Also:

Constant Field Values

EXCEPTION_STRATEGY_REFERENCE_ELEMENT

public static final String EXCEPTION_STRATEGY_REFERENCE_ELEMENT

See Also:

Constant Field Values

PROPERTY_ELEMENT

public static final String PROPERTY_ELEMENT

See Also:

Constant Field Values

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

See Also:

Constant Field Values

REFERENCE_ATTRIBUTE

public static final String REFERENCE_ATTRIBUTE

See Also:

Constant Field Values

VALUE_ATTRIBUTE

public static final String VALUE_ATTRIBUTE

See Also:

Constant Field Values

TRANSFORMER_REFERENCE_ELEMENT

public static final String TRANSFORMER_REFERENCE_ELEMENT

See Also:

Constant Field Values

CUSTOM_TRANSFORMER

public static final String CUSTOM_TRANSFORMER

See Also:

Constant Field Values

DESCRIPTION_ELEMENT

public static final String DESCRIPTION_ELEMENT

See Also:

Constant Field Values

PROPERTIES_ELEMENT

public static final String PROPERTIES_ELEMENT

See Also:

Constant Field Values

REDELIVERY_POLICY_ELEMENT

public static final String REDELIVERY_POLICY_ELEMENT

See Also:

Constant Field Values

TEST_NAMESPACE

public static final String TEST_NAMESPACE

See Also:

Constant Field Values

DOC_NAMESPACE

public static final String DOC_NAMESPACE

See Also:

Constant Field Values

SPRING_SECURITY_NAMESPACE

public static final String SPRING_SECURITY_NAMESPACE

See Also:

Constant Field Values

MULE_SECURITY_NAMESPACE

public static final String MULE_SECURITY_NAMESPACE

See Also:

Constant Field Values

MULE_XML_NAMESPACE

public static final String MULE_XML_NAMESPACE

See Also:

Constant Field Values

PGP_NAMESPACE

public static final String PGP_NAMESPACE

See Also:

Constant Field Values

XSL_NAMESPACE

public static final String XSL_NAMESPACE

See Also:

Constant Field Values

BATCH_NAMESPACE

public static final String BATCH_NAMESPACE

See Also:

Constant Field Values

PARSER_TEST_NAMESPACE

public static final String PARSER_TEST_NAMESPACE

See Also:

Constant Field Values

GLOBAL_PROPERTY

public static final String GLOBAL_PROPERTY

See Also:

Constant Field Values

SECURITY_MANAGER

public static final String SECURITY_MANAGER

See Also:

Constant Field Values

OBJECT_ELEMENT

public static final String OBJECT_ELEMENT

See Also:

Constant Field Values

EXCEPTION_STRATEGY_REFERENCE_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier EXCEPTION_STRATEGY_REFERENCE_IDENTIFIER

ERROR_MAPPING_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier ERROR_MAPPING_IDENTIFIER

ON_ERROR_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier ON_ERROR_IDENTIFIER

MULE_PROPERTY_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier MULE_PROPERTY_IDENTIFIER

MULE_PROPERTIES_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier MULE_PROPERTIES_IDENTIFIER

ANNOTATIONS_ELEMENT_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier ANNOTATIONS_ELEMENT_IDENTIFIER

TRANSFORMER_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier TRANSFORMER_IDENTIFIER

CUSTOM_TRANSFORMER_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier CUSTOM_TRANSFORMER_IDENTIFIER

DOC_DESCRIPTION_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier DOC_DESCRIPTION_IDENTIFIER

DESCRIPTION_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier DESCRIPTION_IDENTIFIER

OBJECT_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier OBJECT_IDENTIFIER

REDELIVERY_POLICY_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier REDELIVERY_POLICY_IDENTIFIER

GLOBAL_PROPERTY_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier GLOBAL_PROPERTY_IDENTIFIER

SECURITY_MANAGER_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier SECURITY_MANAGER_IDENTIFIER

MODULE_OPERATION_CHAIN

public static final org.mule.runtime.api.component.ComponentIdentifier MODULE_OPERATION_CHAIN

MUNIT_PREFIX

public static final String MUNIT_PREFIX

See Also:

Constant Field Values

MUNIT_TEST_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier MUNIT_TEST_IDENTIFIER

MUNIT_BEFORE_TEST_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier MUNIT_BEFORE_TEST_IDENTIFIER

MUNIT_BEFORE_SUITE_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier MUNIT_BEFORE_SUITE_IDENTIFIER

MUNIT_AFTER_TEST_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier MUNIT_AFTER_TEST_IDENTIFIER

MUNIT_AFTER_SUITE_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier MUNIT_AFTER_SUITE_IDENTIFIER

HTTP_POLICY

public static final String HTTP_POLICY

See Also:

Constant Field Values

HTTP_PROXY_SOURCE_POLICY_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier HTTP_PROXY_SOURCE_POLICY_IDENTIFIER

HTTP_PROXY_OPERATION_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier HTTP_PROXY_OPERATION_IDENTIFIER

HTTP_PROXY_POLICY_IDENTIFIER

public static final org.mule.runtime.api.component.ComponentIdentifier HTTP_PROXY_POLICY_IDENTIFIER

CLASS_ATTRIBUTE

public static final String CLASS_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

ApplicationModel

public ApplicationModel(ArtifactConfig artifactConfig,
                        org.mule.runtime.app.declaration.api.ArtifactDeclaration artifactDeclaration,
                        ResourceProvider externalResourceProvider)
                 throws Exception

Creates an {code ApplicationModel} from a ArtifactConfig.

A set of validations are applied that may make creation fail.

Parameters:

artifactConfig - the mule artifact configuration content.

artifactDeclaration - an ArtifactDeclaration

Throws:

Exception - when the application configuration has semantic errors.

ApplicationModel

public ApplicationModel(ArtifactConfig artifactConfig,
                        org.mule.runtime.app.declaration.api.ArtifactDeclaration artifactDeclaration,
                        Set<org.mule.runtime.api.meta.model.ExtensionModel> extensionModels,
                        Map<String,String> deploymentProperties,
                        Optional<org.mule.runtime.api.component.ConfigurationProperties> parentConfigurationProperties,
                        Optional<ComponentBuildingDefinitionRegistry> componentBuildingDefinitionRegistry,
                        ResourceProvider externalResourceProvider)
                 throws Exception

Creates an {code ApplicationModel} from a ArtifactConfig.

A set of validations are applied that may make creation fail.

Parameters:

artifactConfig - the mule artifact configuration content.

artifactDeclaration - an ArtifactDeclaration

extensionModels - Set of extensionModels that will be used to type componentModels

parentConfigurationProperties - the ConfigurationProperties of the parent artifact. For instance, application will receive the domain resolver.

componentBuildingDefinitionRegistry - an optional ComponentBuildingDefinitionRegistry used to correlate items in this model to their definitions expanded) false implies the mule is being created from a tooling perspective.

externalResourceProvider - the provider for configuration properties files and ${file::name.txt} placeholders

Throws:

Exception - when the application configuration has semantic errors.

ApplicationModel

public ApplicationModel(ArtifactConfig artifactConfig,
                        org.mule.runtime.app.declaration.api.ArtifactDeclaration artifactDeclaration,
                        Set<org.mule.runtime.api.meta.model.ExtensionModel> extensionModels,
                        Map<String,String> deploymentProperties,
                        Optional<org.mule.runtime.api.component.ConfigurationProperties> parentConfigurationProperties,
                        Optional<ComponentBuildingDefinitionRegistry> componentBuildingDefinitionRegistry,
                        ResourceProvider externalResourceProvider,
                        boolean runtimeMode)
                 throws Exception

Throws:

Exception

Method Detail

macroExpandXmlSdkComponents

public void macroExpandXmlSdkComponents(Set<org.mule.runtime.api.meta.model.ExtensionModel> extensionModels)

close

public void close()

resolveComponentTypes

public void resolveComponentTypes()

Resolves the types of each component model when possible.

findComponentDefinitionModel

public Optional<ComponentModel> findComponentDefinitionModel(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier)

executeOnEveryComponentTree

public void executeOnEveryComponentTree(Consumer<ComponentModel> task)

executeOnEveryMuleComponentTree

public void executeOnEveryMuleComponentTree(Consumer<ComponentModel> task)

executeOnlyOnMuleRoot

public void executeOnlyOnMuleRoot(Consumer<ComponentModel> task)

executeOnEveryRootElement

public void executeOnEveryRootElement(Consumer<ComponentModel> task)

executeOnEveryFlow

public void executeOnEveryFlow(Consumer<ComponentModel> task)

getRootComponentModel

public ComponentModel getRootComponentModel()

TODO MULE-9688: When the model it's made immutable we will also provide the parent component for navigation and this will not be needed anymore.

Returns:

the root component model

findTopLevelNamedComponent

public Optional<ComponentModel> findTopLevelNamedComponent(String name)

Find a named component configuration.

Parameters:

name - the expected value for the name attribute configuration.

Returns:

the component if present, if not, an empty Optional

findNamedElement

public Optional<ComponentModel> findNamedElement(String name)

Find a named component.

Parameters:

name - the expected value for the name attribute configuration.

Returns:

the component if present, if not, an empty Optional

getConfigurationProperties

public org.mule.runtime.api.component.ConfigurationProperties getConfigurationProperties()

Returns:

the attributes resolver for this artifact.

recursiveStream

public Stream<org.mule.runtime.ast.api.ComponentAst> recursiveStream()

Specified by:

recursiveStream in interface org.mule.runtime.ast.api.ArtifactAst

recursiveStreamWithHierarchy

public Stream<org.mule.runtime.api.util.Pair<org.mule.runtime.ast.api.ComponentAst,List<org.mule.runtime.ast.api.ComponentAst>>> recursiveStreamWithHierarchy()

recursiveSpliterator

public Spliterator<org.mule.runtime.ast.api.ComponentAst> recursiveSpliterator()

Specified by:

recursiveSpliterator in interface org.mule.runtime.ast.api.ArtifactAst

topLevelComponentsStream

public Stream<org.mule.runtime.ast.api.ComponentAst> topLevelComponentsStream()

Specified by:

topLevelComponentsStream in interface org.mule.runtime.ast.api.ArtifactAst

topLevelComponentsSpliterator

public Spliterator<org.mule.runtime.ast.api.ComponentAst> topLevelComponentsSpliterator()

Specified by:

topLevelComponentsSpliterator in interface org.mule.runtime.ast.api.ArtifactAst