org.mule.runtime.api.meta.model.util

Class ExtensionWalker

java.lang.Object

org.mule.runtime.api.meta.model.util.ExtensionWalker

Direct Known Subclasses:

IdempotentExtensionWalker

public abstract class ExtensionWalker
extends Object

Navigates a ExtensionModel and invokes methods when important model components are found.

This is useful to centralize the logic of how to iterate through a model's structure without coupling to it. For example, the onOperation(HasOperationModels, OperationModel) method allows handling operations without requiring to know that they can exist at global or configuration level. Something similar can be said about the onParameter(ParameterizedModel, ParameterGroupModel, ParameterModel), etc.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
ExtensionWalker()

Method Summary

Modifier and Type	Method and Description
protected void	onConfiguration(ConfigurationModel model) Invoked when a ConfigurationModel is found in the traversed extensionModel
protected void	onConnectionProvider(HasConnectionProviderModels owner, ConnectionProviderModel model) Invoked when an ConnectionProviderModel is found in the traversed extensionModel
protected void	onOperation(HasOperationModels owner, OperationModel model) Invoked when an OperationModel is found in the traversed extensionModel.
protected void	onParameter(ParameterizedModel owner, ParameterGroupModel groupModel, ParameterModel model) Invoked when an ParameterModel is found in the traversed extensionModel
protected void	onParameterGroup(ParameterizedModel owner, ParameterGroupModel model) Invoked when an ParameterGroupModel is found in the traversed extensionModel
protected void	onRouter(HasOperationModels owner, RouterModel model) Invoked when a RouterModel is found in the traversed extensionModel.
protected void	onScope(HasOperationModels owner, ScopeModel model) Invoked when a ScopeModel is found in the traversed extensionModel.
protected void	onSource(HasSourceModels owner, SourceModel model) Invoked when an SourceModel is found in the traversed extensionModel
protected void	stop() When invoked, the traversal of the ExtensionModel will stop once the current visit is completed.
void	walk(ExtensionModel extensionModel) Navigates the given extensionModel and invokes the other public method's in this class as the navigation progresses

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionWalker

public ExtensionWalker()

Method Detail

walk

public final void walk(ExtensionModel extensionModel)

Navigates the given extensionModel and invokes the other public method's in this class as the navigation progresses

Parameters:

extensionModel - the model to navigate

stop

protected final void stop()

When invoked, the traversal of the ExtensionModel will stop once the current visit is completed. This will not break the execution within the invoking method, but instead avoid further traversal of the model from that point on.

onConfiguration

protected void onConfiguration(ConfigurationModel model)

Invoked when a ConfigurationModel is found in the traversed extensionModel

Parameters:

model - a ConfigurationModel

onOperation

protected void onOperation(HasOperationModels owner,
                           OperationModel model)

Invoked when an OperationModel is found in the traversed extensionModel.

This method is also invoked when a ScopeModel or a RouterModel are found, if and only if the onScope(HasOperationModels, ScopeModel) or onRouter(HasOperationModels, RouterModel) methods were not overridden respectively.

Parameters:

owner - The component that owns the operation

model - the OperationModel

onScope

protected void onScope(HasOperationModels owner,
                       ScopeModel model)

Invoked when a ScopeModel is found in the traversed extensionModel.

By default, this method simply delegates on onOperation(HasOperationModels, OperationModel)

Parameters:

owner - The component that owns the operation

model - the OperationModel

onRouter

protected void onRouter(HasOperationModels owner,
                        RouterModel model)

Invoked when a RouterModel is found in the traversed extensionModel.

By default, this method simply delegates on onOperation(HasOperationModels, OperationModel)

Parameters:

owner - The component that owns the operation

model - the OperationModel

onConnectionProvider

protected void onConnectionProvider(HasConnectionProviderModels owner,
                                    ConnectionProviderModel model)

Invoked when an ConnectionProviderModel is found in the traversed extensionModel

Parameters:

owner - The component that owns the provider

model - the ConnectionProviderModel

onSource

protected void onSource(HasSourceModels owner,
                        SourceModel model)

Invoked when an SourceModel is found in the traversed extensionModel

Parameters:

owner - The component that owns the source

model - the SourceModel

onParameterGroup

protected void onParameterGroup(ParameterizedModel owner,
                                ParameterGroupModel model)

Invoked when an ParameterGroupModel is found in the traversed extensionModel

Parameters:

owner - The component that owns the source

model - the ParameterGroupModel

onParameter

protected void onParameter(ParameterizedModel owner,
                           ParameterGroupModel groupModel,
                           ParameterModel model)

Invoked when an ParameterModel is found in the traversed extensionModel

Parameters:

owner - The component that owns the parameter

groupModel - the ParameterGroupModel in which the model is contained

model - the ParameterModel