com.sun.enterprise.deployment.util

Class DOLUtils

java.lang.Object

com.sun.enterprise.deployment.util.DOLUtils

public class DOLUtils
extends Object

Utility class for convenience methods

Version:

Author:

Jerome Dochez

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	deplLogger
static String	INVALID_DESC_MAPPING
static String	SCHEMA_LOCATION_TAG
static String	W3C_XML_SCHEMA

Method Summary

Modifier and Type	Method and Description
static ArchiveType	carType()
static ArchiveType	earType()
static ArchiveType	ejbType()
static boolean	equals(Object a, Object b)
static Application	getApplicationFromEnv(JndiNameEnvironment env)
static String	getApplicationName(JndiNameEnvironment env)
static String	getComponentEnvId(JndiNameEnvironment env) Generate a unique id name for each J2EE component.
static List<ConfigurationDeploymentDescriptorFile>	getConfigurationDeploymentDescriptorFiles(org.glassfish.hk2.api.ServiceLocator habitat, String containerType)
static BundleDescriptor	getCurrentBundleForContext(DeploymentContext context)
static Logger	getDefaultLogger()
static List<URI>	getLibraryJarURIs(Application app, ReadableArchive archive)
static List<URI>	getLibraryJarURIs(BundleDescriptor bundleDesc, ReadableArchive archive)
static String	getModuleName(JndiNameEnvironment env)
static ArchiveType	getModuleType(String moduleType) Utility method to retrieve a ArchiveType from a stringified module type.
static List<String>	getProprietaryDTDStart()
static List<String>	getProprietarySchemaNamespaces()
static boolean	getTreatComponentAsModule(JndiNameEnvironment env)
static boolean	isGFDDOverWLSDD()
static boolean	isIgnoreWLSDD()
static boolean	isRAConnectionFactory(org.glassfish.hk2.api.ServiceLocator habitat, String type, Application thisApp)
static boolean	isScanningAllowed(Application app, String entryName)
static boolean	isWhiteListed(Application application, String className) Supports extreme classloading isolation
static List<ConfigurationDeploymentDescriptorFile>	processConfigurationDDFiles(List<ConfigurationDeploymentDescriptorFile> ddFiles, ReadableArchive archive, ArchiveType archiveType)
static ArchiveType	rarType()
static void	readAlternativeRuntimeDescriptor(ReadableArchive appArchive, ReadableArchive embeddedArchive, Archivist archivist, BundleDescriptor descriptor, String altDDPath)
static void	readRuntimeDeploymentDescriptor(List<ConfigurationDeploymentDescriptorFile> confDDFiles, ReadableArchive archive, RootDeploymentDescriptor descriptor, Archivist main, boolean warnIfMultipleDDs) Read the runtime deployment descriptors (can contained in one or many file) set the corresponding information in the passed descriptor.
static boolean	setElementValue(XMLElement element, String value, Object o) receives notiification of the value for a particular tag
static void	setExtensionArchivistForSubArchivist(org.glassfish.hk2.api.ServiceLocator habitat, ReadableArchive archive, ModuleDescriptor md, Application app, Archivist subArchivist)
static void	validateRuntimeAltDDPath(String runtimeAltDDPath)
static ArchiveType	warType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

W3C_XML_SCHEMA

public static final String W3C_XML_SCHEMA

See Also:

Constant Field Values

SCHEMA_LOCATION_TAG

public static final String SCHEMA_LOCATION_TAG

See Also:

Constant Field Values

deplLogger

public static final Logger deplLogger

INVALID_DESC_MAPPING

public static final String INVALID_DESC_MAPPING

See Also:

Constant Field Values

Method Detail

getDefaultLogger

public static Logger getDefaultLogger()

Returns:

a logger to use in the DOL implementation classes

equals

public static boolean equals(Object a,
                             Object b)

getLibraryJarURIs

public static List<URI> getLibraryJarURIs(BundleDescriptor bundleDesc,
                                          ReadableArchive archive)
                                   throws Exception

Throws:

Exception

isScanningAllowed

public static boolean isScanningAllowed(Application app,
                                        String entryName)

getLibraryJarURIs

public static List<URI> getLibraryJarURIs(Application app,
                                          ReadableArchive archive)
                                   throws Exception

Throws:

Exception

getCurrentBundleForContext

public static BundleDescriptor getCurrentBundleForContext(DeploymentContext context)

isRAConnectionFactory

public static boolean isRAConnectionFactory(org.glassfish.hk2.api.ServiceLocator habitat,
                                            String type,
                                            Application thisApp)

earType

public static ArchiveType earType()

ejbType

public static ArchiveType ejbType()

carType

public static ArchiveType carType()

warType

public static ArchiveType warType()

rarType

public static ArchiveType rarType()

getModuleType

public static ArchiveType getModuleType(String moduleType)

Utility method to retrieve a ArchiveType from a stringified module type. Since ArchiveType is an extensible abstraction and implementations are plugged in via HK2 service registry, this method returns null if HK2 service registry is not setup. If null is passed to this method, it returns null instead of returning an arbitrary ArchiveType or throwing an exception.

Parameters:

moduleType - String equivalent of the module type being looked up. null is allowed.

Returns:

the corresponding ArchiveType, null if no such module type exists or HK2 Service registry is not set up

isGFDDOverWLSDD

public static boolean isGFDDOverWLSDD()

isIgnoreWLSDD

public static boolean isIgnoreWLSDD()

validateRuntimeAltDDPath

public static void validateRuntimeAltDDPath(String runtimeAltDDPath)

processConfigurationDDFiles

public static List<ConfigurationDeploymentDescriptorFile> processConfigurationDDFiles(List<ConfigurationDeploymentDescriptorFile> ddFiles,
                                                                                      ReadableArchive archive,
                                                                                      ArchiveType archiveType)
                                                                               throws IOException

Throws:

IOException

readAlternativeRuntimeDescriptor

public static void readAlternativeRuntimeDescriptor(ReadableArchive appArchive,
                                                    ReadableArchive embeddedArchive,
                                                    Archivist archivist,
                                                    BundleDescriptor descriptor,
                                                    String altDDPath)
                                             throws IOException,
                                                    SAXParseException

Throws:

IOException

SAXParseException

readRuntimeDeploymentDescriptor

public static void readRuntimeDeploymentDescriptor(List<ConfigurationDeploymentDescriptorFile> confDDFiles,
                                                   ReadableArchive archive,
                                                   RootDeploymentDescriptor descriptor,
                                                   Archivist main,
                                                   boolean warnIfMultipleDDs)
                                            throws IOException,
                                                   SAXParseException

Read the runtime deployment descriptors (can contained in one or many file) set the corresponding information in the passed descriptor. By default, the runtime deployment descriptors are all contained in the xml file characterized with the path returned by

Parameters:

confDDFiles - the sorted configuration files for this archive

archive - the archive

descriptor - the initialized deployment descriptor

main - the main archivist

warnIfMultipleDDs - whether to log warnings if both the GlassFish and the legacy Sun descriptors are present

Throws:

IOException

SAXParseException

setExtensionArchivistForSubArchivist

public static void setExtensionArchivistForSubArchivist(org.glassfish.hk2.api.ServiceLocator habitat,
                                                        ReadableArchive archive,
                                                        ModuleDescriptor md,
                                                        Application app,
                                                        Archivist subArchivist)

getConfigurationDeploymentDescriptorFiles

public static List<ConfigurationDeploymentDescriptorFile> getConfigurationDeploymentDescriptorFiles(org.glassfish.hk2.api.ServiceLocator habitat,
                                                                                                    String containerType)

setElementValue

public static boolean setElementValue(XMLElement element,
                                      String value,
                                      Object o)

receives notiification of the value for a particular tag

Parameters:

element - the xml element

value - it's associated value

getProprietarySchemaNamespaces

public static List<String> getProprietarySchemaNamespaces()

getProprietaryDTDStart

public static List<String> getProprietaryDTDStart()

getApplicationFromEnv

public static Application getApplicationFromEnv(JndiNameEnvironment env)

getApplicationName

public static String getApplicationName(JndiNameEnvironment env)

getModuleName

public static String getModuleName(JndiNameEnvironment env)

getTreatComponentAsModule

public static boolean getTreatComponentAsModule(JndiNameEnvironment env)

getComponentEnvId

public static String getComponentEnvId(JndiNameEnvironment env)

Generate a unique id name for each J2EE component.

isWhiteListed

public static boolean isWhiteListed(Application application,
                                    String className)

Supports extreme classloading isolation

Parameters:

application -

className -

Returns:

true if the class is white-listed