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

org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager Class Reference

Collaboration diagram for org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager:

Collaboration graph
[legend]
List of all members.

Public Member Functions

ClientContainerDeploymentDesc 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

ClientDeploymentDescManager getInstance ()
ClientContainerDeploymentDesc getInstance (String clientFileName, ClassLoader classLoaderForCls) throws DeploymentDescException
ClientContainerDeploymentDesc getInstance (String clientFileName, ClassLoader classLoaderForCls, String altClientXmlFilename) throws DeploymentDescException
ApplicationClient loadApplicationClient (Reader reader, String fileName) throws DeploymentDescException
JonasClient loadJonasClient (Reader reader, String fileName) throws DeploymentDescException
boolean getParsingWithValidation ()
void setParsingWithValidation (boolean validation)

Static Public Attributes

final String CLIENT_FILE_NAME = "META-INF/application-client.xml"
final String JONAS_CLIENT_FILE_NAME = "META-INF/jonas-client.xml"

Detailed Description

This class provide a way for managing the ClientContainerDeploymentDesc.
Author:
Florent Benoit

Definition at line 76 of file ClientDeploymentDescManager.java.

Member Function Documentation

int org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.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 777 of file ClientDeploymentDescManager.java.

ClientContainerDeploymentDesc org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.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:
ClientContainerDeploymentDesc the web deployment descriptor.
Exceptions:
DeploymentDescException when ClientContainerDeploymentDesc cannot be created with the given files.

Definition at line 158 of file ClientDeploymentDescManager.java.

References org.objectweb.jonas_lib.deployment.api.EjbRefDesc.getEjbLink(), org.objectweb.jonas_lib.deployment.api.EjbRefDesc.getEjbRefType(), org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.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.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:

ClientContainerDeploymentDesc org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getInstance (  String  clientFileName,
ClassLoader  classLoaderForCls,
String  altClientXmlFilename
)  throws DeploymentDescException [static]
 

Get an instance of a Client deployment descriptor by parsing the application-client.xml and jonas-client.xml deployment descriptors.

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

Definition at line 407 of file ClientDeploymentDescManager.java.

References org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.CLIENT_FILE_NAME, org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.JONAS_CLIENT_FILE_NAME, org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.loadApplicationClient(), org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.loadJonasClient(), org.objectweb.jonas_client.deployment.api.ClientContainerDeploymentDesc.setJOnASXmlContent(), and org.objectweb.jonas_client.deployment.api.ClientContainerDeploymentDesc.setXmlContent().

Here is the call graph for this function:

ClientContainerDeploymentDesc org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getInstance (  String  clientFileName,
ClassLoader  classLoaderForCls
)  throws DeploymentDescException [static]
 

Get an instance of a Client deployment descriptor by parsing the application-client.xml and jonas-client.xml deployment descriptors.

Parameters:
clientFileName the fileName of the client file for the deployment descriptors.
classLoaderForCls the classloader for the classes.
Returns:
a Client deployment descriptor by parsing the application-client.xml and jonas-client.xml deployment descriptors.
Exceptions:
DeploymentDescException if the deployment descriptors are corrupted.

Definition at line 386 of file ClientDeploymentDescManager.java.

References org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getInstance().

Here is the call graph for this function:

ClientDeploymentDescManager org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getInstance (   )  [static]
 

Get an instance of the ClientDeploymentDescManager.

Returns:
the instance of the ClientDeploymentDescManager.

Definition at line 141 of file ClientDeploymentDescManager.java.

Referenced by org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getDeploymentDesc(), and org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getInstance().

boolean org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getParsingWithValidation (   )  [static]
 

Controls whether the parser is reporting all validity errors.

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

Definition at line 794 of file ClientDeploymentDescManager.java.

Referenced by org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.loadApplicationClient(), and org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.loadJonasClient().

ApplicationClient org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.loadApplicationClient (  Reader  reader,
String  fileName
)  throws DeploymentDescException [static]
 

Load the application-client.xml file.

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

Definition at line 557 of file ClientDeploymentDescManager.java.

References org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getParsingWithValidation(), and org.objectweb.jonas_lib.deployment.digester.JDigester.parse().

Referenced by org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getInstance().

Here is the call graph for this function:

JonasClient org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.loadJonasClient (  Reader  reader,
String  fileName
)  throws DeploymentDescException [static]
 

Load the jonas-client.xml file.

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

Definition at line 588 of file ClientDeploymentDescManager.java.

References org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getParsingWithValidation(), and org.objectweb.jonas_lib.deployment.digester.JDigester.parse().

Referenced by org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getInstance().

Here is the call graph for this function:

void org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.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 737 of file ClientDeploymentDescManager.java.

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

Here is the call graph for this function:

void org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.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 755 of file ClientDeploymentDescManager.java.

void org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.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 802 of file ClientDeploymentDescManager.java.

References org.objectweb.jonas_ejb.deployment.lib.EjbDeploymentDescManager.parsingWithValidation.

Member Data Documentation

final String org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.CLIENT_FILE_NAME = "META-INF/application-client.xml" [static]
 

The path to the application-client.xml file.

Definition at line 97 of file ClientDeploymentDescManager.java.

Referenced by org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getInstance().

final String org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.JONAS_CLIENT_FILE_NAME = "META-INF/jonas-client.xml" [static]
 

The path to the jonas-client.xml file.

Definition at line 102 of file ClientDeploymentDescManager.java.

Referenced by org.objectweb.jonas_client.deployment.lib.ClientDeploymentDescManager.getInstance().

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