DeploymentLoader

java.lang.Object
- org.apache.openejb.config.DeploymentLoader

All Implemented Interfaces:

DeploymentFilterable

Direct Known Subclasses:

TomcatDeploymentLoader
```
public class DeploymentLoader
extends java.lang.Object
implements DeploymentFilterable
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DeploymentLoader.ExternalConfiguration

Nested Classes
Modifier and Type	Class and Description
`static class`	`DeploymentLoader.ExternalConfiguration`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`EAR_SCOPED_CDI_BEANS`
`static java.lang.String`	`EAR_WEBAPP_PERSISTENCE_XML_JARS`
`static Logger`	`logger`
`static java.lang.String`	`OPENEJB_ALTDD_PREFIX`
`static java.lang.String`	`RAR_URLS_KEY`
`static java.lang.String`	`URLS_KEY`

Fields inherited from interface org.apache.openejb.config.DeploymentFilterable
CLASSPATH_EXCLUDE, CLASSPATH_FILTER_DESCRIPTORS, CLASSPATH_FILTER_SYSTEMAPPS, CLASSPATH_INCLUDE, CLASSPATH_REQUIRE_DESCRIPTOR, DEPLOYMENTS_CLASSPATH_PROPERTY, PACKAGE_EXCLUDE, PACKAGE_INCLUDE, SEARCH_CLASSPATH_FOR_DEPLOYMENTS_PROPERTY

Constructor Summary

Constructors
Constructor and Description

DeploymentLoader()

Constructors
Constructor and Description
`DeploymentLoader()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addBeansXmls(WebModule webModule)`
`protected static java.util.Collection<java.net.URL>`	`addPersistenceUnits(AppModule appModule, java.net.URL... urls)`
`protected static void`	`addWebFragments(WebModule webModule, java.util.Collection<java.net.URL> urls)`
`void`	`addWebModule(AppModule appModule, java.net.URL warUrl, java.lang.ClassLoader parentClassLoader, java.lang.String contextRoot, java.lang.String moduleName)`
`static EjbModule`	`addWebModule(WebModule webModule, AppModule appModule)`
`static void`	`addWebModuleDescriptors(java.net.URL baseUrl, WebModule webModule, AppModule appModule)`
`static java.util.Map<java.lang.String,java.net.URL>`	`altDDSources(java.util.Map<java.lang.String,java.net.URL> map, boolean log)` Modifies the map passed in with all the alt dd URLs found
`protected AppModule`	`createAppModule(java.io.File jarFile, java.lang.String jarPath)`
`protected ClientModule`	`createClientModule(java.net.URL clientUrl, java.lang.String absolutePath, java.lang.ClassLoader appClassLoader, java.lang.String moduleName)`
`protected ClientModule`	`createClientModule(java.net.URL clientUrl, java.lang.String absolutePath, java.lang.ClassLoader appClassLoader, java.lang.String moduleName, boolean log)`
`protected static ConnectorModule`	`createConnectorModule(java.lang.String appId, java.lang.String rarPath, java.lang.ClassLoader parentClassLoader, java.lang.String moduleId)`
`protected static ConnectorModule`	`createConnectorModule(java.lang.String appId, java.lang.String rarPath, java.lang.ClassLoader parentClassLoader, java.lang.String moduleId, java.net.URL raXmlUrl)`
`protected EjbModule`	`createEjbModule(java.net.URL baseUrl, java.lang.String jarPath, java.lang.ClassLoader classLoader)`
`WebModule`	`createWebModule(java.lang.String appId, java.lang.String warPath, java.lang.ClassLoader parentClassLoader, java.lang.String contextRoot, java.lang.String moduleName, DeploymentLoader.ExternalConfiguration config)`
`java.lang.Class<? extends DeploymentModule>`	`discoverModuleType(java.net.URL baseUrl, java.lang.ClassLoader classLoader, boolean searchForDescriptorlessApplications)`
`java.lang.Class<? extends DeploymentModule>`	`discoverModuleType(java.net.URL baseUrl, java.lang.ClassLoader classLoader, java.util.Set<RequireDescriptors> requireDescriptor)`
`static void`	`doMerge(java.net.URL url, CompositeBeans current, Beans beans)`
`static java.util.List<java.net.URL>`	`filterWebappUrls(java.net.URL[] webUrls, Filter filter, java.net.URL exclusions)`
`protected java.lang.String`	`getContextRoot()`
`static java.util.Map<java.lang.String,java.net.URL>`	`getDescriptors(java.net.URL moduleUrl)`
`protected java.io.File`	`getFile(java.net.URL warUrl)`
`protected static java.net.URL`	`getFileUrl(java.io.File jarFile)`
`protected java.lang.String`	`getModuleName()`
`protected java.lang.ClassLoader`	`getOpenEJBClassLoader()`
`static java.net.URL[]`	`getWebappUrls(java.io.File warFile)`
`static java.util.Map<java.lang.String,java.net.URL[]>`	`getWebappUrlsAndRars(java.io.File warFile)`
`static java.util.Map<java.lang.String,java.net.URL>`	`getWebDescriptors(java.io.File warFile)`
`AppModule`	`load(java.io.File jarFile)` Deprecated.
`AppModule`	`load(java.io.File jarFile, DeploymentLoader.ExternalConfiguration config)`
`static java.util.Map<java.lang.String,java.net.URL>`	`mapDescriptors(ResourceFinder finder)`
`static void`	`reloadAltDD()`
`static void`	`scanDir(java.io.File dir, java.util.Map<java.lang.String,java.net.URL> files, java.lang.String path)`
`static void`	`scanDir(java.io.File dir, java.util.Map<java.lang.String,java.net.URL> files, java.lang.String path, boolean recursive)`
`static Application`	`unmarshal(java.net.URL url)`
`static java.io.File`	`unpack(java.io.File jarFile)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger
```
public static final Logger logger
```

OPENEJB_ALTDD_PREFIX

public static final java.lang.String OPENEJB_ALTDD_PREFIX

See Also:: Constant Field Values

EAR_WEBAPP_PERSISTENCE_XML_JARS

public static final java.lang.String EAR_WEBAPP_PERSISTENCE_XML_JARS

See Also:: Constant Field Values

EAR_SCOPED_CDI_BEANS

public static final java.lang.String EAR_SCOPED_CDI_BEANS

See Also:: Constant Field Values

RAR_URLS_KEY

public static final java.lang.String RAR_URLS_KEY

See Also:: Constant Field Values

URLS_KEY

public static final java.lang.String URLS_KEY

See Also:: Constant Field Values

Constructor Detail
- DeploymentLoader
```
public DeploymentLoader()
```

Method Detail

load

@Deprecated
public AppModule load(java.io.File jarFile)
                           throws OpenEJBException

Deprecated.

Throws:: OpenEJBException

load
```
public AppModule load(java.io.File jarFile,
                      DeploymentLoader.ExternalConfiguration config)
               throws OpenEJBException
```
Parameters:

jarFile - the app file (war, jar, ear)

config - potentially some more config, mainly used when linking to another system like tomcat to enrich the conf we can guess

Returns:

the loaded module

Throws:

OpenEJBException

addWebModuleDescriptors

public static void addWebModuleDescriptors(java.net.URL baseUrl,
                                           WebModule webModule,
                                           AppModule appModule)
                                    throws OpenEJBException

Throws:: OpenEJBException

getOpenEJBClassLoader

protected java.lang.ClassLoader getOpenEJBClassLoader()

createAppModule

protected AppModule createAppModule(java.io.File jarFile,
                                    java.lang.String jarPath)
                             throws OpenEJBException

Throws:: OpenEJBException

createClientModule

protected ClientModule createClientModule(java.net.URL clientUrl,
                                          java.lang.String absolutePath,
                                          java.lang.ClassLoader appClassLoader,
                                          java.lang.String moduleName)
                                   throws OpenEJBException

Throws:: OpenEJBException

createClientModule

protected ClientModule createClientModule(java.net.URL clientUrl,
                                          java.lang.String absolutePath,
                                          java.lang.ClassLoader appClassLoader,
                                          java.lang.String moduleName,
                                          boolean log)
                                   throws OpenEJBException

Throws:: OpenEJBException

createEjbModule

protected EjbModule createEjbModule(java.net.URL baseUrl,
                                    java.lang.String jarPath,
                                    java.lang.ClassLoader classLoader)
                             throws OpenEJBException

Throws:: OpenEJBException

addWebModule

public void addWebModule(AppModule appModule,
                         java.net.URL warUrl,
                         java.lang.ClassLoader parentClassLoader,
                         java.lang.String contextRoot,
                         java.lang.String moduleName)
                  throws OpenEJBException

Throws:: OpenEJBException

addWebModule

public static EjbModule addWebModule(WebModule webModule,
                                     AppModule appModule)
                              throws OpenEJBException

Throws:: OpenEJBException

createWebModule

public WebModule createWebModule(java.lang.String appId,
                                 java.lang.String warPath,
                                 java.lang.ClassLoader parentClassLoader,
                                 java.lang.String contextRoot,
                                 java.lang.String moduleName,
                                 DeploymentLoader.ExternalConfiguration config)
                          throws OpenEJBException

Throws:: OpenEJBException

filterWebappUrls

public static java.util.List<java.net.URL> filterWebappUrls(java.net.URL[] webUrls,
                                                            Filter filter,
                                                            java.net.URL exclusions)

addBeansXmls

public static void addBeansXmls(WebModule webModule)

doMerge

public static void doMerge(java.net.URL url,
                           CompositeBeans current,
                           Beans beans)

getContextRoot

protected java.lang.String getContextRoot()

getModuleName

protected java.lang.String getModuleName()

getWebappUrlsAndRars

public static java.util.Map<java.lang.String,java.net.URL[]> getWebappUrlsAndRars(java.io.File warFile)

getWebappUrls

public static java.net.URL[] getWebappUrls(java.io.File warFile)

createConnectorModule

protected static ConnectorModule createConnectorModule(java.lang.String appId,
                                                       java.lang.String rarPath,
                                                       java.lang.ClassLoader parentClassLoader,
                                                       java.lang.String moduleId)
                                                throws OpenEJBException

Throws:: OpenEJBException

createConnectorModule

protected static ConnectorModule createConnectorModule(java.lang.String appId,
                                                       java.lang.String rarPath,
                                                       java.lang.ClassLoader parentClassLoader,
                                                       java.lang.String moduleId,
                                                       java.net.URL raXmlUrl)
                                                throws OpenEJBException

Throws:: OpenEJBException

addWebFragments

protected static void addWebFragments(WebModule webModule,
                                      java.util.Collection<java.net.URL> urls)
                               throws OpenEJBException

Throws:: OpenEJBException

addPersistenceUnits

protected static java.util.Collection<java.net.URL> addPersistenceUnits(AppModule appModule,
                                                                        java.net.URL... urls)
                                                                 throws OpenEJBException

Throws:: OpenEJBException

getDescriptors

public static java.util.Map<java.lang.String,java.net.URL> getDescriptors(java.net.URL moduleUrl)
                                                                   throws OpenEJBException

Throws:: OpenEJBException

mapDescriptors

public static java.util.Map<java.lang.String,java.net.URL> mapDescriptors(ResourceFinder finder)
                                                                   throws java.io.IOException

Throws:: java.io.IOException

altDDSources

public static java.util.Map<java.lang.String,java.net.URL> altDDSources(java.util.Map<java.lang.String,java.net.URL> map,
                                                                        boolean log)

Modifies the map passed in with all the alt dd URLs found

Parameters:: map - Map; log - boolean
Returns:: the same map instance updated with alt dds

getWebDescriptors

public static java.util.Map<java.lang.String,java.net.URL> getWebDescriptors(java.io.File warFile)
                                                                      throws java.io.IOException

Throws:: java.io.IOException

getFile

protected java.io.File getFile(java.net.URL warUrl)

unmarshal

public static Application unmarshal(java.net.URL url)
                             throws OpenEJBException

Throws:: OpenEJBException

scanDir

public static void scanDir(java.io.File dir,
                           java.util.Map<java.lang.String,java.net.URL> files,
                           java.lang.String path)

scanDir

public static void scanDir(java.io.File dir,
                           java.util.Map<java.lang.String,java.net.URL> files,
                           java.lang.String path,
                           boolean recursive)

discoverModuleType

public java.lang.Class<? extends DeploymentModule> discoverModuleType(java.net.URL baseUrl,
                                                                      java.lang.ClassLoader classLoader,
                                                                      boolean searchForDescriptorlessApplications)
                                                               throws java.io.IOException,
                                                                      UnknownModuleTypeException

Throws:: java.io.IOException; UnknownModuleTypeException

discoverModuleType

public java.lang.Class<? extends DeploymentModule> discoverModuleType(java.net.URL baseUrl,
                                                                      java.lang.ClassLoader classLoader,
                                                                      java.util.Set<RequireDescriptors> requireDescriptor)
                                                               throws java.io.IOException,
                                                                      UnknownModuleTypeException

Throws:: java.io.IOException; UnknownModuleTypeException

unpack

public static java.io.File unpack(java.io.File jarFile)
                           throws OpenEJBException

Throws:: OpenEJBException

getFileUrl

protected static java.net.URL getFileUrl(java.io.File jarFile)
                                  throws OpenEJBException

Throws:: OpenEJBException

reloadAltDD
```
public static void reloadAltDD()
```

Class DeploymentLoader

Nested Class Summary

Field Summary

Fields inherited from interface org.apache.openejb.config.DeploymentFilterable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

OPENEJB_ALTDD_PREFIX

EAR_WEBAPP_PERSISTENCE_XML_JARS

EAR_SCOPED_CDI_BEANS

RAR_URLS_KEY

URLS_KEY

Constructor Detail

DeploymentLoader

Method Detail

load

load

addWebModuleDescriptors

getOpenEJBClassLoader

createAppModule

createClientModule

createClientModule

createEjbModule

addWebModule

addWebModule

createWebModule

filterWebappUrls

addBeansXmls

doMerge

getContextRoot

getModuleName

getWebappUrlsAndRars

getWebappUrls

createConnectorModule

createConnectorModule

addWebFragments

addPersistenceUnits

getDescriptors

mapDescriptors

altDDSources

getWebDescriptors

getFile

unmarshal

scanDir

scanDir

discoverModuleType

discoverModuleType

unpack

getFileUrl

reloadAltDD