Module org.mule.runtime.artifact.cfg

Package org.mule.runtime.cfg.api

Class BaseChainExecutionPathTreeVisitor

java.lang.Object

org.mule.runtime.cfg.api.BaseChainExecutionPathTreeVisitor

All Implemented Interfaces:

ChainExecutionPathTreeVisitor

public class BaseChainExecutionPathTreeVisitor
extends Object
implements ChainExecutionPathTreeVisitor

Base implementation of ChainExecutionPathTreeVisitor with default methods implementation.

Since:

1.1.

Constructor Summary

Constructors

Constructor	Description
BaseChainExecutionPathTreeVisitor()

Method Summary

Modifier and Type	Method	Description
void	chainInterruptedWithError(ChainExecutionPathTree chain)	Called after a component that will always interrupt the execution flow of a chain prematurely and with an error.
void	errorHandlerCouldBeInvoked(ChainExecutionPathTree errorHandler, org.mule.runtime.api.message.ErrorType errorType)	Called after an operation is found that may raise an error that would incur in the invocation of the .
void	errorHandlerFinished(ChainExecutionPathTree handler)	Called after the last component in an #ERROR_HANDLER.
void	errorHandlerPropagationComplete(ChainExecutionPathTree handler)	Called after the last component in an #ERROR_HANDLER if the error has finished to be propagated to other error handlers.
boolean	errorHandlerStarted(ChainExecutionPathTree handler)	This method will be called before starting the traversal of an error handler.
void	finishReferencedOperation(ChainExecutionPathTree operation)	Called after a reference was traversed, to mark that the referenced ChainExecutionPathTree has finished.
void	innerRouteFinished(ChainExecutionPathTree innerChain)	Called after the last component in a #ROUTE within a #ROUTER.
boolean	innerRouteStarted(ChainExecutionPathTree innerChain)	Called when a #ROUTE within a #ROUTER is found in the execution tree.
void	routerFinished(ChainExecutionPathTree router)	Called after the last #ROUTE within a #ROUTER was visited.
void	scopeFinished(ChainExecutionPathTree scope)	Called after the #ROUTE/#CHAIN within a #SCOPE was visited.
void	visitReferencedOperation(ChainExecutionPathTree operation)	Called when an #OPERATION that references to another operation in the execution tree.
boolean	visitRouter(ChainExecutionPathTree router)	Called when a #ROUTER is found in the execution tree.
boolean	visitScope(ChainExecutionPathTree scope)	Called when a #SCOPE is found in the execution tree.
void	visitSimpleOperation(ChainExecutionPathTree operation)	Called when a simple #OPERATION is found in the execution tree.
void	visitSource(ChainExecutionPathTree source)	Called when a #SOURCE is found in the execution tree.

Methods inherited from class java.lang.Object

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

Constructor Details

BaseChainExecutionPathTreeVisitor

public BaseChainExecutionPathTreeVisitor()

Method Details

visitSource

public void visitSource(ChainExecutionPathTree source)

Description copied from interface: ChainExecutionPathTreeVisitor

Called when a #SOURCE is found in the execution tree.

If the chain is a #FLOW with a #SOURCE, this will be the first method called when visiting the chain.

Specified by:

visitSource in interface ChainExecutionPathTreeVisitor

Parameters:

source - the tree representing visited source

visitSimpleOperation

public void visitSimpleOperation(ChainExecutionPathTree operation)

Description copied from interface: ChainExecutionPathTreeVisitor

Called when a simple #OPERATION is found in the execution tree.

A simple #OPERATION is any operation within a chain that is not a #SCOPE or #ROUTER.

Specified by:

visitSimpleOperation in interface ChainExecutionPathTreeVisitor

Parameters:

operation - the visited simple operation.

visitReferencedOperation

public void visitReferencedOperation(ChainExecutionPathTree operation)

Description copied from interface: ChainExecutionPathTreeVisitor

Called when an #OPERATION that references to another operation in the execution tree.

This could be the case of a Flow Reference Operation.

Specified by:

visitReferencedOperation in interface ChainExecutionPathTreeVisitor

Parameters:

operation - the visited reference operation.

finishReferencedOperation

public void finishReferencedOperation(ChainExecutionPathTree operation)

Description copied from interface: ChainExecutionPathTreeVisitor

Called after a reference was traversed, to mark that the referenced ChainExecutionPathTree has finished.

Specified by:

finishReferencedOperation in interface ChainExecutionPathTreeVisitor

visitScope

public boolean visitScope(ChainExecutionPathTree scope)

Description copied from interface: ChainExecutionPathTreeVisitor

Called when a #SCOPE is found in the execution tree.

After this method is called, if it returns true it will proceed to visit its inner components. After that, ChainExecutionPathTreeVisitor.scopeFinished(ChainExecutionPathTree) will be called and then the method for the component right after the scope the last call to that method. If ChainExecutionPathTreeVisitor.visitScope(ChainExecutionPathTree) returned false, this method won't be called.

Specified by:

visitScope in interface ChainExecutionPathTreeVisitor

Parameters:

scope - the visited scope.

Returns:

true if the visitor should visit the inner components of the #SCOPE, or false if it should just skip to the next element. If it is true, then every inner component of this particular #SCOPE will be visited.

scopeFinished

public void scopeFinished(ChainExecutionPathTree scope)

Description copied from interface: ChainExecutionPathTreeVisitor

Called after the #ROUTE/#CHAIN within a #SCOPE was visited.

This is a delimiter call. This will only be called after ChainExecutionPathTreeVisitor.visitScope(ChainExecutionPathTree) and will be referred to the last call to that method.

Specified by:

scopeFinished in interface ChainExecutionPathTreeVisitor

visitRouter

public boolean visitRouter(ChainExecutionPathTree router)

Description copied from interface: ChainExecutionPathTreeVisitor

Called when a #ROUTER is found in the execution tree.

After this method is called, if it returns {@link true}, for each of its inner chains ChainExecutionPathTreeVisitor.innerRouteStarted(ChainExecutionPathTree) (ComponentAst)} followed by the calls that correspond to its inner components, and then ChainExecutionPathTreeVisitor.routerFinished(ChainExecutionPathTree) will be called. After all inner chains have been navigated, ChainExecutionPathTreeVisitor.routerFinished(ChainExecutionPathTree) will be called with the same ComponentAst of this #ROUTER, and the method for the component right after the scope will be called.

Specified by:

visitRouter in interface ChainExecutionPathTreeVisitor

Parameters:

router - the visited router.

Returns:

true if the visitor should visit the inner components of the #ROUTER, or false if it should just skip to the next element.

innerRouteStarted

public boolean innerRouteStarted(ChainExecutionPathTree innerChain)

Description copied from interface: ChainExecutionPathTreeVisitor

Called when a #ROUTE within a #ROUTER is found in the execution tree.

This is a delimiter call. The finish of the innerChain started here will be notified by a call to ChainExecutionPathTreeVisitor.innerRouteFinished(ChainExecutionPathTree). This wil only be called if ChainExecutionPathTreeVisitor.visitRouter(ChainExecutionPathTree) returned true.

Specified by:

innerRouteStarted in interface ChainExecutionPathTreeVisitor

Parameters:

innerChain - the visited innerChain.

Returns:

true if this particular route is required to be started.

innerRouteFinished

public void innerRouteFinished(ChainExecutionPathTree innerChain)

Description copied from interface: ChainExecutionPathTreeVisitor

Called after the last component in a #ROUTE within a #ROUTER.

This is a delimiter call. This will only be called after ChainExecutionPathTreeVisitor.innerRouteStarted(ChainExecutionPathTree) and will apply to the innerChain indicated in the last call to that method.

Specified by:

innerRouteFinished in interface ChainExecutionPathTreeVisitor

Parameters:

innerChain - the visited innerChain

routerFinished

public void routerFinished(ChainExecutionPathTree router)

Description copied from interface: ChainExecutionPathTreeVisitor

Called after the last #ROUTE within a #ROUTER was visited.

This is a delimiter call. This will only be called after ChainExecutionPathTreeVisitor.visitRouter(ChainExecutionPathTree) and will be referred to the last call to that method. If ChainExecutionPathTreeVisitor.visitRouter(ChainExecutionPathTree) returned false, this method won't be called.

Specified by:

routerFinished in interface ChainExecutionPathTreeVisitor

errorHandlerCouldBeInvoked

public void errorHandlerCouldBeInvoked(ChainExecutionPathTree errorHandler,
 org.mule.runtime.api.message.ErrorType errorType)

Description copied from interface: ChainExecutionPathTreeVisitor

Called after an operation is found that may raise an error that would incur in the invocation of the . This also includes the case of an OnErrorPropagate, which in the end propagates as well to this error handler. The visitor must consider that this method may be called for the same error handler for every error that may occur and this matches.

Specified by:

errorHandlerCouldBeInvoked in interface ChainExecutionPathTreeVisitor

Parameters:

errorHandler - the ChainExecutionPathTree corresponding to the error handler that could be invoked.

errorType - the ErrorType of the error that the operation may raise.

errorHandlerStarted

public boolean errorHandlerStarted(ChainExecutionPathTree handler)

Description copied from interface: ChainExecutionPathTreeVisitor

This method will be called before starting the traversal of an error handler. This will be called after the entire chain of the owner of this ErrorHandler has been traversed, which will allow to retrieve all the potential calls to this, which are modeled with #errorHandlerCouldBeInvoked(ChainExecutionPathTree).

If there is the need to continue the propagation (i.e. this is an on error propagate handler), it will as well invoke #errorHandlerCouldBeInvoked(ChainExecutionPathTree) after the propagation of this one is finished.

Specified by:

errorHandlerStarted in interface ChainExecutionPathTreeVisitor

Parameters:

handler - the visited error handler

Returns:

true if the visitor should travers this error handler (ChainExecutionPathTreeVisitor.errorHandlerFinished(ChainExecutionPathTree) won't be invoked if this returns false).

errorHandlerFinished

public void errorHandlerFinished(ChainExecutionPathTree handler)

Description copied from interface: ChainExecutionPathTreeVisitor

Called after the last component in an #ERROR_HANDLER.

This is a delimiter call. This will only be called after ChainExecutionPathTreeVisitor.errorHandlerStarted(ChainExecutionPathTree).

Specified by:

errorHandlerFinished in interface ChainExecutionPathTreeVisitor

Parameters:

handler - the visited error handler.

errorHandlerPropagationComplete

public void errorHandlerPropagationComplete(ChainExecutionPathTree handler)

Description copied from interface: ChainExecutionPathTreeVisitor

Called after the last component in an #ERROR_HANDLER if the error has finished to be propagated to other error handlers. This is, for example, if the current is an on-error-continue, or if we reached the last level of error handling to be able to handle the error (e.g. the main flow). This method will be called for every that the originating component may throw, as far as there is at least an error handler to handle it.

This is a delimiter call. The finish of the error handler started here will be notified by a call to ChainExecutionPathTreeVisitor.errorHandlerFinished(ChainExecutionPathTree), including for this last , to then call this method.

Specified by:

errorHandlerPropagationComplete in interface ChainExecutionPathTreeVisitor

Parameters:

handler - the visited error handler

chainInterruptedWithError

public void chainInterruptedWithError(ChainExecutionPathTree chain)

Description copied from interface: ChainExecutionPathTreeVisitor

Called after a component that will always interrupt the execution flow of a chain prematurely and with an error.

This represents a situation in which, if there are other nodes after this one, they will never be executed.

Specified by:

chainInterruptedWithError in interface ChainExecutionPathTreeVisitor

Parameters:

chain - the interrupted chain.