de.smartics.ci.config.load
Class HudsonJobConfigLoader

java.lang.Object
  de.smartics.ci.config.load.HudsonJobConfigLoader

public final class HudsonJobConfigLoader
     
     

      
      extends 
      
      Object
     
     

Loader of XML job configurations.

Constructor Summary

HudsonJobConfigLoader(LocationManager locationManager, HudsonJobConfigurationLoaderConfig loaderConfig)
Default constructor.

Method Summary

org.jdom.Document	load(LoaderPlan plan) Loads the XML document from the given loader plan.
HudsonJobConfig	loadHudsonConfig(LoaderPlan plan) Loads the XML document from the given loader plan.

Methods inherited from class java.lang.Object

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

Constructor Detail

HudsonJobConfigLoader

public HudsonJobConfigLoader(LocationManager locationManager,
                             HudsonJobConfigurationLoaderConfig loaderConfig)
                      throws de.smartics.util.lang.NullArgumentException

Default constructor.

Parameters:

locationManager - the location manager to load resources.

loaderConfig - the loader configuration to control the loading and creation of Hudson job configuration files.

Throws:

de.smartics.util.lang.NullArgumentException - if locationManager or loaderConfig is null.

Method Detail

loadHudsonConfig

public HudsonJobConfig loadHudsonConfig(LoaderPlan plan)
                                 throws de.smartics.util.lang.NullArgumentException,
                                        IllegalArgumentException,
                                        org.jdom.JDOMException

Loads the XML document from the given loader plan. The loader plan instructs the job config loader to load a number of Hudson job configuration files to merge their contents.

Parameters:

plan - the plan to load a number of job config files in a given order. Later config files override values previously loaded.

Returns:

the document containing the merged information from the job config files specified by the plan as an XML string.

Throws:

de.smartics.util.lang.NullArgumentException - if plan is null.

IllegalArgumentException - if plan is empty.

org.jdom.JDOMException - on any XML parsing or generation problem.

load

public org.jdom.Document load(LoaderPlan plan)
                       throws de.smartics.util.lang.NullArgumentException,
                              IllegalArgumentException,
                              org.jdom.JDOMException

Loads the XML document from the given loader plan. The loader plan instructs the job config loader to load a number of Hudson job configuration files to merge their contents.

Parameters:

plan - the plan to load a number of job config files in a given order. Later config files override values previously loaded.

Returns:

the document containing the merged information from the job config files specified by the plan as an XML string.

Throws:

de.smartics.util.lang.NullArgumentException - if plan is null.

IllegalArgumentException - if plan is empty.

org.jdom.JDOMException - on any XML parsing or generation problem.