org.mule.module.guice

Class GuiceRegistry

java.lang.Object

org.mule.registry.AbstractRegistry

org.mule.module.guice.GuiceRegistry

All Implemented Interfaces:

Disposable, Initialisable, Registry

Deprecated.

Guice module is deprecated and will be removed in Mule 4.

@Deprecated
public class GuiceRegistry
extends AbstractRegistry

The internal Mule interface for retreiving objects from a Guice injector. This registry is read-only since all objects should be configured by Module objects. The lifecycle of objects will be managed by Mule since Guice does not provide lifecycle support.

To create modules extend the AbstractMuleGuiceModule since it provides hooks and helpers for working with Mule configuration. Any modules independent of Mule can just extend the Guice AbstractModule as normal.

Mule will discover modules on the classpath, if you need to configure a module before passing it to the Guice injector you need to implement a GuiceModuleFactory for your module.

See Also:

AbstractMuleGuiceModule, GuiceModuleFactory

Field Summary

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
GuiceRegistry(MuleContext muleContext) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDispose() Deprecated.
protected void	doInitialise() Deprecated.
protected Object	doUnregisterObject(String key) Deprecated. Template method for the logic to actually unregister the key without applying any lifecycle to it.
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> Collection<T>	lookupObjects(Class<T> type) Deprecated. Look up all objects of a given type.
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. Registers an object in the registry with a key.
void	registerObjects(Map objects) Deprecated. Registers a Map of objects into the registry

Methods inherited from class org.mule.registry.AbstractRegistry

createLifecycleManager, dispose, fireLifecycle, get, getLifecycleManager, getRegistryId, initialise, isInitialised, lookupObjectsForLifecycle, unregisterObject, unregisterObject

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiceRegistry

public GuiceRegistry(MuleContext muleContext)

Deprecated.

Method Detail

doInitialise

protected void doInitialise()
                     throws InitialisationException

Deprecated.

Specified by:

doInitialise in class AbstractRegistry

Throws:

InitialisationException

doDispose

protected void doDispose()

Deprecated.

Specified by:

doDispose in class AbstractRegistry

lookupObject

public <T> T lookupObject(String key)

Deprecated.

Description copied from interface: Registry

Look up a single object by name.

Returns:

object or null if not found

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

Overrides:

lookupObject in class AbstractRegistry

Returns:

object or null if not found

Throws:

RegistrationException - if more than one object is found.

lookupByType

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

Deprecated.

Returns:

key/object pairs

lookupObjects

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

Deprecated.

Description copied from interface: Registry

Look up all objects of a given type.

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.

Returns:

collection of objects or empty collection if none found

registerObject

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

Deprecated.

Description copied from interface: Registry

Registers an object in the registry with a key.

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

Deprecated.

Description copied from interface: Registry

Registers an object in the registry with a key.

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.

Description copied from interface: Registry

Registers a Map of objects into the 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

Deprecated.

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

isReadOnly

public boolean isReadOnly()

Deprecated.

isRemote

public boolean isRemote()

Deprecated.