org.mule.runtime.core.config.bootstrap

Class AbstractRegistryBootstrap

java.lang.Object

org.mule.runtime.core.config.bootstrap.AbstractRegistryBootstrap

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Initialisable

Direct Known Subclasses:

SimpleRegistryBootstrap

public abstract class AbstractRegistryBootstrap
extends Object
implements org.mule.runtime.api.lifecycle.Initialisable

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/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.compatibility.core.transport.jms.transformers.JMSMessageToObject,returnClass=byte[]
 transformer.2=org.mule.compatibility.core.transport.jms.transformers.JMSMessageToObject,returnClass=java.lang.String:text/xml, name=JMSMessageToString
 transformer.3=org.mule.compatibility.core.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 ArtifactType	artifactType
protected org.slf4j.Logger	logger
protected MuleContext	muleContext
static String	OBJECT_KEY
static String	SINGLE_TX
static String	TRANSFORMER_KEY

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractRegistryBootstrap(ArtifactType artifactType, MuleContext muleContext)

Method Summary

Modifier and Type	Method and Description
protected abstract void	doRegisterObject(ObjectBootstrapProperty bootstrapProperty)
protected abstract void	doRegisterTransformer(TransformerBootstrapProperty bootstrapProperty, Class<?> returnClass, Class<? extends Transformer> transformerClass)
void	initialise() TODO Optimize me! MULE-9343
protected abstract void	registerTransformers()

Methods inherited from class java.lang.Object

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

Field Detail

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

artifactType

protected ArtifactType artifactType

logger

protected final transient org.slf4j.Logger logger

muleContext

protected MuleContext muleContext

Constructor Detail

AbstractRegistryBootstrap

public AbstractRegistryBootstrap(ArtifactType artifactType,
                                 MuleContext muleContext)

Parameters:

artifactType - type of artifact. Bootstrap entries may be associated to an specific type of artifact. If it's not associated to the related artifact it will be ignored.

muleContext - the MuleContext of the artifact.

Method Detail

initialise

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

TODO Optimize me! MULE-9343

Specified by:

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

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

doRegisterTransformer

protected abstract void doRegisterTransformer(TransformerBootstrapProperty bootstrapProperty,
                                              Class<?> returnClass,
                                              Class<? extends Transformer> transformerClass)
                                       throws Exception

Throws:

Exception

registerTransformers

protected abstract void registerTransformers()
                                      throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

doRegisterObject

protected abstract void doRegisterObject(ObjectBootstrapProperty bootstrapProperty)
                                  throws Exception

Throws:

Exception