org.jboss.system.server
Class ServerLoader

java.lang.Object
  org.jboss.system.server.ServerLoader

public class ServerLoader

extends java.lang.Object

A helper class to load a JBoss server instance.

Basic usage is something like this:

    // setup the basic server config properties
    Properties props = new Properties(System.getProperties());
    props.put(ServerConfig.SERVER_LIBRARY_URL, "http://myserver.com/myjboss/lib/");
    // set some more properties

    // create a new loader to do the dirty work
    ServerLoader loader = new ServerLoader(props);

    // add the jaxp & jmx library to use
    loader.addLibrary("crimson.jar");
    loader.addLibrary("jboss-jmx-core.jar");

    // load and initialize the server instance
    ClassLoader parent = Thread.currentThread().getContextClassLoader();
    Server server = loader.load(parent);
    server.init(props);

    // start up the server
    server.start();

    // go make some coffee, drink a beer or play GTA3
    // ...

    // shutdown and go to sleep
    server.shutdown();
 

DEFAULT_BOOT_LIBRARY_LIST

public static final java.lang.String DEFAULT_BOOT_LIBRARY_LIST

The default list of boot libraries. Does not include the JAXP or JMX impl, users of this class should add the proper libraries.

See Also:

Constant Field Values (src)

DEFAULT_SERVER_TYPE

public static final java.lang.String DEFAULT_SERVER_TYPE

The default server type.

See Also:

Constant Field Values (src)

props

protected java.util.Properties props

Configuration properties.

libraryURL

protected java.net.URL libraryURL

The URL where libraries are read from.

extraClasspath

protected java.util.List extraClasspath

A list of extra URLs to add to the classpath when loading the server.

ServerLoader

public ServerLoader(java.util.Properties props)
             throws java.lang.Exception

Construct a ServerLoader.

Parameters:

props - Configuration properties.

Throws:

java.lang.Exception - Invalid configuration

addLibrary

public void addLibrary(java.lang.String filename)
                throws java.net.MalformedURLException

Add an extra library to the end of list of libraries which will be loaded from the library URL when loading the Server class.

Parameters:

filename - A filename (no directory parts)

Throws:

java.net.MalformedURLException - Could not generate URL from library URL + filename

addLibraries

public void addLibraries(java.lang.String filenames)
                  throws java.net.MalformedURLException

Add a list of comma seperated library file names.

Parameters:

filenames - A list of comma seperated filenames (with no directory parts)

Throws:

java.net.MalformedURLException - Could not generate URL from library URL + filename

addURL

public void addURL(java.net.URL url)

Add an extra URL to the classpath used to load the server.

Parameters:

url - A URL to add to the classpath.

addEndorsedJars

public void addEndorsedJars()
                     throws java.net.MalformedURLException

Add the jars from the lib/endorsed dir if it exists. Note, the path must exist locally for this to work.

Throws:

java.net.MalformedURLException - Could not generate URL from library URL + filename

getURL

protected java.net.URL getURL(java.lang.String name)
                       throws java.net.MalformedURLException

Get a URL from configuration or system properties.

Throws:

java.net.MalformedURLException

getBootClasspath

protected java.net.URL[] getBootClasspath()
                                   throws java.net.MalformedURLException

Retruns an array of URLs which will be used to load the core system and construct a new Server object instance.

Throws:

java.net.MalformedURLException

load

public Server (src)  load(java.lang.ClassLoader parent)
            throws java.lang.Exception

Load a Server (src) instance.

Returns:

An uninitialized (and unstarted) Server instance.

Throws:

java.lang.Exception - Failed to load or create Server instance.

createServer

protected Server (src)  createServer(java.lang.String typename,
                              java.lang.ClassLoader classLoader)
                       throws java.lang.Exception

Construct a new instance of Server, loading all required classes from the given ClossLoader.

Throws:

java.lang.Exception