org.mule.runtime.core.registry

Class AbstractRegistry

java.lang.Object

org.mule.runtime.core.registry.AbstractRegistry

All Implemented Interfaces:

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

Direct Known Subclasses:

TransientRegistry

public abstract class AbstractRegistry
extends Object
implements Registry

Field Summary

Fields

Modifier and Type	Field and Description
protected RegistryLifecycleManager	lifecycleManager
protected org.slf4j.Logger	logger
protected MuleContext	muleContext

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

PHASE_NAME

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

PHASE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRegistry(String id, MuleContext muleContext)

Method Summary

Modifier and Type	Method and Description
protected RegistryLifecycleManager	createLifecycleManager()
void	dispose()
protected abstract void	doDispose()
protected abstract void	doInitialise()
protected abstract Object	doUnregisterObject(String key) Template method for the logic to actually unregister the key without applying any lifecycle to it.
void	fireLifecycle(String phase)
<T> T	get(String key) Alias method performing the lookup, here to simplify syntax when called from dynamic languages.
RegistryLifecycleManager	getLifecycleManager()
String	getRegistryId()
void	initialise()
protected boolean	isInitialised()
<T> T	lookupObject(Class<T> type) Look up a single object by type.
<T> Collection<T>	lookupObjectsForLifecycle(Class<T> type) Look up all objects of a given type that lifecycle should be applied to.
Object	unregisterObject(String key) Will remove an object by name from the registry.
Object	unregisterObject(String key, Object metadata) Deprecated.

Methods inherited from class java.lang.Object

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

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

isReadOnly, isRemote, lookupByType, lookupLocalObjects, lookupObject, lookupObjects, registerObject, registerObject, registerObjects

Field Detail

logger

protected transient org.slf4j.Logger logger

muleContext

protected MuleContext muleContext

lifecycleManager

protected RegistryLifecycleManager lifecycleManager

Constructor Detail

AbstractRegistry

protected AbstractRegistry(String id,
                           MuleContext muleContext)

Method Detail

dispose

public final void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

createLifecycleManager

protected RegistryLifecycleManager createLifecycleManager()

doInitialise

protected abstract void doInitialise()
                              throws org.mule.runtime.api.lifecycle.InitialisationException

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

doDispose

protected abstract void doDispose()

initialise

public final void initialise()
                      throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

isInitialised

protected boolean isInitialised()

getLifecycleManager

public RegistryLifecycleManager getLifecycleManager()

fireLifecycle

public void fireLifecycle(String phase)
                   throws org.mule.runtime.api.lifecycle.LifecycleException

Specified by:

fireLifecycle in interface Registry

Throws:

org.mule.runtime.api.lifecycle.LifecycleException

get

public <T> T get(String key)

Description copied from interface: Registry

Alias method performing the lookup, here to simplify syntax when called from dynamic languages.

Specified by:

get in interface Registry

unregisterObject

public final Object unregisterObject(String key)
                              throws RegistrationException

Description copied from interface: Registry

Will remove an object by name from the registry. By default the registry must apply all remaining lifecycle phases to the object when it is removed.

Specified by:

unregisterObject in interface Registry

Parameters:

key - the name or key of the object to remove from the registry

Returns:

the unregistered object or null if no object was registered under that key

Throws:

RegistrationException - if there is a problem unregistering the object. Typically this will be because the object's lifecycle threw an exception

unregisterObject

@Deprecated
public final Object unregisterObject(String key,
                                                 Object metadata)
                                          throws RegistrationException

Deprecated.

Will remove an object by name from the registry. By default the registry must apply all remaining lifecycle phases to the object when it is removed.

Specified by:

unregisterObject in interface Registry

Parameters:

key - the name or key of the object to remove from the registry

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

Throws:

RegistrationException - if there is a problem unregistering the object. Typically this will be because the object's lifecycle threw an exception

doUnregisterObject

protected abstract Object doUnregisterObject(String key)
                                      throws RegistrationException

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

Parameters:

key - the key of the object to be unregistered object

Returns:

the object which was registered under key

Throws:

RegistrationException

lookupObject

public <T> T lookupObject(Class<T> type)
                   throws RegistrationException

Description copied from interface: Registry

Look up a single object by type.

Specified by:

lookupObject in interface Registry

Returns:

object or null if not found

Throws:

RegistrationException - if more than one object is found.

lookupObjectsForLifecycle

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

Description copied from interface: Registry

Look up all objects of a given type that lifecycle should be applied to. This method differs from Registry.lookupObjects(Class) in that it allows implementations to provide an alternative implementation of lookup for lifecycle. For example only returning pre-existing objects and not creating new ones on the fly.

Specified by:

lookupObjectsForLifecycle in interface Registry

Returns:

collection of objects or empty collection if none found

getRegistryId

public final String getRegistryId()

Specified by:

getRegistryId in interface Registry