org.objectweb.jonas_rar.deployment.api
Class RarDeploymentDesc

java.lang.Object
  |
  +--org.objectweb.jonas_lib.deployment.AbsDeploymentDesc
        |
        +--org.objectweb.jonas_rar.deployment.api.RarDeploymentDesc

All Implemented Interfaces:

DeploymentDesc

public class RarDeploymentDesc

extends AbsDeploymentDesc

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

Author:

Eric Hardesty

Fields inherited from class org.objectweb.jonas_lib.deployment.AbsDeploymentDesc

displayName

Method Summary

static org.objectweb.jonas_rar.deployment.xml.Connector	getConnector() Get the current Connector.
static org.xml.sax.EntityResolver	getEntityResolver() Get the current EntityResolver.
static org.xml.sax.ErrorHandler	getErrorHandler() Get the current ErrorHandler.
static RarDeploymentDesc	getInstance(java.lang.String rarFileName, java.lang.ClassLoader classLoader) Get an instance of an RAR deployment descriptor by parsing the ra.xml and jonas-ra.xml deployment descriptors.
static RarDeploymentDesc	getInstance(java.lang.String rarFileName, java.lang.ClassLoader classLoader, boolean setupRa, boolean setupJonasRa) Get an instance of an RAR deployment descriptor by parsing the ra.xml and jonas-ra.xml deployment descriptors.
org.objectweb.jonas_rar.deployment.xml.JonasConfigProperty[]	getJonasConfigPropTags() Get the config-property tags of the jonas-ra.xml file.
static org.objectweb.jonas_rar.deployment.xml.JonasResource	getJonasResource() Get the current JonasResource.
static boolean	getParsingWithValidation() Controls whether the parser is reporting all validity errors.
org.objectweb.jonas_rar.deployment.xml.ConfigProperty[]	getRaConfigPropTags() Get the config-property tags of the ra.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.
void	setRaConfigPropTags(org.objectweb.jonas_rar.deployment.xml.Connector conn) Set the config-property tags of the ra.xml file.
java.lang.String	toString() Return a String representation of the RarDeploymentDesc.

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

setRaConfigPropTags

public void setRaConfigPropTags(org.objectweb.jonas_rar.deployment.xml.Connector conn)

Set the config-property tags of the ra.xml file.

Parameters:

the - Connector objeect with the config-property tags of the ra.xml file.

getRaConfigPropTags

public org.objectweb.jonas_rar.deployment.xml.ConfigProperty[] getRaConfigPropTags()

Get the config-property tags of the ra.xml file.

Returns:

the config-property tags of the ra.xml file.

getJonasConfigPropTags

public org.objectweb.jonas_rar.deployment.xml.JonasConfigProperty[] getJonasConfigPropTags()

Get the config-property tags of the jonas-ra.xml file.

Returns:

the config-property tags of the jonas-ra.xml file.

getInstance

public static RarDeploymentDesc getInstance(java.lang.String rarFileName,
                                            java.lang.ClassLoader classLoader)
                                     throws RarDeploymentDescException

Get an instance of an RAR deployment descriptor by parsing the ra.xml and jonas-ra.xml deployment descriptors.

Parameters:

rarFileName - the fileName of the rar file for the deployment descriptors.

classLoader - the classloader for the classes.

Returns:

an RAR deployment descriptor by parsing the ra.xml & jonas-ra.xml deployment descriptors.

Throws:

RarDeploymentDescException - if the deployment descriptors are corrupted.

getInstance

public static RarDeploymentDesc getInstance(java.lang.String rarFileName,
                                            java.lang.ClassLoader classLoader,
                                            boolean setupRa,
                                            boolean setupJonasRa)
                                     throws RarDeploymentDescException

Get an instance of an RAR deployment descriptor by parsing the ra.xml and jonas-ra.xml deployment descriptors.

Parameters:

rarFileName - the fileName of the rar file for the deployment descriptors.

classLoader - the classloader for the classes.

setupJonasRa - a boolean to determine if the ra.xml should be processed

setupJonasRa - a boolean to determine if the jonas-ra.xml should be processed

Returns:

an RAR deployment descriptor by parsing the ra.xml & jonas-ra.xml deployment descriptors.

Throws:

RarDeploymentDescException - if the deployment descriptors are corrupted.

toString

public java.lang.String toString()

Return a String representation of the RarDeploymentDesc.

Overrides:

toString in class AbsDeploymentDesc

Returns:

a String representation of the RarDeploymentDesc.

getConnector

public static org.objectweb.jonas_rar.deployment.xml.Connector getConnector()

Get the current Connector.

Returns:

the current Connector.

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.

getJonasResource

public static org.objectweb.jonas_rar.deployment.xml.JonasResource getJonasResource()

Get the current JonasResource.

Returns:

the current JonasResource.

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.