org.objectweb.jonas_lib.genbase.archive.WebApp Class Reference

Inherits org.objectweb.jonas_lib.genbase.archive.J2EEArchive, org.objectweb.jonas_lib.genbase.archive.EjbRefModule, org.objectweb.jonas_lib.genbase.archive.WsClient, and org.objectweb.jonas_lib.genbase.archive.WsEndpoint.

Inherited by org.objectweb.jonas_lib.genbase.archive.DummyWebApp.

Inheritance diagram for org.objectweb.jonas_lib.genbase.archive.WebApp:

Inheritance graph
[legend]
Collaboration diagram for org.objectweb.jonas_lib.genbase.archive.WebApp:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 WebApp (Archive archive) throws GenBaseException
 WebApp (Archive archive, Application app) throws GenBaseException
String getName ()
void setApplication (Application app)
Application getApplication ()
List getServiceRefDescs ()
List getServiceDescs ()
void addClasses (File classes)
Document getWebAppDoc ()
Document getJonasWebAppDoc ()
Document getWebservicesDoc ()
Map getDescriptors ()
boolean omit (String name)
void initialize () throws GenBaseException
String getContextRoot ()
List getEjbRefDescs ()

Detailed Description

A WebApp is a wrapper class around a Web Archive.

Author:
Guillaume Sauthier

Definition at line 63 of file WebApp.java.


Constructor & Destructor Documentation

org.objectweb.jonas_lib.genbase.archive.WebApp.WebApp Archive  archive  )  throws GenBaseException
 

Create an alone WebApp (not in an ear).

Parameters:
archive file archive
Exceptions:
GenBaseException When Init fails

Definition at line 104 of file WebApp.java.

References org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getLogger().

Here is the call graph for this function:

org.objectweb.jonas_lib.genbase.archive.WebApp.WebApp Archive  archive,
Application  app
throws GenBaseException
 

Create an embded WebApp.

Parameters:
archive Web Archive
app container application
Exceptions:
GenBaseException When init fails

Definition at line 119 of file WebApp.java.

References org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getLogger(), and org.objectweb.jonas_lib.genbase.archive.WebApp.setApplication().

Here is the call graph for this function:


Member Function Documentation

void org.objectweb.jonas_lib.genbase.archive.WebApp.addClasses File  classes  ) 
 

Add Archive classes.

Parameters:
classes root directory containing classes.

Definition at line 241 of file WebApp.java.

References org.objectweb.jonas_lib.genbase.archive.J2EEArchive.addDirectoryIn().

Here is the call graph for this function:

Application org.objectweb.jonas_lib.genbase.archive.WebApp.getApplication  ) 
 

Returns the container application (can be null).

Returns:
the container application (can be null).

Definition at line 208 of file WebApp.java.

String org.objectweb.jonas_lib.genbase.archive.WebApp.getContextRoot  ) 
 

Returns:
Returns the context-root to use for this group of Services.

Implements org.objectweb.jonas_lib.genbase.archive.WsEndpoint.

Definition at line 414 of file WebApp.java.

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

Here is the call graph for this function:

Map org.objectweb.jonas_lib.genbase.archive.WebApp.getDescriptors  )  [virtual]
 

Returns a Map of name to Document for each modified Descriptor of the archive.

Returns:
a Map of name to Document

Implements org.objectweb.jonas_lib.genbase.archive.J2EEArchive.

Definition at line 335 of file WebApp.java.

List org.objectweb.jonas_lib.genbase.archive.WebApp.getEjbRefDescs  ) 
 

Returns the list of ejb-ref elements contained by a module.

Returns:
the list of ejb-ref elements contained by a module.

Implements org.objectweb.jonas_lib.genbase.archive.EjbRefModule.

Definition at line 422 of file WebApp.java.

Referenced by org.objectweb.jonas_lib.genclientstub.modifier.WebAppModifier.modify().

Document org.objectweb.jonas_lib.genbase.archive.WebApp.getJonasWebAppDoc  ) 
 

Returns the Document of the jonas-web.xml file.

Returns:
the Document of the jonas-web.xml file.

Definition at line 259 of file WebApp.java.

Referenced by org.objectweb.jonas_ws.wsgen.modifier.WebAppModifier.modify().

String org.objectweb.jonas_lib.genbase.archive.WebApp.getName  ) 
 

Returns the name of the Archive. Overrides J2EEArchive.getName();

See also:
org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getName()
Returns:
the name of the Archive.

Reimplemented from org.objectweb.jonas_lib.genbase.archive.J2EEArchive.

Reimplemented in org.objectweb.jonas_lib.genbase.archive.DummyWebApp.

Definition at line 190 of file WebApp.java.

Referenced by org.objectweb.jonas_lib.genbase.archive.Application.addWebApp(), org.objectweb.jonas_ws.wsgen.modifier.WebAppModifier.modify(), org.objectweb.jonas_lib.genclientstub.modifier.WebAppModifier.modify(), and org.objectweb.jonas_ws.wsgen.modifier.EjbJarModifier.modify().

List org.objectweb.jonas_lib.genbase.archive.WebApp.getServiceDescs  ) 
 

Returns the list of webservice-description elements contained by a module.

Returns:
the list of webservice-description elements contained by a module.

Implements org.objectweb.jonas_lib.genbase.archive.WsEndpoint.

Definition at line 228 of file WebApp.java.

References org.objectweb.jonas_ws.deployment.api.WSDeploymentDesc.getServiceDescs().

Referenced by org.objectweb.jonas_ws.wsgen.modifier.WebAppModifier.modify().

Here is the call graph for this function:

List org.objectweb.jonas_lib.genbase.archive.WebApp.getServiceRefDescs  ) 
 

Returns the list of service-ref elements contained by a module.

Returns:
the list of service-ref elements contained by a module.

Implements org.objectweb.jonas_lib.genbase.archive.WsClient.

Definition at line 217 of file WebApp.java.

Referenced by org.objectweb.jonas_ws.wsgen.modifier.WebAppModifier.modify().

Document org.objectweb.jonas_lib.genbase.archive.WebApp.getWebAppDoc  ) 
 

Returns the Document of the web.xml file.

Returns:
the Document of the web.xml file.

Definition at line 250 of file WebApp.java.

Referenced by org.objectweb.jonas_ws.wsgen.modifier.WebAppModifier.modify(), and org.objectweb.jonas_ws.wsgen.modifier.EjbJarModifier.modify().

Document org.objectweb.jonas_lib.genbase.archive.WebApp.getWebservicesDoc  ) 
 

Returns the Document of the webservices.xml file.

Returns:
the Document of the webservices.xml file.

Definition at line 268 of file WebApp.java.

Referenced by org.objectweb.jonas_ws.wsgen.modifier.WebAppModifier.modify().

void org.objectweb.jonas_lib.genbase.archive.WebApp.initialize  )  throws GenBaseException [virtual]
 

Initialize the Archive.

Exceptions:
GenBaseException When initialization fails.

Implements org.objectweb.jonas_lib.genbase.archive.J2EEArchive.

Definition at line 356 of file WebApp.java.

References org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getArchive(), org.objectweb.jonas_lib.genbase.archive.Application.getEJBClassLoader(), org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getI18n(), org.objectweb.jonas_lib.I18n.getMessage(), org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getModuleClassloader(), org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getRootFile(), org.objectweb.jonas_lib.genbase.archive.Archive.isPacked(), org.objectweb.jonas_lib.genbase.archive.J2EEArchive.setArchive(), and org.objectweb.jonas_lib.genbase.archive.J2EEArchive.setModuleClassloader().

Referenced by org.objectweb.jonas_lib.genbase.archive.Application.initialize().

Here is the call graph for this function:

boolean org.objectweb.jonas_lib.genbase.archive.WebApp.omit String  name  )  [virtual]
 

Returns true if filename must be omitted in the archive.

Parameters:
name filename to be tested
Returns:
true if filename must be omitted.

Implements org.objectweb.jonas_lib.genbase.archive.J2EEArchive.

Definition at line 346 of file WebApp.java.

void org.objectweb.jonas_lib.genbase.archive.WebApp.setApplication Application  app  ) 
 

Set the container application.

Parameters:
app the container application.

Definition at line 199 of file WebApp.java.

Referenced by org.objectweb.jonas_lib.genbase.archive.WebApp.WebApp().


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