org.mule.config.bootstrap
Class SimpleRegistryBootstrap

java.lang.Object
  org.mule.config.bootstrap.SimpleRegistryBootstrap

All Implemented Interfaces:

MuleContextAware, Initialisable

public class SimpleRegistryBootstrap
extends Object
implements Initialisable, MuleContextAware

This 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.

Nested Class Summary

static class

SimpleRegistryBootstrap.ArtifactType

Field Summary

protected MuleContext	context
protected org.apache.commons.logging.Log	logger
String	OBJECT_KEY
String	SINGLE_TX
String	TRANSFORMER_KEY

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

PHASE_NAME

Constructor Summary

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

SimpleRegistryBootstrap(RegistryBootstrapDiscoverer discoverer)
Allows to specify a RegistryBootstrapDiscoverer to discover the Properties resources to be used.

Method Summary

void	initialise() Method used to perform any initialisation work.
void	setMuleContext(MuleContext context)
void	setSupportedArtifactType(SimpleRegistryBootstrap.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.apache.commons.logging.Log logger

TRANSFORMER_KEY

public String TRANSFORMER_KEY

OBJECT_KEY

public String OBJECT_KEY

SINGLE_TX

public String SINGLE_TX

context

protected MuleContext context

Constructor Detail

SimpleRegistryBootstrap

public SimpleRegistryBootstrap()

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

SimpleRegistryBootstrap

public SimpleRegistryBootstrap(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

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

setSupportedArtifactType

public void setSupportedArtifactType(SimpleRegistryBootstrap.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.