Main Page | Packages | Class Hierarchy | Class List | File List | Class Members | Related Pages | Search for 

org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager Class Reference

Collaboration diagram for org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager:

Collaboration graph
[legend]
List of all members.

Public Member Functions

WebContainerDeploymentDesc getDeploymentDesc (URL url, ClassLoader loaderForCls, ClassLoader earLoader) throws DeploymentDescException
void removeCache (ClassLoader earClassLoader)
void setAltDD (ClassLoader earClassLoader, URL[] urls, URL[] altDDs)
int getCacheSize ()

Static Public Member Functions

WebDeploymentDescManager getInstance ()
WebContainerDeploymentDesc getDeploymentDesc (String filename, ClassLoader loader) throws WebContainerDeploymentDescException
WebContainerDeploymentDesc getInstance (String warFileName, ClassLoader classLoaderForCls, String altWebXmlFilename) throws DeploymentDescException
WebContainerDeploymentDesc getInstance (String warFileName, ClassLoader classLoaderForCls) throws DeploymentDescException
WebApp loadWebApp (Reader reader, String fileName) throws DeploymentDescException
JonasWebApp loadJonasWebApp (Reader reader, String fileName) throws DeploymentDescException
boolean getParsingWithValidation ()
void setParsingWithValidation (boolean validation)

Static Public Attributes

final String WEB_FILE_NAME = "WEB-INF/web.xml"
final String JONAS_WEB_FILE_NAME = "WEB-INF/jonas-web.xml"

Detailed Description

This class provide a way for managing the WebContainerDeploymentDesc. Note that there is an intance of the WebDeploymentDescManager on each JOnAS server.
Author:
Ludovic Bert

Florent Benoit

Definition at line 80 of file WebDeploymentDescManager.java.

Member Function Documentation

int org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getCacheSize (   ) 
 

Get the size of the cache (number of entries in the cache). This method is used only for the tests.

Returns:
the size of the cache (number of entries in the cache).

Definition at line 481 of file WebDeploymentDescManager.java.

WebContainerDeploymentDesc org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getDeploymentDesc (  String  filename,
ClassLoader  loader
)  throws WebContainerDeploymentDescException [static]
 

Get the specified web deployment descriptor.

Parameters:
filename the filename where to load xml deployment descriptors.
loader classloader used to load web classes.
Returns:
WebContainerDeploymentDesc the web deployment descriptor.
Exceptions:
WebContainerDeploymentDescException when WebContainerDeploymentDesc cannot be created with the given files.

Definition at line 503 of file WebDeploymentDescManager.java.

References org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance().

Here is the call graph for this function:

WebContainerDeploymentDesc org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getDeploymentDesc (  URL  url,
ClassLoader  loaderForCls,
ClassLoader  earLoader
)  throws DeploymentDescException
 

Get the specified web deployment descriptor.

Parameters:
url the url where to load xml deployment descriptors.
loaderForCls classloader used to load web classes.
earLoader the ear classloader.
Returns:
WebContainerDeploymentDesc the web deployment descriptor.
Exceptions:
DeploymentDescException when WebContainerDeploymentDesc cannot be created with the given files.

Definition at line 174 of file WebDeploymentDescManager.java.

References org.objectweb.jonas_lib.deployment.api.EjbLocalRefDesc.getEjbLink(), org.objectweb.jonas_lib.deployment.api.EjbRefDesc.getEjbLink(), org.objectweb.jonas_lib.deployment.api.EjbLocalRefDesc.getEjbRefType(), org.objectweb.jonas_lib.deployment.api.EjbRefDesc.getEjbRefType(), org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance(), org.objectweb.jonas_ws.deployment.lib.WSDeploymentDescManager.getInstance(), org.objectweb.jonas_lib.deployment.api.MessageDestinationRefDesc.getJndiName(), org.objectweb.jonas_lib.deployment.api.EjbRefDesc.getJndiName(), org.objectweb.jonas_lib.deployment.api.MessageDestinationRefDesc.getMessageDestinationLink(), org.objectweb.jonas_lib.deployment.api.MessageDestinationRefDesc.getMessageDestinationType(), org.objectweb.jonas_lib.deployment.api.MessageDestinationRefDesc.getMessageDestinationUsage(), org.objectweb.jonas_ws.deployment.api.PortComponentRefDesc.getPortComponentLink(), org.objectweb.jonas_ws.deployment.api.ServiceRefDesc.getPortComponentRefs(), org.objectweb.jonas_lib.deployment.api.EjbLocalRefDesc.setJndiLocalName(), org.objectweb.jonas_lib.deployment.api.MessageDestinationRefDesc.setJndiName(), org.objectweb.jonas_lib.deployment.api.EjbRefDesc.setJndiName(), and org.objectweb.jonas_ws.deployment.api.PortComponentRefDesc.setPortComponentDesc().

Here is the call graph for this function:

WebContainerDeploymentDesc org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance (  String  warFileName,
ClassLoader  classLoaderForCls
)  throws DeploymentDescException [static]
 

Get an instance of a WEB deployment descriptor by parsing the web.xml and jonas-web.xml deployment descriptors.

Parameters:
warFileName the fileName of the war file for the deployment descriptors.
classLoaderForCls the classloader for the classes.
Returns:
a WEB deployment descriptor by parsing the web.xml and jonas-web.xml deployment descriptors.
Exceptions:
DeploymentDescException if the deployment descriptors are corrupted.

Definition at line 711 of file WebDeploymentDescManager.java.

References org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance().

Here is the call graph for this function:

WebContainerDeploymentDesc org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance (  String  warFileName,
ClassLoader  classLoaderForCls,
String  altWebXmlFilename
)  throws DeploymentDescException [static]
 

Get an instance of a WEB deployment descriptor by parsing the web.xml and jonas-web.xml deployment descriptors.

Parameters:
warFileName the fileName of the war file for the deployment descriptors.
classLoaderForCls the classloader for the classes.
altWebXmlFilename the fileName to the web.xml for the alt-dd tag in the Ear Case. This is used for specify an alternate DDesc file.
Returns:
a WEB deployment descriptor by parsing the web.xml and jonas-web.xml deployment descriptors.
Exceptions:
DeploymentDescException if the deployment descriptors are corrupted.

Definition at line 543 of file WebDeploymentDescManager.java.

References org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.JONAS_WEB_FILE_NAME, org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.loadJonasWebApp(), org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.loadWebApp(), org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.setJOnASXmlContent(), org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.setXmlContent(), and org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.WEB_FILE_NAME.

Here is the call graph for this function:

WebDeploymentDescManager org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance (   )  [static]
 

Get an instance of the WebDeploymentDescManager.

Returns:
the instance of the WebDeploymentDescManager.

Definition at line 158 of file WebDeploymentDescManager.java.

Referenced by org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getDeploymentDesc(), and org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance().

boolean org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getParsingWithValidation (   )  [static]
 

Controls whether the parser is reporting all validity errors.

Returns:
if true, all external entities will be read.

Definition at line 777 of file WebDeploymentDescManager.java.

Referenced by org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.loadJonasWebApp(), and org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.loadWebApp().

JonasWebApp org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.loadJonasWebApp (  Reader  reader,
String  fileName
)  throws DeploymentDescException [static]
 

Load the jonas-web.xml file.

Parameters:
reader the Reader of the XML file.
fileName the name of the file (jonas-web.xml).
Returns:
a structure containing the result of the jonas-web.xml parsing.
Exceptions:
DeploymentDescException if the deployment descriptor is corrupted.

Definition at line 753 of file WebDeploymentDescManager.java.

References org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getParsingWithValidation(), and org.objectweb.jonas_lib.deployment.digester.JDigester.parse().

Referenced by org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance().

Here is the call graph for this function:

WebApp org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.loadWebApp (  Reader  reader,
String  fileName
)  throws DeploymentDescException [static]
 

Load the web.xml file.

Parameters:
reader the reader of the XML file.
fileName the name of the file (web.xml).
Returns:
a structure containing the result of the web.xml parsing.
Exceptions:
DeploymentDescException if the deployment descriptor is corrupted.

Definition at line 725 of file WebDeploymentDescManager.java.

References org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getParsingWithValidation(), and org.objectweb.jonas_lib.deployment.digester.JDigester.parse().

Referenced by org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance().

Here is the call graph for this function:

void org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.removeCache (  ClassLoader  earClassLoader  ) 
 

Make a cleanup of the cache of deployment descriptor. This method must be invoked after the ear deployment by the EAR service.

Parameters:
earClassLoader the ClassLoader of the ear application to remove from the cache.

Definition at line 441 of file WebDeploymentDescManager.java.

References org.objectweb.jonas_ejb.deployment.lib.EjbDeploymentDescManager.removeCache().

Here is the call graph for this function:

void org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.setAltDD (  ClassLoader  earClassLoader,
URL[]  urls,
URL[]  altDDs
) 
 

Set the alt deployment desc which are used instead of the web.xml file which is in the war file. The alt-dd tag is in the application.xml file of the ear files and is used ony in the EAR case. ie : deployment of wars packaged into EAR applications. alt-dd tag is optionnal

Parameters:
earClassLoader the ear classloader which is used for mapped the URLs of the wars to the Alt dd.
urls the urls of the wars
altDDs the alt-dd name for the specified war URLs

Definition at line 459 of file WebDeploymentDescManager.java.

void org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.setParsingWithValidation (  boolean  validation  )  [static]
 

Controls whether the parser is reporting all validity errors.

Parameters:
validation if true, all external entities will be read.

Definition at line 785 of file WebDeploymentDescManager.java.

Member Data Documentation

final String org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.JONAS_WEB_FILE_NAME = "WEB-INF/jonas-web.xml" [static]
 

The path to the jonas-web.xml file.

Definition at line 90 of file WebDeploymentDescManager.java.

Referenced by org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance().

final String org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.WEB_FILE_NAME = "WEB-INF/web.xml" [static]
 

The path to the web.xml file.

Definition at line 85 of file WebDeploymentDescManager.java.

Referenced by org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance().

The documentation for this class was generated from the following file:
Generated on Tue Feb 15 15:13:30 2005 for JOnAS by  doxygen 1.3.9.1