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

Inherits org.objectweb.jonas_lib.genbase.archive.Archive.

Inherited by org.objectweb.jonas_lib.genbase.archive.Application, org.objectweb.jonas_lib.genbase.archive.Client, org.objectweb.jonas_lib.genbase.archive.EjbJar, and org.objectweb.jonas_lib.genbase.archive.WebApp.

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

[legend]Collaboration diagram for org.objectweb.jonas_lib.genbase.archive.J2EEArchive:

[legend]List of all members.

Public Member Functions
	J2EEArchive (Archive archive)
void	addDirectory (File directory)
void	addDirectoryIn (String dirName, File directory)
void	addFile (File file)
void	addFile (File file, String name)
void	addFileIn (String dirName, File file)
File	getRootFile ()
Manifest	getManifest ()
InputStream	getInputStream (String filename) throws IOException
List	getContainedFiles ()
boolean	isPacked ()
String	getName ()
abstract Map	getDescriptors ()
abstract boolean	omit (String name)
Archive	getArchive ()
void	setArchive (Archive archive)
abstract void	initialize () throws GenBaseException
ClassLoader	getModuleClassloader ()
void	setModuleClassloader (ClassLoader moduleClassloader)
Static Public Member Functions
I18n	getI18n ()
Logger	getLogger ()
Protected Member Functions
boolean	isDTDsAllowed ()

---

Detailed Description

Base Class for all J2EE modules (application, ejbjar, client, webapp).

Author:

Guillaume Sauthier

See also:

org.objectweb.jonas_lib.genbase.archive.Archive

Definition at line 52 of file J2EEArchive.java.

---

Constructor & Destructor Documentation

org.objectweb.jonas_lib.genbase.archive.J2EEArchive.J2EEArchive (  Archive  archive  )

Creates a new J2EEArchive object. Parameters: archive  Archive containing files Definition at line 70 of file J2EEArchive.java.

---

Member Function Documentation

void org.objectweb.jonas_lib.genbase.archive.J2EEArchive.addDirectory (  File  directory  )

add the content of the given directory into the root of the archive. Parameters: directory  directory to add Implements org.objectweb.jonas_lib.genbase.archive.Archive. Definition at line 79 of file J2EEArchive.java. References org.objectweb.jonas_lib.genbase.archive.Archive.addDirectory(). Referenced by org.objectweb.jonas_lib.genbase.archive.Client.addClasses(), and org.objectweb.jonas_lib.genbase.archive.EjbJar.addClasses().

Here is the call graph for this function:

void org.objectweb.jonas_lib.genbase.archive.J2EEArchive.addDirectoryIn (  String  dirName, File  directory )

add the content of the given directory into the given directory of the archive. Parameters: dirName  archive directory name. directory  directory to add. Implements org.objectweb.jonas_lib.genbase.archive.Archive. Definition at line 90 of file J2EEArchive.java. References org.objectweb.jonas_lib.genbase.archive.Archive.addDirectoryIn(). Referenced by org.objectweb.jonas_lib.genbase.archive.WebApp.addClasses(), and org.objectweb.jonas_ws.wsgen.generator.ews.EWSWsEndpointGenerator.addFiles().

Here is the call graph for this function:

void org.objectweb.jonas_lib.genbase.archive.J2EEArchive.addFile (  File  file, String  name )

add a file into the root directory of the archive with a specified name. Parameters: file  the file to be added. name  filename Implements org.objectweb.jonas_lib.genbase.archive.Archive. Definition at line 109 of file J2EEArchive.java. References org.objectweb.jonas_lib.genbase.archive.Archive.addFile().

Here is the call graph for this function:

void org.objectweb.jonas_lib.genbase.archive.J2EEArchive.addFile (  File  file  )

add a lonely file into the root directory of the archive. Parameters: file  the file to be added. Implements org.objectweb.jonas_lib.genbase.archive.Archive. Definition at line 99 of file J2EEArchive.java. References org.objectweb.jonas_lib.genbase.archive.Archive.addFile(). Referenced by org.objectweb.jonas_lib.genbase.archive.Application.addWebApp(), and org.objectweb.jonas_lib.genbase.modifier.AbsApplicationModifier.modify().

Here is the call graph for this function:

void org.objectweb.jonas_lib.genbase.archive.J2EEArchive.addFileIn (  String  dirName, File  file )

add a lonely file into the given directory of the archive. Parameters: dirName  archive directory name. file  the file to be added. Implements org.objectweb.jonas_lib.genbase.archive.Archive. Definition at line 119 of file J2EEArchive.java. References org.objectweb.jonas_lib.genbase.archive.Archive.addFileIn(). Referenced by org.objectweb.jonas_ws.wsgen.generator.ews.EWSWsEndpointGenerator.addFiles(), and org.objectweb.jonas_ws.wsgen.generator.axis.AxisWsEndpointGenerator.addFiles().

Here is the call graph for this function:

Archive org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getArchive (   )

Returns: Returns the archive. Definition at line 215 of file J2EEArchive.java. Referenced by org.objectweb.jonas_lib.genbase.archive.Application.init(), org.objectweb.jonas_lib.genbase.archive.WebApp.initialize(), org.objectweb.jonas_lib.genbase.archive.Client.initialize(), and org.objectweb.jonas_lib.genbase.archive.EjbJar.initialize().

List org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getContainedFiles (   )

Returns a List of all files contained in this archive. Original files in jar, added Files are all included as String in this Enumeration. Returns: a List of all files contained in this archive. Implements org.objectweb.jonas_lib.genbase.archive.Archive. Definition at line 161 of file J2EEArchive.java. References org.objectweb.jonas_lib.genbase.archive.Archive.getContainedFiles(). Referenced by org.objectweb.jonas_lib.genbase.utils.ArchiveStorer.store().

Here is the call graph for this function:

abstract Map org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getDescriptors (   )  [pure virtual]

Returns a Map of name to Document for each modified Descriptor of the archive. Returns: a Map of name to Document Implemented in org.objectweb.jonas_lib.genbase.archive.Application, org.objectweb.jonas_lib.genbase.archive.Client, org.objectweb.jonas_lib.genbase.archive.EjbJar, and org.objectweb.jonas_lib.genbase.archive.WebApp. Referenced by org.objectweb.jonas_lib.genbase.utils.ArchiveStorer.store().

I18n org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getI18n (   )  [static]

Returns: Returns the i18n. Definition at line 203 of file J2EEArchive.java. Referenced by org.objectweb.jonas_lib.genbase.archive.Application.init(), org.objectweb.jonas_lib.genbase.archive.WebApp.initialize(), org.objectweb.jonas_lib.genbase.archive.Client.initialize(), org.objectweb.jonas_lib.genbase.archive.EjbJar.initialize(), and org.objectweb.jonas_lib.genbase.archive.Application.loadDescriptors().

InputStream org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getInputStream (  String  filename  )  throws IOException

Returns an InputStream corresponding to the given filename. Parameters: filename  file name source of the InputStream Returns: the InputStream corresponding to the given filename. Exceptions: IOException  When Cannot get InputStream from filename Implements org.objectweb.jonas_lib.genbase.archive.Archive. Definition at line 150 of file J2EEArchive.java. References org.objectweb.jonas_lib.genbase.archive.Archive.getInputStream(). Referenced by org.objectweb.jonas_lib.genbase.utils.JarStorer.addFile(), org.objectweb.jonas_lib.genbase.utils.DirStorer.addFile(), org.objectweb.jonas_lib.genbase.archive.Application.getApplicationInputStream(), org.objectweb.jonas_lib.genbase.archive.Client.getJonasClientInputStream(), and org.objectweb.jonas_lib.genbase.archive.EjbJar.getJonasEjbJarInputStream().

Here is the call graph for this function:

Logger org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getLogger (   )  [static]

Returns: Returns the logger. Definition at line 209 of file J2EEArchive.java. Referenced by org.objectweb.jonas_lib.genbase.archive.Application.Application(), org.objectweb.jonas_lib.genbase.archive.Client.Client(), org.objectweb.jonas_lib.genbase.archive.EjbJar.EjbJar(), org.objectweb.jonas_lib.genbase.archive.EjbJar.getContextRoot(), and org.objectweb.jonas_lib.genbase.archive.WebApp.WebApp().

Manifest org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getManifest (   )

Returns the Manifest of the Archive. Returns: the Manifest of the Archive. Implements org.objectweb.jonas_lib.genbase.archive.Archive. Definition at line 137 of file J2EEArchive.java. References org.objectweb.jonas_lib.genbase.archive.Archive.getManifest().

Here is the call graph for this function:

ClassLoader org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getModuleClassloader (   )

Returns: Returns the module inner ClassLoader Definition at line 234 of file J2EEArchive.java. Referenced by org.objectweb.jonas_ws.wsgen.generator.ews.EWSWsEndpointGenerator.generate(), org.objectweb.jonas_ws.wsgen.generator.ews.EWSWsClientGenerator.generate(), org.objectweb.jonas_ws.wsgen.generator.axis.AxisWsClientGenerator.generate(), org.objectweb.jonas_lib.genclientstub.generator.Generator.generate(), org.objectweb.jonas_lib.genbase.archive.WebApp.initialize(), org.objectweb.jonas_lib.genbase.archive.Client.initialize(), and org.objectweb.jonas_lib.genbase.archive.EjbJar.initialize().

String org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getName (   )

Returns the name of the Archive. Returns: the name of the Archive. Implements org.objectweb.jonas_lib.genbase.archive.Archive. Reimplemented in org.objectweb.jonas_lib.genbase.archive.Application, org.objectweb.jonas_lib.genbase.archive.DummyApplication, org.objectweb.jonas_lib.genbase.archive.DummyWebApp, and org.objectweb.jonas_lib.genbase.archive.WebApp. Definition at line 179 of file J2EEArchive.java. References org.objectweb.jonas_lib.genbase.archive.Archive.getName(). Referenced by org.objectweb.jonas_ws.wsgen.modifier.EjbJarModifier.modify(), org.objectweb.jonas_lib.genclientstub.modifier.EjbJarModifier.modify(), org.objectweb.jonas_ws.wsgen.modifier.ClientModifier.modify(), and org.objectweb.jonas_lib.genclientstub.modifier.ClientModifier.modify().

Here is the call graph for this function:

File org.objectweb.jonas_lib.genbase.archive.J2EEArchive.getRootFile (   )

Returns the File corresponding to the root of the archive. Returns: the File corresponding to the root of the archive. Implements org.objectweb.jonas_lib.genbase.archive.Archive. Definition at line 128 of file J2EEArchive.java. References org.objectweb.jonas_lib.genbase.archive.Archive.getRootFile(). Referenced by org.objectweb.jonas_lib.genbase.archive.Application.addWebApp(), org.objectweb.jonas_lib.genbase.archive.Application.init(), org.objectweb.jonas_lib.genbase.archive.WebApp.initialize(), org.objectweb.jonas_lib.genbase.archive.Client.initialize(), org.objectweb.jonas_lib.genbase.archive.EjbJar.initialize(), org.objectweb.jonas_ws.wsgen.modifier.EjbJarModifier.modify(), org.objectweb.jonas_lib.genclientstub.modifier.EjbJarModifier.modify(), org.objectweb.jonas_ws.wsgen.modifier.ClientModifier.modify(), and org.objectweb.jonas_lib.genclientstub.modifier.ClientModifier.modify().

Here is the call graph for this function:

abstract void org.objectweb.jonas_lib.genbase.archive.J2EEArchive.initialize (   )  throws GenBaseException [pure virtual]

Initialize the Archive. Exceptions: GenBaseException  When initialization fails. Implemented in org.objectweb.jonas_lib.genbase.archive.Application, org.objectweb.jonas_lib.genbase.archive.Client, org.objectweb.jonas_lib.genbase.archive.EjbJar, and org.objectweb.jonas_lib.genbase.archive.WebApp. Referenced by org.objectweb.jonas_ws.wsgen.modifier.ModifierFactory.getModifier(), and org.objectweb.jonas_lib.genclientstub.modifier.ModifierFactory.getModifier().

boolean org.objectweb.jonas_lib.genbase.archive.J2EEArchive.isDTDsAllowed (   )  [protected]

Returns: true if the use of DTDs is allowed or if we have to use only web services Definition at line 248 of file J2EEArchive.java. References org.objectweb.jonas_lib.genbase.generator.GeneratorFactory.getConfiguration(), org.objectweb.jonas_lib.I18n.getMessage(), and org.objectweb.jonas_lib.genbase.generator.Config.isDTDsAllowed(). Referenced by org.objectweb.jonas_lib.genbase.archive.Application.loadDescriptors().

Here is the call graph for this function:

boolean org.objectweb.jonas_lib.genbase.archive.J2EEArchive.isPacked (   )

Returns true if archive is packed or false if archive is unpacked. Returns: true if archive is packed or false if archive is unpacked. Implements org.objectweb.jonas_lib.genbase.archive.Archive. Definition at line 170 of file J2EEArchive.java. References org.objectweb.jonas_lib.genbase.archive.Archive.isPacked(). Referenced by org.objectweb.jonas_lib.genbase.archive.Application.getApplicationInputStream(), org.objectweb.jonas_lib.genbase.archive.Client.getJonasClientInputStream(), org.objectweb.jonas_lib.genbase.archive.EjbJar.getJonasEjbJarInputStream(), and org.objectweb.jonas_lib.genbase.archive.Application.init().

Here is the call graph for this function:

abstract boolean org.objectweb.jonas_lib.genbase.archive.J2EEArchive.omit (  String  name  )  [pure virtual]

Returns true if filename must be omitted in the archive. Parameters: name  filename to be tested Returns: true if filename must be omitted. Implemented in org.objectweb.jonas_lib.genbase.archive.Application, org.objectweb.jonas_lib.genbase.archive.Client, org.objectweb.jonas_lib.genbase.archive.EjbJar, and org.objectweb.jonas_lib.genbase.archive.WebApp. Referenced by org.objectweb.jonas_lib.genbase.utils.ArchiveStorer.store().

void org.objectweb.jonas_lib.genbase.archive.J2EEArchive.setArchive (  Archive  archive  )

Parameters: archive  The archive to set. Definition at line 221 of file J2EEArchive.java. Referenced by org.objectweb.jonas_lib.genbase.archive.Application.init(), and org.objectweb.jonas_lib.genbase.archive.WebApp.initialize().

void org.objectweb.jonas_lib.genbase.archive.J2EEArchive.setModuleClassloader (  ClassLoader  moduleClassloader  )

Parameters: moduleClassloader  The moduleClassloader to set. Definition at line 241 of file J2EEArchive.java. Referenced by org.objectweb.jonas_lib.genbase.archive.Application.init(), org.objectweb.jonas_lib.genbase.archive.WebApp.initialize(), org.objectweb.jonas_lib.genbase.archive.Client.initialize(), and org.objectweb.jonas_lib.genbase.archive.EjbJar.initialize().

---

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

• src/org/objectweb/jonas_lib/genbase/archive/J2EEArchive.java

---