org.erowid.sperowider.configuration
Class SperowiderConfigurator

java.lang.Object
  org.erowid.sperowider.configuration.SperowiderConfigurator

public class SperowiderConfigurator

extends Object

Given a JDOM Document, this class will instantiate, configure, and return a Sperowider.

Please look at single-config-sample.xml for detailed information on what configurations this class expects. That file is distributed as part of the standard SperoSuite deploy. Also look at multiple-config-sample.xml for an example of a configuration file with multiple targets.

Version:

: $Header: /cvsroot/sperowider/SPEROWIDER_MODULE/javasource/org/erowid/sperowider/configuration/SperowiderConfigurator.java,v 1.4 2005/01/16 09:47:31 gurustu Exp $

Author:

: $Author: gurustu $

Constructor Summary

SperowiderConfigurator()

Method Summary

static Object	initObject(Element configNode) Given a configuration, will return an object that has had IInitializableObject.init(Element) called on it.
static SperowiderConfiguration	instantiate(SperowiderConfiguration sperowiderConfiguration, Document configDoc) Delegates to instantiate(configDoc, null).
static void	instantiate(SperowiderConfiguration sperowiderConfiguration, Document configDoc, String target) This will create a SperowiderConfiguration based on the named target in the config document.
static void	instantiate(SperowiderConfiguration sperowiderConfiguration, InputStream config) Delegates to instantiate(SperowiderConfiguration, String, String) with a null target, returning a SperowiderConfiguration suitable for use in Sperowider.Sperowider(SperowiderConfiguration).
static void	instantiate(SperowiderConfiguration sperowiderConfiguration, InputStream config, String target) Delegates to instantiate(SperowiderConfiguration, String, String) with a null target, returning a SperowiderConfiguration suitable for use in Sperowider.Sperowider(SperowiderConfiguration).
static void	instantiate(SperowiderConfiguration sperowiderConfiguration, String filename) Delegates to instantiate(SperowiderConfiguration, String, String) with a null target, returning a SperowiderConfiguration suitable for use in Sperowider.Sperowider(SperowiderConfiguration).
static void	instantiate(SperowiderConfiguration sperowiderConfiguration, String filename, String target) Returns a SperowiderConfiguration suitable for use in Sperowider.Sperowider(SperowiderConfiguration), using the named file, with the named target.
static void	instantiateLog4j(InputStream inputStream) Sets up log4j with a given InputStream.
static void	instantiateLog4j(String filename) Sets up log4j with the given filename.

Methods inherited from class java.lang.Object

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

Constructor Detail

SperowiderConfigurator

public SperowiderConfigurator()

Method Detail

instantiate

public static void instantiate(SperowiderConfiguration sperowiderConfiguration,
                               InputStream config)
                        throws Exception

Delegates to instantiate(SperowiderConfiguration, String, String) with a null target, returning a SperowiderConfiguration suitable for use in Sperowider.Sperowider(SperowiderConfiguration).

Throws:

Exception

instantiate

public static void instantiate(SperowiderConfiguration sperowiderConfiguration,
                               InputStream config,
                               String target)
                        throws Exception

Delegates to instantiate(SperowiderConfiguration, String, String) with a null target, returning a SperowiderConfiguration suitable for use in Sperowider.Sperowider(SperowiderConfiguration).

Throws:

Exception

instantiate

public static void instantiate(SperowiderConfiguration sperowiderConfiguration,
                               String filename)
                        throws Exception

Delegates to instantiate(SperowiderConfiguration, String, String) with a null target, returning a SperowiderConfiguration suitable for use in Sperowider.Sperowider(SperowiderConfiguration).

Throws:

Exception

instantiate

public static void instantiate(SperowiderConfiguration sperowiderConfiguration,
                               String filename,
                               String target)
                        throws Exception

Returns a SperowiderConfiguration suitable for use in Sperowider.Sperowider(SperowiderConfiguration), using the named file, with the named target.

Throws:

Exception

instantiate

public static SperowiderConfiguration instantiate(SperowiderConfiguration sperowiderConfiguration,
                                                  Document configDoc)
                                           throws Exception

Delegates to instantiate(configDoc, null). This will create a SperowiderConfiguration based on the default target contained in the config document.

Throws:

Exception

instantiateLog4j

public static void instantiateLog4j(String filename)
                             throws FileNotFoundException

Sets up log4j with the given filename.

Throws:

FileNotFoundException

instantiateLog4j

public static void instantiateLog4j(InputStream inputStream)
                             throws IOException

Sets up log4j with a given InputStream.

Throws:

IOException

instantiate

public static void instantiate(SperowiderConfiguration sperowiderConfiguration,
                               Document configDoc,
                               String target)
                        throws Exception

This will create a SperowiderConfiguration based on the named target in the config document.

Throws:

Exception

initObject

public static Object initObject(Element configNode)

Given a configuration, will return an object that has had IInitializableObject.init(Element) called on it.