org.mule.runtime.core.api.registry

Interface LifecycleRegistry

All Superinterfaces:

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

All Known Subinterfaces:

MuleRegistry

All Known Implementing Classes:

MuleRegistryHelper, SimpleRegistry

public interface LifecycleRegistry
extends Registry

A Registry which not only registers and fetches objects, but it's also capable of applying lifecycle and injects dependencies

Since:

3.7.0

Field Summary

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	applyLifecycle(Object object) Will fire any lifecycle methods according to the current lifecycle without actually registering the object in the registry.
Object	applyLifecycle(Object object, String phase) Will fire the given lifecycle phase without actually registering the object in the registry.
void	applyLifecycle(Object object, String startPhase, String toPhase) Applies lifecycle phase to an object independent of the current lifecycle phase.
<T> T	lookupObject(String key, boolean applyLifecycle) Look up a single object by name.

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

Method Detail

applyLifecycle

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

Will 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.

Parameters:

object - the object to process

Returns:

either the same object but with the lifecycle applied or a proxy to it

Throws:

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

applyLifecycle

Object applyLifecycle(Object object,
                      String phase)
               throws org.mule.runtime.api.exception.MuleException

Will fire the given lifecycle phase 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.

Parameters:

object - the object to process

phase - the specific lifecycle phase you want to fire

Returns:

either the same object but with the lifecycle applied or a proxy to it

Throws:

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

applyLifecycle

void applyLifecycle(Object object,
                    String startPhase,
                    String toPhase)
             throws org.mule.runtime.api.exception.MuleException

Applies lifecycle phase to an object independent of the current lifecycle phase. All phases between the startPhase and the endPhase will be executed.

Parameters:

object - the object to apply lifecycle to

startPhase - the lifecycle phase the object is currently in. Must not be null.

toPhase - the lifecycle phase to transition the object to. Must not be null.

Throws:

org.mule.runtime.api.exception.MuleException - if there is an exception while invoking lifecycle on the object

lookupObject

<T> T lookupObject(String key,
                   boolean applyLifecycle)

Look up a single object by name.

Because Registry.lookupObject(String) will return objects which had lifecycle phases applied,this method exists for cases in which you want to specify that lifecycle is not to be applied. The actual semantics of that actually depends on the implementation, since invoking this method might return a new instance or an already existing one. If an existing one is returned, then the lifecycle might have been previously applied regardless.

Parameters:

key - the key of the object you're looking for

applyLifecycle - if lifecycle should be applied to the returned object. Passing true doesn't guarantee that the lifecycle is applied

Returns:

object or null if not found