org.mule.runtime.core.registry

Class AbstractRegistryBroker

java.lang.Object

org.mule.runtime.core.registry.AbstractRegistryBroker

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultRegistryBroker

Deprecated.

as of 3.7.0. This will be removed in Mule 4.0

@Deprecated
public abstract class AbstractRegistryBroker
extends Object
implements RegistryBroker, RegistryProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected RegistryBrokerLifecycleManager	lifecycleManager Deprecated.

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

Constructor and Description
AbstractRegistryBroker(MuleContext muleContext) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	dispose() Deprecated.
void	fireLifecycle(String phase) Deprecated.
<T> T	get(String key) Deprecated. Alias method performing the lookup, here to simplify syntax when called from dynamic languages.
String	getRegistryId() Deprecated.
void	initialise() Deprecated.
boolean	isReadOnly() Deprecated.
boolean	isRemote() Deprecated.
<T> Map<String,T>	lookupByType(Class<T> type) Deprecated.
<T> Collection<T>	lookupLocalObjects(Class<T> type) Deprecated. Look up all objects of a given type within the local registry.
<T> T	lookupObject(Class<T> type) Deprecated. Look up a single object by type.
<T> T	lookupObject(String key) Deprecated. Look up a single object by name.
<T> T	lookupObject(String key, boolean applyLifecycle) Deprecated. Iterates through RegistryProvider.getRegistries() trying to find the first one which is an instance of LifecycleRegistry.
<T> Collection<T>	lookupObjects(Class<T> type) Deprecated. Look up all objects of a given type.
<T> Collection<T>	lookupObjectsForLifecycle(Class<T> type) Deprecated. Look up all objects of a given type that lifecycle should be applied to.
void	registerObject(String key, Object value) Deprecated. Registers an object in the registry with a key.
void	registerObject(String key, Object value, Object metadata) Deprecated.
void	registerObjects(Map objects) Deprecated. Registers a Map of objects into the registry
Object	unregisterObject(String key) Deprecated. 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.RegistryBroker

addRegistry, removeRegistry

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

getRegistries

Field Detail

lifecycleManager

protected RegistryBrokerLifecycleManager lifecycleManager

Deprecated.

Constructor Detail

AbstractRegistryBroker

public AbstractRegistryBroker(MuleContext muleContext)

Deprecated.

Method Detail

initialise

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

Deprecated.

Specified by:

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

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

dispose

public void dispose()

Deprecated.

Specified by:

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

fireLifecycle

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

Deprecated.

Specified by:

fireLifecycle in interface Registry

Throws:

org.mule.runtime.api.lifecycle.LifecycleException

getRegistryId

public String getRegistryId()

Deprecated.

Specified by:

getRegistryId in interface Registry

isReadOnly

public boolean isReadOnly()

Deprecated.

Specified by:

isReadOnly in interface Registry

isRemote

public boolean isRemote()

Deprecated.

Specified by:

isRemote in interface Registry

get

public <T> T get(String key)

Deprecated.

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

lookupObject

public <T> T lookupObject(String key)

Deprecated.

Description copied from interface: Registry

Look up a single object by name.

Specified by:

lookupObject in interface Registry

Returns:

object or null if not found

lookupObject

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

Deprecated.

Iterates through RegistryProvider.getRegistries() trying to find the first one which is an instance of LifecycleRegistry. When found, it returns the result of LifecycleRegistry.lookupObject(String, boolean).

If none of the available registries is of that type, then it fallbacks to lookupObject(String)

Type Parameters:

T - the type of the expected object

Parameters:

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

applyLifecycle - whether lifecycle should be applied to the object before returning

Returns:

the object registered under key

lookupObject

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

Deprecated.

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.

lookupObjects

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

Deprecated.

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)

Deprecated.

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

lookupByType

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

Deprecated.

Specified by:

lookupByType in interface Registry

Returns:

key/object pairs

lookupObjectsForLifecycle

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

Deprecated.

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

registerObject

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

Deprecated.

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

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

Deprecated.

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 objects)
                     throws RegistrationException

Deprecated.

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

unregisterObject

public Object unregisterObject(String key)
                        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

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