org.mule.runtime.api.ioc

Interface ObjectProvider

All Superinterfaces:

AnnotatedObject

public interface ObjectProvider
extends AnnotatedObject

Interface meant to be implemented by components that will provide objects that may be referenced from mule configuration files.

This interface may make use of Lifecycle interfaces.

Since:

1.0

Field Summary

Fields inherited from interface org.mule.runtime.api.meta.AnnotatedObject

PROPERTY_NAME

Method Summary

Modifier and Type	Method and Description
void	configure(ObjectProviderConfiguration objectProviderConfiguration) Method to be called to prepare the ObjectProvider.
Optional<Object>	getObject(String name) Finds an object by name
Optional<Object>	getObjectByType(Class<?> objectType) Finds an object by type
<T> Map<String,T>	getObjectsByType(Class<T> type) Finds all objects matching the given type
Optional<Boolean>	isObjectSingleton(String name)

Methods inherited from interface org.mule.runtime.api.meta.AnnotatedObject

getAnnotation, getAnnotations, getLocation, setAnnotations

Method Detail

configure

void configure(ObjectProviderConfiguration objectProviderConfiguration)

Method to be called to prepare the ObjectProvider. It is expected that the provider is ready to be used after calling this method.

This method will be invoke before Initialisable.initialise() if the implementation implements that interface.

Parameters:

objectProviderConfiguration - configuration for the provider.

getObject

Optional<Object> getObject(String name)

Finds an object by name

Parameters:

name - the object name

Returns:

the object if there's one, empty otherwise.

getObjectByType

Optional<Object> getObjectByType(Class<?> objectType)

Finds an object by type

Parameters:

objectType - the object type.

Returns:

the object if there's one, empty otherwise. In case there are many, then it will fail unless there's a preferred one. How the preferred one is defined is up to the ObjectProvider implementation.

getObjectsByType

<T> Map<String,T> getObjectsByType(Class<T> type)

Finds all objects matching the given type

Type Parameters:

T - type parameter for the object

Parameters:

type - the object type class object

Returns:

a map where the keys are the object names and the values the objects associated with the key

isObjectSingleton

Optional<Boolean> isObjectSingleton(String name)

Parameters:

name - bean name

Returns:

true if the object is a singleton, false if it's not, empty if there's no an object with that name.