Package org.apache.ofbiz.base.component

Class ComponentConfig

java.lang.Object

org.apache.ofbiz.base.component.ComponentConfig

public final class ComponentConfig
extends Object

An object that models the <ofbiz-component> element.

See Also:

• ofbiz-component.xsd

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ComponentConfig.Builder	Builder for component configuration.
static final class	ComponentConfig.ClasspathInfo	An object that models the <classpath> element.
static final class	ComponentConfig.EntityResourceInfo	An object that models the <entity-resource> element.
static final class	ComponentConfig.KeystoreInfo	An object that models the <keystore> element.
static class	ComponentConfig.ResourceInfo
static final class	ComponentConfig.ResourceLoaderInfo	An object that models the <resource-loader> element.
static final class	ComponentConfig.ServiceResourceInfo	An object that models the <service-resource> element.
static final class	ComponentConfig.TestSuiteInfo	An object that models the <test-suite> element.
static final class	ComponentConfig.WebappInfo	An object that models the <webapp> element.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OFBIZ_COMPONENT_XML_FILENAME

Method Summary

Modifier and Type	Method	Description
static Boolean	componentExists(String componentName)
static Stream<ComponentConfig>	components()
boolean	enabled()
static List<ComponentConfig.ClasspathInfo>	getAllClasspathInfos()	Provides the list of all the classpath information available in components.
static Collection<ComponentConfig>	getAllComponents()
static List<ContainerConfig.Configuration>	getAllConfigurations()	Provides the list of all the container configuration elements available in components.
static List<ComponentConfig.EntityResourceInfo>	getAllEntityResourceInfos(String type)
static List<ComponentConfig.EntityResourceInfo>	getAllEntityResourceInfos(String type, String name)	Provides the list of all the entity resource information matching a type.
static List<ComponentConfig.KeystoreInfo>	getAllKeystoreInfos()	Provides the list of all the keystore information available in components.
static List<ComponentConfig.ServiceResourceInfo>	getAllServiceResourceInfos(String type)	Provides the list of all the service resource information matching a type.
static List<ComponentConfig.TestSuiteInfo>	getAllTestSuiteInfos(String name)	Provides the list of all the test-suite information matching a component name.
static List<ComponentConfig.WebappInfo>	getAllWebappResourceInfos()	Provides the list of all the web-app information in components
List<ComponentConfig.ClasspathInfo>	getClasspathInfos()	Provides the list of class path information.
static ComponentConfig	getComponentConfig(String globalName)
static ComponentConfig	getComponentConfig(String globalName, String rootLocation)
String	getComponentName()
List<ContainerConfig.Configuration>	getConfigurations()
List<String>	getDependsOn()	Provides the list of dependent components.
String	getGlobalName()
static ComponentConfig.KeystoreInfo	getKeystoreInfo(String componentName, String keystoreName)	Provides the first key-store matching a name from a specific component.
Map<String,ComponentConfig.ResourceLoaderInfo>	getResourceLoaderInfos()
static String	getRootLocation(String componentName)
URL	getURL(String resourceLoaderName, String location)
static URL	getURL(String componentName, String resourceLoaderName, String location)
static ComponentConfig.WebappInfo	getWebAppInfo(String serverName, String contextRoot)
List<ComponentConfig.WebappInfo>	getWebappInfos()
boolean	isFileResource(ComponentConfig.ResourceInfo resourceInfo)
Path	rootLocation()	Provides the root location of the component definition.
static void	sortDependencies()	Sorts the cached component configurations.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

OFBIZ_COMPONENT_XML_FILENAME

public static final String OFBIZ_COMPONENT_XML_FILENAME

See Also:

• Constant Field Values

Method Details

componentExists

public static Boolean componentExists(String componentName)

getAllClasspathInfos

public static List<ComponentConfig.ClasspathInfo> getAllClasspathInfos()

Provides the list of all the classpath information available in components.

Returns:

a list of classpath information

getAllComponents

public static Collection<ComponentConfig> getAllComponents()

sortDependencies

public static void sortDependencies()
                             throws ComponentException

Sorts the cached component configurations.

Throws:

ComponentException - when a component configuration contains an invalid dependency or if the dependency graph contains a cycle.

components

public static Stream<ComponentConfig> components()

getAllConfigurations

public static List<ContainerConfig.Configuration> getAllConfigurations()

Provides the list of all the container configuration elements available in components.

Returns:

a list of container configuration elements

getAllEntityResourceInfos

public static List<ComponentConfig.EntityResourceInfo> getAllEntityResourceInfos(String type)

getAllEntityResourceInfos

public static List<ComponentConfig.EntityResourceInfo> getAllEntityResourceInfos(String type,
 String name)

Provides the list of all the entity resource information matching a type.

Parameters:

type - the service resource type to match

name - the name of the component to match

Returns:

a list of entity resource information

getAllKeystoreInfos

public static List<ComponentConfig.KeystoreInfo> getAllKeystoreInfos()

Provides the list of all the keystore information available in components.

Returns:

a list of keystore information

getAllServiceResourceInfos

public static List<ComponentConfig.ServiceResourceInfo> getAllServiceResourceInfos(String type)

Provides the list of all the service resource information matching a type.

Parameters:

type - the service resource type to match

Returns:

a list of service resource information

getAllTestSuiteInfos

public static List<ComponentConfig.TestSuiteInfo> getAllTestSuiteInfos(String name)

Provides the list of all the test-suite information matching a component name.

Parameters:

name - the name of the component to match where null means "any"

Returns:

a list of test-suite information

getAllWebappResourceInfos

public static List<ComponentConfig.WebappInfo> getAllWebappResourceInfos()

Provides the list of all the web-app information in components

Returns:

a list of web-app information

getComponentConfig

public static ComponentConfig getComponentConfig(String globalName)
                                          throws ComponentException

Throws:

ComponentException

getComponentConfig

public static ComponentConfig getComponentConfig(String globalName,
 String rootLocation)
                                          throws ComponentException

Throws:

ComponentException

getKeystoreInfo

public static ComponentConfig.KeystoreInfo getKeystoreInfo(String componentName,
 String keystoreName)

Provides the first key-store matching a name from a specific component.

Parameters:

componentName - the name of the component to match which can be null

keystoreName - the name of the key-store to match which can be null

Returns:

the first key-store matching both componentName and keystoreName.

getRootLocation

public static String getRootLocation(String componentName)
                              throws ComponentException

Throws:

ComponentException

getURL

public static URL getURL(String componentName,
 String resourceLoaderName,
 String location)
                  throws ComponentException

Throws:

ComponentException

getWebAppInfo

public static ComponentConfig.WebappInfo getWebAppInfo(String serverName,
 String contextRoot)

enabled

public boolean enabled()

getClasspathInfos

public List<ComponentConfig.ClasspathInfo> getClasspathInfos()

Provides the list of class path information.

Returns:

an immutable list containing the class path information.

getComponentName

public String getComponentName()

getConfigurations

public List<ContainerConfig.Configuration> getConfigurations()

getGlobalName

public String getGlobalName()

getDependsOn

public List<String> getDependsOn()

Provides the list of dependent components.

Returns:

an immutable list containing the dependency information.

getResourceLoaderInfos

public Map<String,ComponentConfig.ResourceLoaderInfo> getResourceLoaderInfos()

rootLocation

public Path rootLocation()

Provides the root location of the component definition.

Returns:

a normalized absolute path

getURL

public URL getURL(String resourceLoaderName,
 String location)
           throws ComponentException

Throws:

ComponentException

getWebappInfos

public List<ComponentConfig.WebappInfo> getWebappInfos()

isFileResource

public boolean isFileResource(ComponentConfig.ResourceInfo resourceInfo)
                       throws ComponentException

Throws:

ComponentException

toString

public String toString()

Overrides:

toString in class Object