org.mule.runtime.core.api.lifecycle

Class LifecycleUtils

java.lang.Object

org.mule.runtime.core.api.lifecycle.LifecycleUtils

public class LifecycleUtils
extends Object

Utility class for performing lifecycle operations on objects, as long as they implement cooresponding annotations such as Initialisable, Startable, Stoppable, Disposable or even MuleContextAware.

The Optional object container is also supported, in which case the operation will be evaluated on the value it holds or not at all if the value is not present.

Since:

3.7.0

Method Summary

Modifier and Type	Method and Description
static void	assertNotStopping(MuleContext muleContext, String errorMessage) Verifies that the given muleContext is not stopped or in the process of stopping
static void	disposeIfNeeded(Collection<? extends Object> objects, org.slf4j.Logger logger) For each item in the objects collection, it invokes Disposable.dispose() if it implements the Disposable interface.
static void	disposeIfNeeded(Object object, org.slf4j.Logger logger) Invokes Disposable.dispose() on object if it implements the Disposable interface.
static void	initialiseIfNeeded(Collection<? extends Object> objects) For each item in the objects collection, it invokes initialiseIfNeeded(Object)
static void	initialiseIfNeeded(Collection<? extends Object> objects, boolean inject, MuleContext muleContext) For each item in the objects collection, it invokes initialiseIfNeeded(Object, MuleContext)
static void	initialiseIfNeeded(Collection<? extends Object> objects, MuleContext muleContext) For each item in the objects collection, it invokes initialiseIfNeeded(Object, MuleContext)
static void	initialiseIfNeeded(Object object) Invokes Initialisable.initialise() on object if it implements the Initialisable interface.
static void	initialiseIfNeeded(Object object, boolean inject, MuleContext muleContext) The same as initialiseIfNeeded(Object), only that before checking for object being Initialisable, it uses the given muleContext to perform further initialization.
static void	initialiseIfNeeded(Object object, MuleContext muleContext) The same as initialiseIfNeeded(Object), only that before checking for object being Initialisable, it uses the given muleContext to perform further initialization.
static void	initialiseIfNeeded(Object object, MuleContext muleContext, FlowConstruct flowConstruct) The same as initialiseIfNeeded(Object, MuleContext), only that it also checks if it implements FlowConstructAware, in which case it will invoke FlowConstructAware.setFlowConstruct(FlowConstruct) with the given flowConstruct
static void	safeStopIfNeeded(Collection<? extends Object> objects, org.slf4j.Logger logger) For each item in the objects collection, it invokes the Stoppable.stop() if it implements the Stoppable interface.
static void	setFlowConstructIfNeeded(Collection<? extends Object> objects, FlowConstruct flowConstruct) Sets an objects FlowConstruct if it implements FlowConstructAware.
static void	setFlowConstructIfNeeded(Object object, FlowConstruct flowConstruct) Sets an objects FlowConstruct if it implements FlowConstructAware.
static void	setMuleContextIfNeeded(Collection<? extends Object> objects, MuleContext muleContext) Sets an objects MuleContext if it implements MuleContextAware.
static void	setMuleContextIfNeeded(Object object, MuleContext muleContext) Sets an objects MuleContext if it implements MuleContextAware.
static void	startIfNeeded(Collection<? extends Object> objects) For each item in the objects collection, it invokes the the Startable.start() if it implements the Startable interface.
static void	startIfNeeded(Object object) Invokes Startable.start() on object if it implements the Startable interface
static void	stopIfNeeded(Collection<? extends Object> objects) For each item in the objects collection, it invokes the Stoppable.stop() if it implements the Stoppable interface.
static void	stopIfNeeded(Object object) Invokes the Stoppable.stop() on object if it implements the Stoppable interface.

Methods inherited from class java.lang.Object

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

Method Detail

initialiseIfNeeded

public static void initialiseIfNeeded(Object object)
                               throws org.mule.runtime.api.lifecycle.InitialisationException

Invokes Initialisable.initialise() on object if it implements the Initialisable interface.

Parameters:

object - the object you're trying to initialise

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

initialiseIfNeeded

public static void initialiseIfNeeded(Object object,
                                      MuleContext muleContext,
                                      FlowConstruct flowConstruct)
                               throws org.mule.runtime.api.lifecycle.InitialisationException

The same as initialiseIfNeeded(Object, MuleContext), only that it also checks if it implements FlowConstructAware, in which case it will invoke FlowConstructAware.setFlowConstruct(FlowConstruct) with the given flowConstruct

Parameters:

object - the object you're trying to initialise

muleContext - a MuleContext

flowConstruct - the FlowConstruct in which the object is defined.

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

initialiseIfNeeded

public static void initialiseIfNeeded(Object object,
                                      MuleContext muleContext)
                               throws org.mule.runtime.api.lifecycle.InitialisationException

The same as initialiseIfNeeded(Object), only that before checking for object being Initialisable, it uses the given muleContext to perform further initialization.

It checks if the object implements MuleContextAware, in which case it will invoke MuleContextAware.setMuleContext(MuleContext) with the given muleContext.

Parameters:

object - the object you're trying to initialise

muleContext - a MuleContext

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

IllegalArgumentException - if MuleContext is null

initialiseIfNeeded

public static void initialiseIfNeeded(Object object,
                                      boolean inject,
                                      MuleContext muleContext)
                               throws org.mule.runtime.api.lifecycle.InitialisationException

The same as initialiseIfNeeded(Object), only that before checking for object being Initialisable, it uses the given muleContext to perform further initialization.

It checks if the object implements MuleContextAware, in which case it will invoke MuleContextAware.setMuleContext(MuleContext) with the given muleContext.

Also depending on the value of the inject argument, it will perform dependency injection on the object

Parameters:

object - the object you're trying to initialise

inject - whether it should perform dependency injection on the object before actually initialising it

muleContext - a MuleContext

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

IllegalArgumentException - if MuleContext is null

initialiseIfNeeded

public static void initialiseIfNeeded(Collection<? extends Object> objects)
                               throws org.mule.runtime.api.lifecycle.InitialisationException

For each item in the objects collection, it invokes initialiseIfNeeded(Object)

Parameters:

objects - the list of objects to be initialised

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

initialiseIfNeeded

public static void initialiseIfNeeded(Collection<? extends Object> objects,
                                      MuleContext muleContext)
                               throws org.mule.runtime.api.lifecycle.InitialisationException

For each item in the objects collection, it invokes initialiseIfNeeded(Object, MuleContext)

Parameters:

objects - the list of objects to be initialised

muleContext - a MuleContext

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

initialiseIfNeeded

public static void initialiseIfNeeded(Collection<? extends Object> objects,
                                      boolean inject,
                                      MuleContext muleContext)
                               throws org.mule.runtime.api.lifecycle.InitialisationException

For each item in the objects collection, it invokes initialiseIfNeeded(Object, MuleContext)

Also depending on the value of the inject argument, it will perform dependency injection on the objects

Parameters:

objects - the list of objects to be initialised

inject - whether it should perform dependency injection on the object before actually initialising it

muleContext - a MuleContext

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

startIfNeeded

public static void startIfNeeded(Object object)
                          throws org.mule.runtime.api.exception.MuleException

Invokes Startable.start() on object if it implements the Startable interface

Parameters:

object - the object you're trying to start

Throws:

org.mule.runtime.api.exception.MuleException

startIfNeeded

public static void startIfNeeded(Collection<? extends Object> objects)
                          throws org.mule.runtime.api.exception.MuleException

For each item in the objects collection, it invokes the the Startable.start() if it implements the Startable interface.

Parameters:

objects - the list of objects to be started

Throws:

org.mule.runtime.api.exception.MuleException

stopIfNeeded

public static void stopIfNeeded(Collection<? extends Object> objects)
                         throws org.mule.runtime.api.exception.MuleException

For each item in the objects collection, it invokes the Stoppable.stop() if it implements the Stoppable interface.

Parameters:

objects - the list of objects to be stopped

Throws:

org.mule.runtime.api.exception.MuleException

safeStopIfNeeded

public static void safeStopIfNeeded(Collection<? extends Object> objects,
                                    org.slf4j.Logger logger)

For each item in the objects collection, it invokes the Stoppable.stop() if it implements the Stoppable interface.

This method is considered safe because it will not throw exception and the Stoppable.stop() method will be called on all the objects regarding on any (or all) of them throwing exceptions. Any exceptions generated will be logged using the provided logger and processing will continue

Parameters:

objects - the list of objects to be stopped

logger - the Logger in which any exception found is to be logged

stopIfNeeded

public static void stopIfNeeded(Object object)
                         throws org.mule.runtime.api.exception.MuleException

Invokes the Stoppable.stop() on object if it implements the Stoppable interface.

Parameters:

object - the object you're trying to stop

Throws:

org.mule.runtime.api.exception.MuleException

disposeIfNeeded

public static void disposeIfNeeded(Object object,
                                   org.slf4j.Logger logger)

Invokes Disposable.dispose() on object if it implements the Disposable interface. If the dispose operation fails, then the exception will be silently logged using the provided logger

Parameters:

object - the object you're trying to dispose

disposeIfNeeded

public static void disposeIfNeeded(Collection<? extends Object> objects,
                                   org.slf4j.Logger logger)

For each item in the objects collection, it invokes Disposable.dispose() if it implements the Disposable interface.

Per each dispose operation that fails, the exception will be silently logged using the provided logger

Parameters:

objects - the list of objects to be stopped

Throws:

org.mule.runtime.api.exception.MuleException

assertNotStopping

public static void assertNotStopping(MuleContext muleContext,
                                     String errorMessage)

Verifies that the given muleContext is not stopped or in the process of stopping

Parameters:

muleContext - the MuleContext to test

errorMessage - the message of the Exception to be thrown if the assertion fails

Throws:

IllegalStateException - if the muleContext is stopped or stopping

Since:

4.0

setFlowConstructIfNeeded

public static void setFlowConstructIfNeeded(Object object,
                                            FlowConstruct flowConstruct)

Sets an objects FlowConstruct if it implements FlowConstructAware.

Parameters:

object - the object to inject the FlowConstruct into.

flowConstruct - the FlowConstruct in which the object is defined.

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

setFlowConstructIfNeeded

public static void setFlowConstructIfNeeded(Collection<? extends Object> objects,
                                            FlowConstruct flowConstruct)

Sets an objects FlowConstruct if it implements FlowConstructAware.

Parameters:

objects - the objects to inject the FlowConstruct into.

flowConstruct - the FlowConstruct in which the object is defined.

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

setMuleContextIfNeeded

public static void setMuleContextIfNeeded(Object object,
                                          MuleContext muleContext)

Sets an objects MuleContext if it implements MuleContextAware.

Parameters:

object - the object to inject the MuleContext into.

muleContext - the MuleContext in which the object is defined.

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

setMuleContextIfNeeded

public static void setMuleContextIfNeeded(Collection<? extends Object> objects,
                                          MuleContext muleContext)

Sets an objects MuleContext if it implements MuleContextAware.

Parameters:

objects - the objects to inject the MuleContext into.

muleContext - the MuleContext in which the object is defined.

Throws:

org.mule.runtime.api.lifecycle.InitialisationException