org.mule.config.spring

Class SpringRegistry

java.lang.Object

org.mule.registry.AbstractRegistry

org.mule.config.spring.SpringRegistry

All Implemented Interfaces:

Injector, Disposable, Initialisable, LifecycleRegistry, Registry

public class SpringRegistry
extends AbstractRegistry
implements LifecycleRegistry, Injector

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext
static String	REGISTRY_ID
static String	SPRING_APPLICATION_CONTEXT Key used to lookup Spring Application Context from SpringRegistry via Mule's Registry interface.
protected AtomicBoolean	springContextInitialised

Fields inherited from class org.mule.registry.AbstractRegistry

lifecycleManager, logger, muleContext

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

PHASE_NAME

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
SpringRegistry(org.springframework.context.ApplicationContext applicationContext, MuleContext muleContext)
SpringRegistry(org.springframework.context.ConfigurableApplicationContext applicationContext, org.springframework.context.ApplicationContext parentContext, MuleContext muleContext)
SpringRegistry(String id, org.springframework.context.ApplicationContext applicationContext, MuleContext muleContext)
SpringRegistry(String id, org.springframework.context.ConfigurableApplicationContext applicationContext, org.springframework.context.ApplicationContext parentContext, MuleContext muleContext)

Method Summary

Methods

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.
protected RegistryLifecycleManager	createLifecycleManager()
void	doDispose()
protected void	doInitialise()
protected Object	doUnregisterObject(String key) Template method for the logic to actually unregister the key without applying any lifecycle to it.
protected Map<String,Object>	getDepencies(String key)
<T> T	inject(T object) Injects dependencies into the given object
protected <T> Map<String,T>	internalLookupByType(Class<T> type, boolean nonSingletons, boolean eagerInit)
protected <T> Map<String,T>	internalLookupByTypeWithoutAncestors(Class<T> type, boolean nonSingletons, boolean eagerInit)
boolean	isReadOnly()
boolean	isRemote()
<T> Map<String,T>	lookupByType(Class<T> type)
protected <T> Map<String,T>	lookupEntriesForLifecycle(Class<T> type)
<T> Collection<T>	lookupLocalObjects(Class<T> type) Look up all objects of a given type within the local registry.
<T> T	lookupObject(String key) Look up a single object by name.
Object	lookupObject(String key, boolean applyLifecycle) If looks for the bean registered under key.
<T> Collection<T>	lookupObjects(Class<T> type) Look up all objects of a given type.
<T> Collection<T>	lookupObjectsForLifecycle(Class<T> type) For lifecycle we only want spring to return singleton objects from it's application context
void	registerObject(String key, Object value) Registers an object in the registry with a key.
void	registerObject(String key, Object value, Object metadata) Registers an object in the registry with a key.
void	registerObjects(Map<String,Object> objects) Registers a Map of objects into the registry

Methods inherited from class org.mule.registry.AbstractRegistry

dispose, fireLifecycle, get, getLifecycleManager, getRegistryId, initialise, isInitialised, lookupObject, unregisterObject, unregisterObject

Methods inherited from class java.lang.Object

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

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

fireLifecycle, get, getRegistryId, lookupObject, unregisterObject, unregisterObject

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

initialise

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

dispose

Field Detail

REGISTRY_ID

public static final String REGISTRY_ID

See Also:

Constant Field Values

SPRING_APPLICATION_CONTEXT

public static final String SPRING_APPLICATION_CONTEXT

Key used to lookup Spring Application Context from SpringRegistry via Mule's Registry interface.

See Also:

Constant Field Values

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

springContextInitialised

protected AtomicBoolean springContextInitialised

Constructor Detail

SpringRegistry

public SpringRegistry(org.springframework.context.ApplicationContext applicationContext,
              MuleContext muleContext)

SpringRegistry

public SpringRegistry(String id,
              org.springframework.context.ApplicationContext applicationContext,
              MuleContext muleContext)

SpringRegistry

public SpringRegistry(org.springframework.context.ConfigurableApplicationContext applicationContext,
              org.springframework.context.ApplicationContext parentContext,
              MuleContext muleContext)

SpringRegistry

public SpringRegistry(String id,
              org.springframework.context.ConfigurableApplicationContext applicationContext,
              org.springframework.context.ApplicationContext parentContext,
              MuleContext muleContext)

Method Detail

doInitialise

protected void doInitialise()
                     throws InitialisationException

Specified by:

doInitialise in class AbstractRegistry

Throws:

InitialisationException

doDispose

public void doDispose()

Specified by:

doDispose in class AbstractRegistry

createLifecycleManager

protected RegistryLifecycleManager createLifecycleManager()

Overrides:

createLifecycleManager in class AbstractRegistry

lookupObject

public <T> T lookupObject(String key)

Look up a single object by name.

Specified by:

lookupObject in interface Registry

Returns:

the result of invoking lookupObject(String, boolean) with true as the second argument

lookupObject

public Object lookupObject(String key,
                  boolean applyLifecycle)

If looks for the bean registered under key. If the returned bean is a prototype and applyLifecycle is true, then the completed lifecycle phases are applied to the returning bean

Specified by:

lookupObject in interface LifecycleRegistry

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

lookupObjects

public <T> Collection<T> lookupObjects(Class<T> type)

Description copied from interface: Registry

Look up all objects of a given type.

Specified by:

lookupObjects in interface Registry

Returns:

collection of objects or empty collection if none found

lookupLocalObjects

public <T> Collection<T> lookupLocalObjects(Class<T> type)

Description copied from interface: Registry

Look up all objects of a given type within the local registry. local means that no parent registry will be search for local objects.

Specified by:

lookupLocalObjects in interface Registry

Returns:

collection of objects or empty collection if none found

lookupObjectsForLifecycle

public <T> Collection<T> lookupObjectsForLifecycle(Class<T> type)

For lifecycle we only want spring to return singleton objects from it's application context

Specified by:

lookupObjectsForLifecycle in interface Registry

Overrides:

lookupObjectsForLifecycle in class AbstractRegistry

Returns:

collection of objects or empty collection if none found

lookupByType

public <T> Map<String,T> lookupByType(Class<T> type)

Specified by:

lookupByType in interface Registry

Returns:

key/object pairs

registerObject

public void registerObject(String key,
                  Object value)
                    throws RegistrationException

Description copied from interface: Registry

Registers an object in the registry with a key.

Specified by:

registerObject in interface Registry

Parameters:

key - the key to store the value against. This is a non-null value

value - the object to store in the registry. This is a non-null value

Throws:

RegistrationException - if an object with the same key already exists

registerObject

public void registerObject(String key,
                  Object value,
                  Object metadata)
                    throws RegistrationException

Description copied from interface: Registry

Registers an object in the registry with a key.

Specified by:

registerObject in interface Registry

Parameters:

key - the key to store the value against. This is a non-null value

value - the object to store in the registry. This is a non-null value

metadata - an implementation specific argument that can be passed into the method

Throws:

RegistrationException - if an object with the same key already exists

registerObjects

public void registerObjects(Map<String,Object> objects)
                     throws RegistrationException

Description copied from interface: Registry

Registers a Map of objects into the registry

Specified by:

registerObjects in interface Registry

Parameters:

objects - a map of key value pairs, each will individually be registered in the registry

Throws:

RegistrationException - if an object with the same key already exists

doUnregisterObject

protected Object doUnregisterObject(String key)
                             throws RegistrationException

Description copied from class: AbstractRegistry

Template method for the logic to actually unregister the key without applying any lifecycle to it. Applying the shutdown lifecycle will be up to AbstractRegistry.unregisterObject(String)

Specified by:

doUnregisterObject in class AbstractRegistry

Parameters:

key - the key of the object to be unregistered object

Returns:

the object which was registered under key

Throws:

RegistrationException

applyLifecycle

public Object applyLifecycle(Object object)
                      throws 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.

Specified by:

applyLifecycle in interface LifecycleRegistry

Parameters:

object - the object to process

Returns:

the same object with lifecycle methods called (if it has any)

Throws:

MuleException - if the registry fails to perform the lifecycle change for the object.

applyLifecycle

public Object applyLifecycle(Object object,
                    String phase)
                      throws MuleException

Description copied from interface: LifecycleRegistry

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.

Specified by:

applyLifecycle in interface LifecycleRegistry

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:

MuleException - if the registry fails to perform the lifecycle change for the object.

inject

public <T> T inject(T object)

Description copied from interface: Injector

Injects dependencies into the given object

Specified by:

inject in interface Injector

Parameters:

object - the object on which dependencies are to be injected on

Returns:

the injected object or a proxy to it

internalLookupByType

protected <T> Map<String,T> internalLookupByType(Class<T> type,
                                     boolean nonSingletons,
                                     boolean eagerInit)

internalLookupByTypeWithoutAncestors

protected <T> Map<String,T> internalLookupByTypeWithoutAncestors(Class<T> type,
                                                     boolean nonSingletons,
                                                     boolean eagerInit)

lookupEntriesForLifecycle

protected <T> Map<String,T> lookupEntriesForLifecycle(Class<T> type)

getDepencies

protected Map<String,Object> getDepencies(String key)

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface Registry

isRemote

public boolean isRemote()

Specified by:

isRemote in interface Registry