org.mule.runtime.config.internal.dsl.model

Class ExtensionModelHelper

java.lang.Object

org.mule.runtime.config.internal.dsl.model.ExtensionModelHelper

public class ExtensionModelHelper
extends Object

Helper class to work with a set of ExtensionModels

Contains a cache for searches within the extension models so we avoid processing each extension model twice.

It's recommended that the application only has one instance of this class to avoid processing the extension models several times.

since 4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExtensionModelHelper.ExtensionWalkerModelDelegate This interface is used along with an ExtensionWalker.

Constructor Summary

Constructors

Constructor and Description
ExtensionModelHelper(Set<org.mule.runtime.api.meta.model.ExtensionModel> extensionModels)
ExtensionModelHelper(Set<org.mule.runtime.api.meta.model.ExtensionModel> extensionModels, org.mule.runtime.api.dsl.DslResolvingContext dslResolvingCtx)

Method Summary

Modifier and Type	Method and Description
Optional<? extends org.mule.runtime.api.meta.model.ComponentModel>	findComponentModel(org.mule.runtime.api.component.ComponentIdentifier componentId) Finds a ComponentModel within the provided set of ExtensionModels by a ComponentIdentifier.
org.mule.runtime.api.component.TypedComponentIdentifier.ComponentType	findComponentType(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier) Find a DslElementModel for a given ComponentModel
org.mule.runtime.api.component.TypedComponentIdentifier.ComponentType	findComponentType(org.mule.runtime.api.meta.model.ComponentModel extensionComponentModel)
Optional<? extends org.mule.runtime.api.meta.model.config.ConfigurationModel>	findConfigurationModel(org.mule.runtime.api.component.ComponentIdentifier componentId) Finds a org.mule.runtime.api.meta.model.ConfigurationModel within the provided set of ExtensionModels by a ComponentIdentifier.
Optional<? extends org.mule.runtime.api.meta.model.connection.ConnectionProviderModel>	findConnectionProviderModel(org.mule.runtime.api.component.ComponentIdentifier componentId) Finds a org.mule.runtime.api.meta.model.ConnectionProviderModel within the provided set of ExtensionModels by a ComponentIdentifier.
Optional<? extends org.mule.metadata.api.model.MetadataType>	findMetadataType(Class<?> type)
Optional<org.mule.runtime.api.meta.model.parameter.ParameterModel>	findParameterModel(org.mule.runtime.api.component.ComponentIdentifier nestedComponentId, org.mule.runtime.api.meta.model.parameter.ParameterizedModel model)
Collection<org.mule.metadata.api.model.ObjectType>	getAllSubTypes()
Set<org.mule.runtime.api.meta.model.ExtensionModel>	getExtensionsModels()
Collection<org.mule.metadata.api.model.ObjectType>	getSubTypes(org.mule.metadata.api.model.ObjectType objectType)
Optional<org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax>	resolveDslElementModel(org.mule.metadata.api.model.MetadataType metadataType, org.mule.runtime.api.meta.model.ExtensionModel extensionModel)
org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax	resolveDslElementModel(org.mule.runtime.api.meta.NamedObject component, org.mule.runtime.api.component.ComponentIdentifier componentIdentifier)
org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax	resolveDslElementModel(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel, org.mule.runtime.api.component.ComponentIdentifier componentIdentifier)
Map<org.mule.metadata.api.model.ObjectType,Optional<org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax>>	resolveSubTypes(org.mule.metadata.api.model.ObjectType type)
void	walkToComponent(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier, ExtensionModelHelper.ExtensionWalkerModelDelegate delegate) Navigates the extension model for the provided componentIdentifier and calls the corresponding method on the provided delegate when found.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionModelHelper

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

Parameters:

extensionModels - the set of ExtensionModels to work with. Usually this is the set of models configured within a mule artifact.

ExtensionModelHelper

public ExtensionModelHelper(Set<org.mule.runtime.api.meta.model.ExtensionModel> extensionModels,
                            org.mule.runtime.api.dsl.DslResolvingContext dslResolvingCtx)

Method Detail

findComponentType

public org.mule.runtime.api.component.TypedComponentIdentifier.ComponentType findComponentType(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier)

Find a DslElementModel for a given ComponentModel

Parameters:

componentIdentifier - the identifier to use for the search.

Returns:

the DslElementModel associated with the configuration or an Optional.empty() if there isn't one.

findComponentType

public org.mule.runtime.api.component.TypedComponentIdentifier.ComponentType findComponentType(org.mule.runtime.api.meta.model.ComponentModel extensionComponentModel)

findComponentModel

public Optional<? extends org.mule.runtime.api.meta.model.ComponentModel> findComponentModel(org.mule.runtime.api.component.ComponentIdentifier componentId)

Finds a ComponentModel within the provided set of ExtensionModels by a ComponentIdentifier.

Parameters:

componentIdentifier - the identifier to use for the search.

Returns:

the found ComponentModel or Optional.empty() if it couldn't be found.

findConnectionProviderModel

public Optional<? extends org.mule.runtime.api.meta.model.connection.ConnectionProviderModel> findConnectionProviderModel(org.mule.runtime.api.component.ComponentIdentifier componentId)

Finds a org.mule.runtime.api.meta.model.ConnectionProviderModel within the provided set of ExtensionModels by a ComponentIdentifier.

Parameters:

componentIdentifier - the identifier to use for the search.

Returns:

the found org.mule.runtime.api.meta.model.ConnectionProviderModel or Optional.empty() if it couldn't be found.

findConfigurationModel

public Optional<? extends org.mule.runtime.api.meta.model.config.ConfigurationModel> findConfigurationModel(org.mule.runtime.api.component.ComponentIdentifier componentId)

Finds a org.mule.runtime.api.meta.model.ConfigurationModel within the provided set of ExtensionModels by a ComponentIdentifier.

Parameters:

componentIdentifier - the identifier to use for the search.

Returns:

the found org.mule.runtime.api.meta.model.ConfigurationModel or Optional.empty() if it couldn't be found.

findParameterModel

public Optional<org.mule.runtime.api.meta.model.parameter.ParameterModel> findParameterModel(org.mule.runtime.api.component.ComponentIdentifier nestedComponentId,
                                                                                             org.mule.runtime.api.meta.model.parameter.ParameterizedModel model)

walkToComponent

public void walkToComponent(org.mule.runtime.api.component.ComponentIdentifier componentIdentifier,
                            ExtensionModelHelper.ExtensionWalkerModelDelegate delegate)

Navigates the extension model for the provided componentIdentifier and calls the corresponding method on the provided delegate when found.

Parameters:

componentIdentifier - the identifier to use for the search.

delegate - the callback to execute on the found model.

findMetadataType

public Optional<? extends org.mule.metadata.api.model.MetadataType> findMetadataType(Class<?> type)

resolveDslElementModel

public org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax resolveDslElementModel(org.mule.runtime.api.meta.NamedObject component,
                                                                                         org.mule.runtime.api.component.ComponentIdentifier componentIdentifier)

resolveDslElementModel

public Optional<org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax> resolveDslElementModel(org.mule.metadata.api.model.MetadataType metadataType,
                                                                                                   org.mule.runtime.api.meta.model.ExtensionModel extensionModel)

resolveDslElementModel

public org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax resolveDslElementModel(org.mule.runtime.api.meta.model.parameter.ParameterModel parameterModel,
                                                                                         org.mule.runtime.api.component.ComponentIdentifier componentIdentifier)

resolveSubTypes

public Map<org.mule.metadata.api.model.ObjectType,Optional<org.mule.runtime.extension.api.dsl.syntax.DslElementSyntax>> resolveSubTypes(org.mule.metadata.api.model.ObjectType type)

getAllSubTypes

public Collection<org.mule.metadata.api.model.ObjectType> getAllSubTypes()

getSubTypes

public Collection<org.mule.metadata.api.model.ObjectType> getSubTypes(org.mule.metadata.api.model.ObjectType objectType)

getExtensionsModels

public Set<org.mule.runtime.api.meta.model.ExtensionModel> getExtensionsModels()