org.mule

Class MuleServer

java.lang.Object

org.mule.MuleServer

All Implemented Interfaces:

Runnable

public class MuleServer
extends Object
implements Runnable

MuleServer is a simple application that represents a local Mule Server daemon. It is initialised with a mule-config.xml file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASSNAME_ANNOTATIONS_CONFIG_BUILDER If the annotations module is on the classpath, also enable annotations config builder
protected static String	CLASSNAME_DEFAULT_CONFIG_BUILDER Don't use a class object so the core doesn't depend on mule-module-spring-config.
protected static String	CLASSNAME_DEFAULT_IDLE_CONFIG_BUILDER This builder sets up the configuration for an idle Mule node - a node that doesn't do anything initially but is fed configuration during runtime
protected static String	CLASSNAME_SPRING_CONFIG_BUILDER Required to support the '-config spring' shortcut.
static String[][]	CLI_OPTIONS
static String	DEFAULT_APP_CONFIGURATION
static String	DEFAULT_CONFIGURATION
protected static MuleContext	muleContext The MuleContext should contain anything which does not belong in the Registry.

Constructor Summary

Constructors

Constructor and Description
MuleServer()
MuleServer(String configResources)
MuleServer(String[] args) Configure the server with command-line arguments.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAnnotationsConfigBuilder(List<ConfigurationBuilder> builders) If the annotations module is on the classpath, add the annotations config builder to the list.
protected void	addStartupPropertiesConfigBuilder(List<ConfigurationBuilder> builders)
protected ConfigurationBuilder	createConfigurationBuilder()
protected MuleConfiguration	createMuleConfiguration()
protected void	doShutdown()
static String	getConfigBuilderClassName() Returns the class name of the configuration builder used to create this MuleServer.
String	getConfigurationResources() Getter for property messengerURL.
Log	getLogger()
MuleContext	getMuleContext()
static String	getStartupPropertiesFile()
protected void	init(String[] args)
void	initialize() Initializes this daemon.
static void	main(String[] args) Application entry point.
void	registerShutdownHook()
void	run() Overloaded the [main] thread run method.
static void	setConfigBuilderClassName(String builderClassName) Sets the configuration builder to use for this server.
void	setConfigurationResources(String configurationResources) Setter for property configurationResources.
static void	setStartupPropertiesFile(String startupPropertiesFile)
void	shutdown() shutdown the server.
void	shutdown(Throwable e) Will shut down the server displaying the cause and time of the shutdown
void	start(boolean ownThread, boolean registerShutdownHook) Start the mule server
void	unregisterShutdownHook()

Methods inherited from class java.lang.Object

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

Field Detail

CLI_OPTIONS

public static final String[][] CLI_OPTIONS

CLASSNAME_DEFAULT_CONFIG_BUILDER

protected static final String CLASSNAME_DEFAULT_CONFIG_BUILDER

Don't use a class object so the core doesn't depend on mule-module-spring-config.

See Also:

Constant Field Values

CLASSNAME_DEFAULT_IDLE_CONFIG_BUILDER

protected static final String CLASSNAME_DEFAULT_IDLE_CONFIG_BUILDER

This builder sets up the configuration for an idle Mule node - a node that doesn't do anything initially but is fed configuration during runtime

See Also:

Constant Field Values

CLASSNAME_SPRING_CONFIG_BUILDER

protected static final String CLASSNAME_SPRING_CONFIG_BUILDER

Required to support the '-config spring' shortcut. Don't use a class object so the core doesn't depend on mule-module-spring. for Mule 2.x

See Also:

Constant Field Values

CLASSNAME_ANNOTATIONS_CONFIG_BUILDER

public static final String CLASSNAME_ANNOTATIONS_CONFIG_BUILDER

If the annotations module is on the classpath, also enable annotations config builder

See Also:

Constant Field Values

DEFAULT_CONFIGURATION

public static final String DEFAULT_CONFIGURATION

See Also:

Constant Field Values

DEFAULT_APP_CONFIGURATION

public static final String DEFAULT_APP_CONFIGURATION

See Also:

Constant Field Values

muleContext

protected static MuleContext muleContext

The MuleContext should contain anything which does not belong in the Registry. There is one MuleContext per Mule instance. Assuming it has been created, a handle to the local MuleContext can be obtained from anywhere by calling MuleServer.getMuleContext()

Constructor Detail

MuleServer

public MuleServer()

MuleServer

public MuleServer(String configResources)

MuleServer

public MuleServer(String[] args)
           throws IllegalArgumentException

Configure the server with command-line arguments.

Parameters:

args - Command line args passed in from the main(String[]) method

Throws:

IllegalArgumentException - if an argument is passed in that is not recognised by the Mule Server

Method Detail

main

public static void main(String[] args)
                 throws Exception

Application entry point.

Parameters:

args - command-line args

Throws:

Exception - if there is an exception creating the MuleServer

init

protected void init(String[] args)
             throws IllegalArgumentException

Throws:

IllegalArgumentException

start

public void start(boolean ownThread,
         boolean registerShutdownHook)

Start the mule server

Parameters:

ownThread - determines if the server will run in its own daemon thread or the current calling thread

registerShutdownHook - whether to register the default Mule Server shutdown hock. this will shut down mule cleanly if the JVM is shutdown. The only reason not to register this hook is to override it with a custom version

run

public void run()

Overloaded the [main] thread run method. This calls initialise and shuts down if an exception occurs

Specified by:

run in interface Runnable

setConfigBuilderClassName

public static void setConfigBuilderClassName(String builderClassName)
                                      throws ClassNotFoundException

Sets the configuration builder to use for this server. Note that if a builder is not set and the server's start method is called the default is an instance of SpringXmlConfigurationBuilder.

Parameters:

builderClassName - the configuration builder FQN to use

Throws:

ClassNotFoundException - if the class with the given name can not be loaded

getConfigBuilderClassName

public static String getConfigBuilderClassName()

Returns the class name of the configuration builder used to create this MuleServer.

Returns:

FQN of the current config builder

initialize

public void initialize()
                throws Exception

Initializes this daemon. Derived classes could add some extra behaviour if they wish.

Throws:

Exception - if failed to initialize

createConfigurationBuilder

protected ConfigurationBuilder createConfigurationBuilder()
                                                   throws ConfigurationException

Throws:

ConfigurationException

addAnnotationsConfigBuilder

protected void addAnnotationsConfigBuilder(List<ConfigurationBuilder> builders)
                                    throws Exception

If the annotations module is on the classpath, add the annotations config builder to the list. This will enable annotations config for this instance.

Throws:

Exception

addStartupPropertiesConfigBuilder

protected void addStartupPropertiesConfigBuilder(List<ConfigurationBuilder> builders)
                                          throws IOException

Throws:

IOException

createMuleConfiguration

protected MuleConfiguration createMuleConfiguration()

shutdown

public void shutdown(Throwable e)

Will shut down the server displaying the cause and time of the shutdown

Parameters:

e - the exception that caused the shutdown

shutdown

public void shutdown()

shutdown the server. This just displays the time the server shut down

doShutdown

protected void doShutdown()

getLogger

public Log getLogger()

registerShutdownHook

public void registerShutdownHook()

unregisterShutdownHook

public void unregisterShutdownHook()

getConfigurationResources

public String getConfigurationResources()

Getter for property messengerURL.

Returns:

Value of property messengerURL.

setConfigurationResources

public void setConfigurationResources(String configurationResources)

Setter for property configurationResources.

Parameters:

configurationResources - New value of property configurationResources.

getStartupPropertiesFile

public static String getStartupPropertiesFile()

setStartupPropertiesFile

public static void setStartupPropertiesFile(String startupPropertiesFile)

getMuleContext

public MuleContext getMuleContext()