org.mule.runtime.core.api.registry

Interface MuleRegistry

All Superinterfaces:

org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, LifecycleRegistry, Registry

All Known Implementing Classes:

MuleRegistryHelper

public interface MuleRegistry
extends LifecycleRegistry

Adds lookup/register/unregister methods for Mule-specific entities to the standard Registry interface.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INJECT_PROCESSORS_BYPASS_FLAG Determines whether Inject processors should get executed on an object added to the registry Inject processors are responsible for processing inject interfaces such as MuleContextAware
static int	LIFECYCLE_BYPASS_FLAG Pass this flag as metadata of the Registry.registerObject(String, Object, Object) method to have lifecycle method calls on the registered objects omitted.
static int	PRE_INIT_PROCESSORS_BYPASS_FLAG Determines whether pre-init processors should get executed on an object added to the registry.

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Method Summary

Modifier and Type	Method and Description
Object	applyProcessors(Object object) Will execute any processors on an object without actually registering the object in the registry.
Object	applyProcessorsAndLifecycle(Object object) Will execute any processors on an object and fire any lifecycle methods according to the current lifecycle without actually registering the object in the registry.
Agent	lookupAgent(String agentName)
FlowConstruct	lookupFlowConstruct(String name)
Collection<FlowConstruct>	lookupFlowConstructs()
Transformer	lookupTransformer(org.mule.runtime.api.metadata.DataType source, org.mule.runtime.api.metadata.DataType result) Will find a transformer that is the closest match to the desired input and output.
Transformer	lookupTransformer(String name)
List<Transformer>	lookupTransformers(org.mule.runtime.api.metadata.DataType source, org.mule.runtime.api.metadata.DataType result) This method will return a list of Transformer objects that accept the given input and return the given output type of object
void	registerAgent(Agent agent)
void	registerFlowConstruct(FlowConstruct flowConstruct)
void	registerTransformer(Transformer transformer)
void	unregisterAgent(String agentName)
void	unregisterTransformer(String transformerName)

Methods inherited from interface org.mule.runtime.core.api.registry.LifecycleRegistry

applyLifecycle, applyLifecycle, applyLifecycle, lookupObject

Methods inherited from interface org.mule.runtime.core.api.registry.Registry

fireLifecycle, get, getRegistryId, isReadOnly, isRemote, lookupByType, lookupLocalObjects, lookupObject, lookupObject, lookupObjects, lookupObjectsForLifecycle, registerObject, registerObject, registerObjects, unregisterObject, unregisterObject

Methods inherited from interface org.mule.runtime.api.lifecycle.Initialisable

initialise

Methods inherited from interface org.mule.runtime.api.lifecycle.Disposable

dispose

Field Detail

LIFECYCLE_BYPASS_FLAG

static final int LIFECYCLE_BYPASS_FLAG

Pass this flag as metadata of the Registry.registerObject(String, Object, Object) method to have lifecycle method calls on the registered objects omitted. Unless extending Mule, one will probably never have a use for this.

See Also:

Registry.registerObject(String, Object, Object), Constant Field Values

INJECT_PROCESSORS_BYPASS_FLAG

static final int INJECT_PROCESSORS_BYPASS_FLAG

Determines whether Inject processors should get executed on an object added to the registry Inject processors are responsible for processing inject interfaces such as MuleContextAware

See Also:

Constant Field Values

PRE_INIT_PROCESSORS_BYPASS_FLAG

static final int PRE_INIT_PROCESSORS_BYPASS_FLAG

Determines whether pre-init processors should get executed on an object added to the registry. Pre init processors are basically object processors that do not inject members into objects. These processors happen after the inject processors

See Also:

Constant Field Values

Method Detail

lookupTransformer

Transformer lookupTransformer(String name)

lookupFlowConstruct

FlowConstruct lookupFlowConstruct(String name)

lookupTransformers

List<Transformer> lookupTransformers(org.mule.runtime.api.metadata.DataType source,
                                     org.mule.runtime.api.metadata.DataType result)

This method will return a list of Transformer objects that accept the given input and return the given output type of object

Parameters:

source - The desired input type for the transformer

result - the desired output type for the transformer

Returns:

a list of matching transformers. If there were no matches an empty list is returned.

Since:

3.0.0

lookupTransformer

Transformer lookupTransformer(org.mule.runtime.api.metadata.DataType source,
                              org.mule.runtime.api.metadata.DataType result)
                       throws TransformerException

Will find a transformer that is the closest match to the desired input and output.

Parameters:

source - The desired input type for the transformer

result - the desired output type for the transformer

Returns:

A transformer that exactly matches or the will accept the input and output parameters

Throws:

TransformerException - will be thrown if there is more than one match

Since:

3.0.0

lookupFlowConstructs

Collection<FlowConstruct> lookupFlowConstructs()

lookupAgent

Agent lookupAgent(String agentName)

registerTransformer

void registerTransformer(Transformer transformer)
                  throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

unregisterTransformer

void unregisterTransformer(String transformerName)
                    throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

registerFlowConstruct

void registerFlowConstruct(FlowConstruct flowConstruct)
                    throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

registerAgent

void registerAgent(Agent agent)
            throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

unregisterAgent

void unregisterAgent(String agentName)
              throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

applyProcessorsAndLifecycle

Object applyProcessorsAndLifecycle(Object object)
                            throws org.mule.runtime.api.exception.MuleException

Will execute any processors on an object and fire any lifecycle methods according to the current lifecycle without actually registering the object in the registry. This is useful for prototype objects that are created per request and would clutter the registry with single use objects. Not that this will only be applied to Mule registies. Thrid party registries such as Guice support wiring, but you need to get a reference to the container/context to call the method. This is so that wiring mechanisms dont trip over each other.

Parameters:

object - the object to process

Returns:

the same object with any processors and lifecycle methods called

Throws:

org.mule.runtime.api.exception.MuleException - if the registry fails to perform the lifecycle change or process object processors for the object.

applyProcessors

Object applyProcessors(Object object)
                throws org.mule.runtime.api.exception.MuleException

Will execute any processors on an object without actually registering the object in the registry. This is useful for prototype objects that are created per request and would clutter the registry with single use objects. Not that this will only be applied to Mule registries. Third party registries such as Guice support wiring, but you need to get a reference to the container/context to call the method. This is so that wiring mechanisms dont trip over each other.

Parameters:

object - the object to process

Returns:

the same object with any processors called

Throws:

org.mule.runtime.api.exception.MuleException - if the registry fails to process object processors for the object.