org.overlord.commons.config.configurator

Class AbstractConfigurator

java.lang.Object

org.overlord.commons.config.configurator.AbstractConfigurator

All Implemented Interfaces:

Configurator

Direct Known Subclasses:

FabricConfigurator, FuseConfigurator, JbossConfigurator, JettyConfigurator, TomcatConfigurator, UserHomeConfigurator

public abstract class AbstractConfigurator
extends Object
implements Configurator

Contains the main configurator code. It tries to read the configuration from the server api, if it is implemented. If not, it reads the configuration from a file located in the server installation path. This file location changes depends on the configurator.

Author:

David Virgil Naranjo

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurator()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfiguration(org.apache.commons.configuration.CompositeConfiguration config, String configFileOverride, String standardConfigFileName, Long refreshDelay) Adds the configuration.
protected URL	findConfig(String configFileOverride, String standardConfigFileName) Try to find the configuration file.
protected abstract URL	getServerConfigUrl(String standardConfigFileName) Gets the server config url.
protected boolean	setConfigurationFromServerApi(org.apache.commons.configuration.Configuration config, String configFileOverride, String standardConfigFileName) Sets the configuration from server api.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConfigurator

public AbstractConfigurator()

Method Detail

addConfiguration

public void addConfiguration(org.apache.commons.configuration.CompositeConfiguration config,
                    String configFileOverride,
                    String standardConfigFileName,
                    Long refreshDelay)
                      throws org.apache.commons.configuration.ConfigurationException

Description copied from interface: Configurator

Adds the configuration.

Specified by:

addConfiguration in interface Configurator

Parameters:

config - the config

configFileOverride - the config file override

standardConfigFileName - the standard config file name

refreshDelay - the refresh delay

Throws:

org.apache.commons.configuration.ConfigurationException - the configuration exception

getServerConfigUrl

protected abstract URL getServerConfigUrl(String standardConfigFileName)
                                   throws MalformedURLException

Gets the server config url.

Parameters:

standardConfigFileName - the standard config file name

Returns:

the server config url

Throws:

MalformedURLException - the malformed url exception

setConfigurationFromServerApi

protected boolean setConfigurationFromServerApi(org.apache.commons.configuration.Configuration config,
                                    String configFileOverride,
                                    String standardConfigFileName)

Sets the configuration from server api.

Parameters:

config - the config

configFileOverride - the config file override

standardConfigFileName - the standard config file name

Returns:

true, if successful

findConfig

protected URL findConfig(String configFileOverride,
             String standardConfigFileName)

Try to find the configuration file. This will look for the config file in a number of places.

Parameters:

configFileOverride - the config file override

standardConfigFileName - the standard config file name

Returns:

the url