org.mule.runtime.api.component.location

Interface ConfigurationComponentLocator

public interface ConfigurationComponentLocator

Locator to access runtime objects created from the configuration of the artifact. The location can be composed by many parts, each part separated by an slash. The first part must be the name of the global element that contains the location. Location "myflow" indicates the global element with name myFlow. Global elements that do not have a name cannot be referenced. The following parts must be components contained within the global element. Location "myFlow/processors" indicates the processors part of the global element with name "myFlow" Each part must be contained in the preceded component in the location. Location "myFlow/errorHandler/onErrors" indicates the onErrors components that are part of the errorHandler component which is also part of the "myFlow" global element. When a component part has a collection of components, each component can be referenced individually with an index. THe first index is 0. Location "myFlow/processors/4" refers to the fifth processors inside the flow with name "myFlow"

Since:

4.0

Method Summary

Modifier and Type	Method and Description
List<AnnotatedObject>	find(ComponentIdentifier componentIdentifier) Finds all the components with the given identifier within the artifact.
Optional<AnnotatedObject>	find(Location location) Finds a component in the configuration with the specified location.
List<AnnotatedObject>	findAll() Finds all the components within the artifact.

Method Detail

find

Optional<AnnotatedObject> find(Location location)

Finds a component in the configuration with the specified location. Only simple objects locations are accepted.

Parameters:

location - the location of the component.

Returns:

the found component or empty if there's no such component.

find

List<AnnotatedObject> find(ComponentIdentifier componentIdentifier)

Finds all the components with the given identifier within the artifact.

Parameters:

componentIdentifier - the component identifier

Returns:

the list of found components. If no component is found an empty list will be returned.

findAll

List<AnnotatedObject> findAll()

Finds all the components within the artifact.

Returns:

the list of components within the artifact.