org.mule.component

Class PooledJavaComponent.LifeCycleAdapterFactory

java.lang.Object

org.mule.component.PooledJavaComponent.LifeCycleAdapterFactory

All Implemented Interfaces:

Disposable, Initialisable, ObjectFactory

Enclosing class:

PooledJavaComponent

protected class PooledJavaComponent.LifeCycleAdapterFactory
extends Object
implements ObjectFactory

LifeCycleAdaptorFactory wraps the Component' s ObjectFactory. The LifeCycleAdaptorFactory getInstance() method creates a new LifecycleAdapter wrapping the object instance obtained for the component instance ObjectFactory set on the Component.
This allows us to keep LifecycleAdapter creation in the Component and out of the DefaultLifecycleEnabledObjectPool and to use the generic ObjectPool interface.

Field Summary

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

Modifier	Constructor and Description
protected	PooledJavaComponent.LifeCycleAdapterFactory()

Method Summary

Methods

Modifier and Type	Method and Description
void	addObjectInitialisationCallback(InitialisationCallback callback) Register a custom initialiser
void	dispose() A lifecycle method where implementor should free up any resources.
Object	getInstance(MuleContext context) Retrieve an instance of the object.
Class<?>	getObjectClass() Returns the class of the object to be instantiated without actually creating an instance.
void	initialise() Method used to perform any initialisation work.
boolean	isAutoWireObject() Return true if the created object should get its dependencies wired from the registry automatically.
boolean	isExternallyManagedLifecycle() Returns true if Mule should not manage the life-cycle the object instance returned from the ObjectFactory.
boolean	isSingleton() Returns true if the ObjectFactory implementation always returns the same object instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

PooledJavaComponent.LifeCycleAdapterFactory

protected PooledJavaComponent.LifeCycleAdapterFactory()

Method Detail

getInstance

public Object getInstance(MuleContext context)
                   throws Exception

Description copied from interface: ObjectFactory

Retrieve an instance of the object. This may create a new instance or look up an existing instance depending on the implementation. If a new instance is created it will also be initialized by this method (Initilisable.initialise()).

Specified by:

getInstance in interface ObjectFactory

Parameters:

context - the current MuleContext instance. This can be used for performing registry look-ups applying processors to newly created objects or even firing custom notifications

Returns:

A new instance of an object. The factory may decide to return the same instance each type or create a new instance each time

Throws:

Exception - if there is an exception thrown creating the new instance

getObjectClass

public Class<?> getObjectClass()

Description copied from interface: ObjectFactory

Returns the class of the object to be instantiated without actually creating an instance. This may not be logical or even possible depending on the implementation.

Specified by:

getObjectClass in interface ObjectFactory

initialise

public void initialise()
                throws InitialisationException

Description copied from interface: Initialisable

Method used to perform any initialisation work. If a fatal error occurs during initialisation an InitialisationException should be thrown, causing the Mule instance to shutdown. If the error is recoverable, say by retrying to connect, a RecoverableException should be thrown. There is no guarantee that by throwing a Recoverable exception that the Mule instance will not shut down.

Specified by:

initialise in interface Initialisable

Throws:

InitialisationException - if a fatal error occurs causing the Mule instance to shutdown

RecoverableException - if an error occurs that can be recovered from

dispose

public void dispose()

Description copied from interface: Disposable

A lifecycle method where implementor should free up any resources. If an exception is thrown it should just be logged and processing should continue. This method should not throw Runtime exceptions.

Specified by:

dispose in interface Disposable

addObjectInitialisationCallback

public void addObjectInitialisationCallback(InitialisationCallback callback)

Description copied from interface: ObjectFactory

Register a custom initialiser

Specified by:

addObjectInitialisationCallback in interface ObjectFactory

isSingleton

public boolean isSingleton()

Description copied from interface: ObjectFactory

Returns true if the ObjectFactory implementation always returns the same object instance.

Specified by:

isSingleton in interface ObjectFactory

isExternallyManagedLifecycle

public boolean isExternallyManagedLifecycle()

Description copied from interface: ObjectFactory

Returns true if Mule should not manage the life-cycle the object instance returned from the ObjectFactory. This is normally false except when an ObjectFactory implementation obtains instance from containers (e.g. Spring) that already manages the objects lifecycle. instance.

Specified by:

isExternallyManagedLifecycle in interface ObjectFactory

isAutoWireObject

public boolean isAutoWireObject()

Description copied from interface: ObjectFactory

Return true if the created object should get its dependencies wired from the registry automatically. Typically Mule object factories would return true for this value, objects managed by DI container such as Spring should set this to false.

Specified by:

isAutoWireObject in interface ObjectFactory