org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc Class Reference

Collaboration diagram for org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc:

[legend]List of all members.

Public Member Functions
	WebContainerDeploymentDesc (String fileName, ClassLoader classLoader, WebApp webApp, JonasWebApp jonasWebApp) throws DeploymentDescException
String	getXmlContent ()
String	getJOnASXmlContent ()
void	setXmlContent (String xml)
void	setJOnASXmlContent (String jXml)
String	getContextRoot ()
boolean	getJava2DelegationModel ()
String	getHost ()
String	getPort ()
String	toString ()
Collection	getServletDescList ()
String[]	getServletsName ()
String	getServletClassname (String servName)
SecurityConstraintListDesc	getSecurityConstraintListDesc ()
List	getSecurityRoleList ()
List	getServletMappings (String servName)

---

Detailed Description

This class do the parsing of the web.xml file and jonas-web.xml files and contruct a data structure associated to these two files. 03/03 : Can read web.xml and jonas-web.xml if the url of the war is a directory.

Author:

Ludovic Bert

Florent Benoit

Philippe Coq

Definition at line 63 of file WebContainerDeploymentDesc.java.

---

Constructor & Destructor Documentation

org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.WebContainerDeploymentDesc (  String  fileName, ClassLoader  classLoader, WebApp  webApp, JonasWebApp  jonasWebApp )  throws DeploymentDescException

Construct an instance of a WebContainerDeploymentDesc. Constructor is private, call one of the static getInstance method instead. Parameters: fileName  the name of the warFile classLoader  the classloader for the classes. webApp  the data structure of the web-app (web.xml) jonasWebApp  the data structure of the jonas-web-app (jonas-web.xml) Exceptions: DeploymentDescException  if the deployment descriptors are corrupted. Definition at line 130 of file WebContainerDeploymentDesc.java. References org.objectweb.jonas_web.deployment.xml.ServletMapping.getServletName(), org.objectweb.jonas_web.deployment.xml.Servlet.getServletName(), and org.objectweb.jonas_web.deployment.xml.ServletMapping.getUrlPattern().

Here is the call graph for this function:

---

Member Function Documentation

String org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getContextRoot (   )

Get the context root of this web application. Returns: the context root of this web application. Definition at line 282 of file WebContainerDeploymentDesc.java. Referenced by org.objectweb.jonas_lib.genbase.archive.WebApp.getContextRoot(), org.objectweb.jonas.adm.Adm.listModules(), and org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.toString().

String org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getHost (   )

Get the host on which the web application must be deployed. Returns: the host on which the web application must be deployed. Definition at line 298 of file WebContainerDeploymentDesc.java. Referenced by org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.toString().

boolean org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getJava2DelegationModel (   )

Context classloader must follow the java2 delegation model ? Returns: true if the context's classloader must follow the java 2 delegation model. Definition at line 290 of file WebContainerDeploymentDesc.java.

String org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getJOnASXmlContent (   )

Return the content of the jonas-web.xml file Returns: the content of the jonas-web.xml file Definition at line 257 of file WebContainerDeploymentDesc.java.

String org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getPort (   )

Get the prefered port of the connector used to access the web application. Returns: the prefered port of the connector used to access the web application. Definition at line 306 of file WebContainerDeploymentDesc.java.

SecurityConstraintListDesc org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getSecurityConstraintListDesc (   )

Gets the constraint list Returns: the constraint list Definition at line 408 of file WebContainerDeploymentDesc.java. Referenced by org.objectweb.jonas.web.lib.PermissionManager.translateSecurityConstraintElements().

List org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getSecurityRoleList (   )

Gets the list of security roles Returns: the list of security roles Definition at line 416 of file WebContainerDeploymentDesc.java. Referenced by org.objectweb.jonas.web.lib.PermissionManager.translateServletSecurityRoleRef().

String org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getServletClassname (  String  servName  )

Return the classname of the given servlet Parameters: servName  name of the given servlet Returns: the classname of the given servlet Definition at line 400 of file WebContainerDeploymentDesc.java. Referenced by org.objectweb.jonas_ws.deployment.api.JaxRpcPortComponentDesc.setWebDesc().

Collection org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getServletDescList (   )

Gets the list of Servlets Returns: list of Servlets Definition at line 382 of file WebContainerDeploymentDesc.java. Referenced by org.objectweb.jonas.web.lib.PermissionManager.translateServletSecurityRoleRef().

List org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getServletMappings (  String  servName  )

Return the list of urlMapping of the given servlet Parameters: servName  name of the given servlet Returns: the list of urlMapping of the given servlet Definition at line 425 of file WebContainerDeploymentDesc.java.

String [] org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getServletsName (   )

Return a list of all servlets name available Returns: a list of all servlets name available Definition at line 390 of file WebContainerDeploymentDesc.java.

String org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getXmlContent (   )

Return the content of the web.xml file Returns: the content of the web.xml file Definition at line 249 of file WebContainerDeploymentDesc.java.

void org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.setJOnASXmlContent (  String  jXml  )

Set the content of the jonas-web.xml file Parameters: jXml  the content of the file Definition at line 273 of file WebContainerDeploymentDesc.java. Referenced by org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance().

void org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.setXmlContent (  String  xml  )

Set the content of the web.xml file Parameters: xml  the content of the file Definition at line 265 of file WebContainerDeploymentDesc.java. Referenced by org.objectweb.jonas_web.deployment.lib.WebDeploymentDescManager.getInstance().

String org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.toString (   )

Return a String representation of the WebContainerDeploymentDesc. Returns: a String representation of the WebContainerDeploymentDesc. Definition at line 314 of file WebContainerDeploymentDesc.java. References org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getContextRoot(), and org.objectweb.jonas_web.deployment.api.WebContainerDeploymentDesc.getHost(). Referenced by org.objectweb.jonas_ws.deployment.api.JaxRpcPortComponentDesc.toString().

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• src/org/objectweb/jonas_web/deployment/api/WebContainerDeploymentDesc.java

---