org.objectweb.jonas_ear.deployment.api
Class EarDeploymentDesc

java.lang.Object
  |
  +--org.objectweb.jonas_lib.deployment.AbsDeploymentDesc
        |
        +--org.objectweb.jonas_ear.deployment.api.EarDeploymentDesc
All Implemented Interfaces:
DeploymentDesc

public class EarDeploymentDesc
extends AbsDeploymentDesc

This class extends the AbsDeploymentDescriptor class of JOnAS It provides a description of the specific EAR desployment descriptor

Author:
Florent Benoit, Ludovic Bert

Fields inherited from class org.objectweb.jonas_lib.deployment.AbsDeploymentDesc
displayName
 
Method Summary
 org.objectweb.jonas_ear.deployment.xml.AltDd[] getAltDDEjbs()
          Get the alt-dd of the ejbs of the application.xml file.
 org.objectweb.jonas_ear.deployment.xml.AltDd[] getAltDDWebs()
          Get the alt-dd of the wars of the application.xml file.
 org.objectweb.jonas_ear.deployment.xml.Ejb[] getEjbTags()
          Get the ejb tags of the application.xml file.
static org.xml.sax.EntityResolver getEntityResolver()
          Get the current EntityResolver.
static org.xml.sax.ErrorHandler getErrorHandler()
          Get the current ErrorHandler.
static EarDeploymentDesc getInstance(java.lang.String earFileName, java.lang.ClassLoader classLoaderForCls)
          Get an instance of an EAR deployment descriptor by parsing the application.xml deployment descriptor.
static boolean getParsingWithValidation()
          Controls whether the parser is reporting all validity errors.
 org.objectweb.jonas_ear.deployment.xml.SecurityRole[] getSecurityRoles()
          Get the security-role tags
 org.objectweb.jonas_ear.deployment.xml.Web[] getWebTags()
          Get the web tags of the application.xml file.
static void setEntityResolver(org.xml.sax.EntityResolver entityResolver)
          Set the specified EntityResolver.
static void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
          Set the specified ErrorHandler.
static void setParsingWithValidation(boolean validation)
          Controls whether the parser is reporting all validity errors.
 java.lang.String toString()
          Return a String representation of the EarDeploymentDesc.
 
Methods inherited from class org.objectweb.jonas_lib.deployment.AbsDeploymentDesc
getDisplayName, getSAXMsg
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getEjbTags

public org.objectweb.jonas_ear.deployment.xml.Ejb[] getEjbTags()
Get the ejb tags of the application.xml file.
Returns:
the ejb tags of the application.xml file.

getAltDDEjbs

public org.objectweb.jonas_ear.deployment.xml.AltDd[] getAltDDEjbs()
Get the alt-dd of the ejbs of the application.xml file.
Returns:
the alt-dd of the ejbs of the application.xml file.

getAltDDWebs

public org.objectweb.jonas_ear.deployment.xml.AltDd[] getAltDDWebs()
Get the alt-dd of the wars of the application.xml file.
Returns:
the alt-dd of the wars of the application.xml file.

getSecurityRoles

public org.objectweb.jonas_ear.deployment.xml.SecurityRole[] getSecurityRoles()
Get the security-role tags
Returns:
the security roles.

getInstance

public static EarDeploymentDesc getInstance(java.lang.String earFileName,
                                            java.lang.ClassLoader classLoaderForCls)
                                     throws EarDeploymentDescException
Get an instance of an EAR deployment descriptor by parsing the application.xml deployment descriptor.
Parameters:
earFileName - the fileName of the war file for the deployment descriptors.
classLoaderForCls - the classloader for the classes.
Returns:
an EAR deployment descriptor by parsing the application.xml deployment descriptor.
Throws:
EarDeploymentDescException - if the deployment descriptor is corrupted.

getWebTags

public org.objectweb.jonas_ear.deployment.xml.Web[] getWebTags()
Get the web tags of the application.xml file.
Returns:
the web tags of the application.xml file.

toString

public java.lang.String toString()
Return a String representation of the EarDeploymentDesc.
Overrides:
toString in class AbsDeploymentDesc
Returns:
a String representation of the EarDeploymentDesc.

getErrorHandler

public static org.xml.sax.ErrorHandler getErrorHandler()
Get the current ErrorHandler.
Returns:
the current ErrorHandler.

getEntityResolver

public static org.xml.sax.EntityResolver getEntityResolver()
Get the current EntityResolver.
Returns:
the current EntityResolver.

getParsingWithValidation

public static boolean getParsingWithValidation()
Controls whether the parser is reporting all validity errors.
Returns:
if true, all external entities will be read.

setErrorHandler

public static void setErrorHandler(org.xml.sax.ErrorHandler errorHandler)
Set the specified ErrorHandler. If the application does not register an ErrorHandler, all error events reported by the reader are ignored.
Parameters:
errorHandler - the Error Handler to set.

setEntityResolver

public static void setEntityResolver(org.xml.sax.EntityResolver entityResolver)
Set the specified EntityResolver.
Parameters:
entityResolver - the Entity Resolver to set.

setParsingWithValidation

public static void setParsingWithValidation(boolean validation)
Controls whether the parser is reporting all validity errors.
Parameters:
validation - if true, all external entities will be read.