org.mule.config.bootstrap

Class AbstractRegistryBootstrap

java.lang.Object

org.mule.config.bootstrap.AbstractRegistryBootstrap

All Implemented Interfaces:

MuleContextAware, Initialisable

Direct Known Subclasses:

SimpleRegistryBootstrap, SpringRegistryBootstrap

public abstract class AbstractRegistryBootstrap
extends Object
implements Initialisable, MuleContextAware

Base class for an object will load objects defined in a file called registry-bootstrap.properties into the local registry. This allows modules and transports to make certain objects available by default. The most common use case is for a module or transport to load stateless transformers into the registry. For this file to be located it must be present in the modules META-INF directory under

META-INF/services/org/mule/config/

The format of this file is a simple key / value pair. i.e.

 myobject=org.foo.MyObject
 

Will register an instance of MyObject with a key of 'myobject'. If you don't care about the object name and want to ensure that the ojbect gets a unique name you can use -

 object.1=org.foo.MyObject
 object.2=org.bar.MyObject
 

or

 myFoo=org.foo.MyObject
 myBar=org.bar.MyObject
 

It's also possible to define if the entry must be applied to a domain, an application, or both by using the parameter applyToArtifactType.

 myFoo=org.foo.MyObject will be applied to any mule application since the parameter applyToArtifactType default value is app
 myFoo=org.foo.MyObject;applyToArtifactType=app will be applied to any mule application
 myFoo=org.foo.MyObject;applyToArtifactType=domain will be applied to any mule domain
 myFoo=org.foo.MyObject;applyToArtifactType=app/domain will be applied to any mule application and any mule domain
 

Loading transformers has a slightly different notation since you can define the 'returnClass' with optional mime type, and 'name'of the transformer as parameters i.e.

 transformer.1=org.mule.transport.jms.transformers.JMSMessageToObject,returnClass=byte[]
 transformer.2=org.mule.transport.jms.transformers.JMSMessageToObject,returnClass=java.lang.String:text/xml, name=JMSMessageToString
 transformer.3=org.mule.transport.jms.transformers.JMSMessageToObject,returnClass=java.util.Hashtable)
 

Note that the key used for transformers must be 'transformer.x' where 'x' is a sequential number. The transformer name will be automatically generated as JMSMessageToXXX where XXX is the return class name i.e. JMSMessageToString unless a 'name' parameter is specified. If no 'returnClass' is specified the default in the transformer will be used.

Note that all objects defined have to have a default constructor. They can implement injection interfaces such as MuleContextAware and lifecycle interfaces such as Initialisable.

Since:

3.7.0

Field Summary

Fields

Modifier and Type	Field and Description
protected RegistryBootstrapDiscoverer	discoverer
protected org.slf4j.Logger	logger
protected MuleContext	muleContext
static String	OBJECT_KEY
static String	SINGLE_TX
protected ArtifactType	supportedArtifactType
static String	TRANSFORMER_KEY

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractRegistryBootstrap() Creates a default SimpleRegistryBootstrap using a ClassPathRegistryBootstrapDiscoverer in order to get the Properties resources from the class path.
AbstractRegistryBootstrap(RegistryBootstrapDiscoverer discoverer) Allows to specify a RegistryBootstrapDiscoverer to discover the Properties resources to be used.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doRegisterObject(String key, String className, boolean optional)
protected abstract void	doRegisterTransformer(String name, Class<?> returnClass, Class<? extends Transformer> transformerClass, String mime, boolean optional)
protected Class	getClass(String className)
void	initialise() TODO Optimize me! MULE-9343 Method used to perform any initialisation work.
protected abstract void	registerTransformers()
void	setMuleContext(MuleContext context)
void	setSupportedArtifactType(ArtifactType supportedArtifactType) This attributes define which types or registry bootstrap entries will be created depending on the entry applyToArtifactType parameter value.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final transient org.slf4j.Logger logger

TRANSFORMER_KEY

public static final String TRANSFORMER_KEY

See Also:

Constant Field Values

OBJECT_KEY

public static final String OBJECT_KEY

See Also:

Constant Field Values

SINGLE_TX

public static final String SINGLE_TX

See Also:

Constant Field Values

supportedArtifactType

protected ArtifactType supportedArtifactType

discoverer

protected final RegistryBootstrapDiscoverer discoverer

muleContext

protected MuleContext muleContext

Constructor Detail

AbstractRegistryBootstrap

public AbstractRegistryBootstrap()

Creates a default SimpleRegistryBootstrap using a ClassPathRegistryBootstrapDiscoverer in order to get the Properties resources from the class path.

AbstractRegistryBootstrap

public AbstractRegistryBootstrap(RegistryBootstrapDiscoverer discoverer)

Allows to specify a RegistryBootstrapDiscoverer to discover the Properties resources to be used.

Parameters:

discoverer -

Method Detail

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware

initialise

public void initialise()
                throws InitialisationException

TODO Optimize me! MULE-9343 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

doRegisterTransformer

protected abstract void doRegisterTransformer(String name,
                         Class<?> returnClass,
                         Class<? extends Transformer> transformerClass,
                         String mime,
                         boolean optional)
                                       throws Exception

Throws:

Exception

getClass

protected Class getClass(String className)
                  throws ClassNotFoundException

Throws:

ClassNotFoundException

registerTransformers

protected abstract void registerTransformers()
                                      throws MuleException

Throws:

MuleException

doRegisterObject

protected abstract void doRegisterObject(String key,
                    String className,
                    boolean optional)
                                  throws Exception

Throws:

Exception

setSupportedArtifactType

public void setSupportedArtifactType(ArtifactType supportedArtifactType)

This attributes define which types or registry bootstrap entries will be created depending on the entry applyToArtifactType parameter value.

Parameters:

supportedArtifactType - type of the artifact to support.