Package org.apache.ofbiz.base.component

Class ComponentLoaderConfig

java.lang.Object

org.apache.ofbiz.base.component.ComponentLoaderConfig

public final class ComponentLoaderConfig
extends Object

This class is a MODULE for manipulating component loader files.

The component loader files are named component-load.xml and are present either in the classpath when defining the top-level component directories or inside those component directories when defining the loading order of the enabled simple components inside those directories. Simple components are directories containing a component configuration file named ofbiz-component.xml and mapped to a ComponentConfig object.

See Also:

• ComponentConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ComponentLoaderConfig.ComponentDef	Represents a simple component or a component directory.
static enum	ComponentLoaderConfig.ComponentType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_LOAD_XML_FILENAME

Method Summary

Modifier and Type	Method	Description
static List<ComponentLoaderConfig.ComponentDef>	getComponentsFromConfig(URL configUrl)	Collects the component definitions from a component-load.xml file
static List<ComponentLoaderConfig.ComponentDef>	getRootComponents()	Provides the list of root directory components defined in the classpath.

Methods inherited from class java.lang.Object

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

Field Details

COMPONENT_LOAD_XML_FILENAME

public static final String COMPONENT_LOAD_XML_FILENAME

See Also:

• Constant Field Values

Method Details

getRootComponents

public static List<ComponentLoaderConfig.ComponentDef> getRootComponents()
                                                                  throws ComponentException

Provides the list of root directory components defined in the classpath.

Returns:

the list of root directory components.

Throws:

ComponentException - if the main component-load.xml file is either invalid or refer to non-existent component directory.

getComponentsFromConfig

public static List<ComponentLoaderConfig.ComponentDef> getComponentsFromConfig(URL configUrl)
                                                                        throws ComponentException

Collects the component definitions from a component-load.xml file

Parameters:

configUrl - the location of the component-load.xml file

Returns:

a list of component definitions

Throws:

ComponentException - when the component-load.xml file is invalid.