org.apache.hivemind.impl
Class XmlModuleDescriptorProvider

java.lang.Object
  org.apache.hivemind.impl.XmlModuleDescriptorProvider

All Implemented Interfaces:

ModuleDescriptorProvider

public class XmlModuleDescriptorProvider
extends java.lang.Object
implements ModuleDescriptorProvider

Implementation of the ModuleDescriptorProvider interface which uses the DescriptorParser to provide module descriptors defined in XML. The module descriptors are loaded from files or resources on the classpath.

Since:

1.1

Author:

Knut Wannheden

Field Summary

static java.lang.String

HIVE_MODULE_XML The default path, within a JAR or the classpath, to the XML HiveMind module deployment descriptor: META-INF/hivemodule.xml.

Constructor Summary

XmlModuleDescriptorProvider(ClassResolver resolver)
Convenience constructor.

XmlModuleDescriptorProvider(ClassResolver resolver, java.util.List resources)
Constructs an XmlModuleDescriptorProvider loading all ModuleDescriptor identified by the given List of Resource objects.

XmlModuleDescriptorProvider(ClassResolver resolver, Resource resource)
Constructs an XmlModuleDescriptorProvider only loading the ModuleDescriptor identified by the given Resource.

XmlModuleDescriptorProvider(ClassResolver resolver, java.lang.String resourcePath)
Loads all XML module descriptors found on the classpath (using the given ClassResolver.

Method Summary

java.util.List	getModuleDescriptors(ErrorHandler handler) Returns a List of module descriptors.
protected XmlResourceProcessor	getResourceProcessor(ClassResolver resolver, ErrorHandler handler)

Methods inherited from class java.lang.Object

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

Field Detail

HIVE_MODULE_XML

public static final java.lang.String HIVE_MODULE_XML

The default path, within a JAR or the classpath, to the XML HiveMind module deployment descriptor: META-INF/hivemodule.xml. Use this constant with the XmlModuleDescriptorProvider(ClassResolver, String) constructor.

See Also:

Constant Field Values

Constructor Detail

XmlModuleDescriptorProvider

public XmlModuleDescriptorProvider(ClassResolver resolver)

Convenience constructor. Equivalent to using XmlModuleDescriptorProvider(ClassResolver, String)with HIVE_MODULE_XML as the second argument.

XmlModuleDescriptorProvider

public XmlModuleDescriptorProvider(ClassResolver resolver,
                                   java.lang.String resourcePath)

Loads all XML module descriptors found on the classpath (using the given ClassResolver. Only module descriptors matching the specified path are loaded. Use the HIVE_MODULE_XML constant to load all descriptors in the default location.

XmlModuleDescriptorProvider

public XmlModuleDescriptorProvider(ClassResolver resolver,
                                   Resource resource)

Constructs an XmlModuleDescriptorProvider only loading the ModuleDescriptor identified by the given Resource.

XmlModuleDescriptorProvider

public XmlModuleDescriptorProvider(ClassResolver resolver,
                                   java.util.List resources)

Constructs an XmlModuleDescriptorProvider loading all ModuleDescriptor identified by the given List of Resource objects.

Method Detail

getModuleDescriptors

public java.util.List getModuleDescriptors(ErrorHandler handler)

Description copied from interface: ModuleDescriptorProvider

Returns a List of module descriptors. Any referenced submodules must also be included in this List.

Specified by:

getModuleDescriptors in interface ModuleDescriptorProvider

getResourceProcessor

protected XmlResourceProcessor getResourceProcessor(ClassResolver resolver,
                                                    ErrorHandler handler)