Class Configurator

java.lang.Object

org.codehaus.classworlds.Configurator

public class Configurator
extends Object

Launcher configurator.

Version:

$Id: Configurator.java 126 2006-01-12 04:17:51Z $

Author:

bob mcwhirter, Jason van Zyl

Field Summary

Fields

Modifier and Type	Field	Description
private Map	configuredRealms	Processed Realms.
static final String	IMPORT_PREFIX
private Launcher	launcher	The launcher to configure.
static final String	LOAD_PREFIX
static final String	MAIN_PREFIX
static final String	OPTIONALLY_PREFIX	Optionally spec prefix.
static final String	SET_PREFIX
private ClassWorld	world

Constructor Summary

Constructors

Constructor	Description
Configurator(ClassWorld world)	Construct.
Configurator(Launcher launcher)	Construct.

Method Summary

Modifier and Type	Method	Description
protected void	associateRealms()	Associate parent realms with their children.
private boolean	canIgnore(String line)	Determine if a line can be ignored because it is a comment or simply blank.
void	configure(InputStream is)	Configure from a file.
protected String	filter(String text)	Filter a string for system properties.
protected void	loadGlob(String line, ClassRealm realm)	Load a glob into the specified classloader.
protected void	loadGlob(String line, ClassRealm realm, boolean optionally)	Load a glob into the specified classloader.
void	setClassWorld(ClassWorld world)	set world.

Methods inherited from class java.lang.Object

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

Field Details

MAIN_PREFIX

public static final String MAIN_PREFIX

See Also:

• Constant Field Values

SET_PREFIX

public static final String SET_PREFIX

See Also:

• Constant Field Values

IMPORT_PREFIX

public static final String IMPORT_PREFIX

See Also:

• Constant Field Values

LOAD_PREFIX

public static final String LOAD_PREFIX

See Also:

• Constant Field Values

OPTIONALLY_PREFIX

public static final String OPTIONALLY_PREFIX

Optionally spec prefix.

See Also:

• Constant Field Values

launcher

private Launcher launcher

The launcher to configure.

world

private ClassWorld world

configuredRealms

private Map configuredRealms

Processed Realms.

Constructor Details

Configurator

public Configurator(Launcher launcher)

Construct.

Parameters:

launcher - The launcher to configure.

Configurator

public Configurator(ClassWorld world)

Construct.

Parameters:

classWorld - The classWorld to configure.

Method Details

setClassWorld

public void setClassWorld(ClassWorld world)

set world. this setter is provided so you can use the same configurator to configure several "worlds"

Parameters:

classWorld - The classWorld to configure.

configure

public void configure(InputStream is)
               throws IOException,
MalformedURLException,
ConfigurationException,
DuplicateRealmException,
NoSuchRealmException

Configure from a file.

Parameters:

is - The config input stream

Throws:

IOException - If an error occurs reading the config file.

MalformedURLException - If the config file contains invalid URLs.

ConfigurationException - If the config file is corrupt.

DuplicateRealmException - If the config file defines two realms with the same id.

NoSuchRealmException - If the config file defines a main entry point in a non-existent realm.

associateRealms

protected void associateRealms()

Associate parent realms with their children.

loadGlob

protected void loadGlob(String line,
 ClassRealm realm)
                 throws MalformedURLException,
FileNotFoundException

Load a glob into the specified classloader.

Parameters:

line - The path configuration line.

realm - The realm to populate

Throws:

MalformedURLException - If the line does not represent a valid path element.

FileNotFoundException - If the line does not represent a valid path element in the filesystem.

loadGlob

protected void loadGlob(String line,
 ClassRealm realm,
 boolean optionally)
                 throws MalformedURLException,
FileNotFoundException

Load a glob into the specified classloader.

Parameters:

line - The path configuration line.

realm - The realm to populate

optionally - Whether the path is optional or required

Throws:

MalformedURLException - If the line does not represent a valid path element.

FileNotFoundException - If the line does not represent a valid path element in the filesystem.

filter

protected String filter(String text)
                 throws ConfigurationException

Filter a string for system properties.

Parameters:

text - The text to filter.

Returns:

The filtered text.

Throws:

ConfigurationException - If the property does not exist or if there is a syntax error.

canIgnore

private boolean canIgnore(String line)

Determine if a line can be ignored because it is a comment or simply blank.

Parameters:

line - The line to test.

Returns:

true if the line is ignorable, otherwise false.