org.jboss.metadata
Class XmlFileLoader

java.lang.Object
  org.jboss.metadata.XmlFileLoader

public class XmlFileLoader

extends Object

XmlFileLoader class is used to read ejb-jar.xml, standardjboss.xml, jboss.xml files, process them using DTDs and create ApplicationMetaData object for future use. It also provides the local entity resolver for the JBoss specific DTDs.

Version:

$Revision: 1.28.4.8 $

Author:

Bill Burke, Sebastien Alborini, Wolfgang Werner, Darius Davidavicius, Scott Stark

Constructor Summary

XmlFileLoader()

XmlFileLoader(boolean validateDTDs)

Method Summary

ClassLoader	getClassLoader() Gets the class loader
static boolean	getDefaultValidateDTDs()
Document	getDocument(InputSource is, String inPath) Parses the xml document in is to create a DOM Document.
Document	getDocument(InputStream is, String inPath) Parses the xml document in is to create a DOM Document.
static Document	getDocument(URL url) Invokes getDocument(url, defaultValidateDTDs)
static Document	getDocument(URL url, boolean validateDTDs) Get the xml file from the URL and parse it into a Document object.
Document	getDocumentFromURL(URL url) Get the xml file from the URL and parse it into a Document object.
ApplicationMetaData	getMetaData()
boolean	getValidateDTDs() Get the flag indicating that ejb-jar.dtd, jboss.dtd & jboss-web.dtd conforming documents should be validated against the DTD.
ApplicationMetaData	load() load() This method creates the ApplicationMetaData.
void	setClassLoader(ClassLoader cl) Set the class loader
static void	setDefaultValidateDTDs(boolean validate)
void	setValidateDTDs(boolean validate) Set the flag indicating that ejb-jar.dtd, jboss.dtd & jboss-web.dtd conforming documents should be validated against the DTD.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlFileLoader

public XmlFileLoader()

XmlFileLoader

public XmlFileLoader(boolean validateDTDs)

Method Detail

getDefaultValidateDTDs

public static boolean getDefaultValidateDTDs()

setDefaultValidateDTDs

public static void setDefaultValidateDTDs(boolean validate)

getMetaData

public ApplicationMetaData getMetaData()

setClassLoader

public void setClassLoader(ClassLoader cl)

Set the class loader

getClassLoader

public ClassLoader getClassLoader()

Gets the class loader

Returns:

ClassLoader - the class loader

getValidateDTDs

public boolean getValidateDTDs()

Get the flag indicating that ejb-jar.dtd, jboss.dtd & jboss-web.dtd conforming documents should be validated against the DTD.

setValidateDTDs

public void setValidateDTDs(boolean validate)

Set the flag indicating that ejb-jar.dtd, jboss.dtd & jboss-web.dtd conforming documents should be validated against the DTD.

load

public ApplicationMetaData load()
                         throws Exception

load() This method creates the ApplicationMetaData. The configuration files are found in the classLoader. The default jboss.xml and jaws.xml files are always read first, then we override the defaults if the user provides them

Throws:

Exception

getDocument

public static Document getDocument(URL url)
                            throws org.jboss.deployment.DeploymentException

Invokes getDocument(url, defaultValidateDTDs)

Throws:

org.jboss.deployment.DeploymentException

getDocument

public static Document getDocument(URL url,
                                   boolean validateDTDs)
                            throws org.jboss.deployment.DeploymentException

Get the xml file from the URL and parse it into a Document object. Calls new XmlFileLoader(validateDTDs).getDocumentFromURL(url);

Returns:

Document

Throws:

org.jboss.deployment.DeploymentException

getDocumentFromURL

public Document getDocumentFromURL(URL url)
                            throws org.jboss.deployment.DeploymentException

Get the xml file from the URL and parse it into a Document object. Calls getDocument(new InputSource(url.openStream()), url.getPath()) with the InputSource.SystemId set to url.toExternalForm().

Returns:

Document

Throws:

org.jboss.deployment.DeploymentException

getDocument

public Document getDocument(InputStream is,
                            String inPath)
                     throws org.jboss.deployment.DeploymentException

Parses the xml document in is to create a DOM Document. DTD validation is enabled if validateDTDs is true and we install an EntityResolver and ErrorHandler to resolve J2EE DTDs and handle errors. We also create an InputSource for the InputStream and set the SystemId URI to the inPath value. This allows relative entity references to be resolved against the inPath URI. The is argument will be closed.

Returns:

Document

Throws:

org.jboss.deployment.DeploymentException

getDocument

public Document getDocument(InputSource is,
                            String inPath)
                     throws org.jboss.deployment.DeploymentException

Parses the xml document in is to create a DOM Document. DTD validation is enabled if validateDTDs is true and we install an EntityResolver and ErrorHandler to resolve J2EE DTDs and handle errors. We also create an InputSource for the InputStream and set the SystemId URI to the inPath value. This allows relative entity references to be resolved against the inPath URI.

Returns:

Document

Throws:

org.jboss.deployment.DeploymentException