ConfigurationFactory

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

All Implemented Interfaces:: OpenEjbConfigurationFactory

public class ConfigurationFactory
extends java.lang.Object
implements OpenEjbConfigurationFactory

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConfigurationFactory.Chain

static class ConfigurationFactory.ProxyBeanClassUpdate

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConfigurationFactory.Chain`
`static class`	`ConfigurationFactory.ProxyBeanClassUpdate`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ADDITIONAL_DEPLOYMENTS`
`static java.lang.String`	`OPENEJB_JDBC_DATASOURCE_CREATOR`
`protected static java.lang.String`	`VALIDATION_SKIP_PROPERTY`

Constructor Summary

Constructors
Constructor and Description
`ConfigurationFactory()`
`ConfigurationFactory(boolean offline)`
`ConfigurationFactory(boolean offline, ConfigurationFactory.Chain deployerChain, OpenEjbConfiguration configuration)`
`ConfigurationFactory(boolean offline, DynamicDeployer preAutoConfigDeployer)`
`ConfigurationFactory(boolean offline, DynamicDeployer preAutoConfigDeployer, OpenEjbConfiguration configuration)`
`ConfigurationFactory(boolean offline, OpenEjbConfiguration configuration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AppInfo`	`configureApplication(AppModule appModule)`
`AppInfo`	`configureApplication(java.lang.ClassLoader classLoader, java.lang.String id, java.util.List<java.io.File> jarFiles)` embedded usage
`ClientInfo`	`configureApplication(ClientModule clientModule)`
`ConnectorInfo`	`configureApplication(ConnectorModule connectorModule)`
`EjbJarInfo`	`configureApplication(EjbJar ejbJar)`
`EjbJarInfo`	`configureApplication(EjbModule ejbModule)`
`AppInfo`	`configureApplication(java.io.File jarFile)`
`WebAppInfo`	`configureApplication(WebModule webModule)`
`<T extends ServiceInfo> T`	`configureService(java.lang.Class<? extends T> type)`
`<T extends ServiceInfo> T`	`configureService(java.lang.Class<? extends T> type, java.lang.String serviceId, java.util.Properties declaredProperties, java.lang.String providerId, java.lang.String serviceType)` Resolving the provider for a particular service follows this algorithm: 1.
`<T extends ServiceInfo> T`	`configureService(Service service, java.lang.Class<? extends T> infoType)` This is the major piece of code that configures services.
`<T extends ServiceInfo> T`	`configureService(java.lang.String id, java.lang.Class<? extends T> type)`
`ContainerInfo`	`createContainerInfo(Container container)`
`static void`	`fillOpenEjb(Openejb openejb, java.util.Properties sysProps)`
`protected java.util.List<java.lang.String>`	`getContainerIds()`
`protected java.util.List<ContainerInfo>`	`getContainerInfos()`
`protected static java.lang.Class<? extends ContainerInfo>`	`getContainerInfoType(java.lang.String ctype)`
`java.util.ArrayList<java.io.File>`	`getModulesFromClassPath(java.util.List<java.io.File> declaredApps, java.lang.ClassLoader classLoader)`
`OpenEjbConfiguration`	`getOpenEjbConfiguration()` Main loop that gets executed when OpenEJB starts up Reads config files and produces the basic "AST" the assembler needs to actually build the contianer system This method is called by the Assembler once at startup.
`OpenEjbConfiguration`	`getOpenEjbConfiguration(java.io.File configuartionFile)`
`OpenEjbConfiguration`	`getOpenEjbConfiguration(Openejb providedConf)`
`protected static java.util.Properties`	`getOverrides(java.util.Properties properties, java.lang.String serviceId, java.lang.String serviceType)`
`protected java.util.List<java.lang.String>`	`getResourceIds()`
`protected java.util.List<java.lang.String>`	`getResourceIds(java.lang.String type)`
`java.util.List<java.lang.String>`	`getResourceIds(java.lang.String type, java.util.Properties required)`
`protected ResourceInfo`	`getResourceInfo(java.lang.String id)`
`protected static java.util.Properties`	`getSystemProperties(java.lang.String serviceId, java.lang.String serviceType)`
`void`	`init(java.util.Properties props)`
`protected void`	`install(ContainerInfo serviceInfo)`
`protected void`	`install(ResourceInfo serviceInfo)`
`boolean`	`isOffline()`
`static boolean`	`isResourceType(java.lang.String service, java.util.List<java.lang.String> types, java.lang.String type)`
`AppModule`	`loadApplication(java.lang.ClassLoader classLoader, java.lang.String id, java.util.List<java.io.File> jarFiles)`
`static void`	`loadPropertiesDeclaredConfiguration(Openejb openejb)`
`static java.net.URI[]`	`resolveClasspath(java.lang.String rawstring)` Takes a raw unparsed string expected to be in jvm classpath syntax and parses it, producing a collection of URIs representing the absolute file paths of the classpath to be created.
`static java.util.List<ResourceInfo>`	`sort(java.util.List<ResourceInfo> infos, java.lang.String prefix)`
`protected static java.lang.Object`	`toConfigDeclaration(java.lang.String name, java.lang.String value)`
`static java.lang.Object`	`toConfigDeclaration(java.lang.String id, java.net.URI uri)`
`static java.util.List<HandlerChainInfo>`	`toHandlerChainInfo(HandlerChains chains)`

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

Field Detail

OPENEJB_JDBC_DATASOURCE_CREATOR

public static final java.lang.String OPENEJB_JDBC_DATASOURCE_CREATOR

See Also:: Constant Field Values

ADDITIONAL_DEPLOYMENTS

public static final java.lang.String ADDITIONAL_DEPLOYMENTS

See Also:: Constant Field Values

VALIDATION_SKIP_PROPERTY

protected static final java.lang.String VALIDATION_SKIP_PROPERTY

See Also:: Constant Field Values

Constructor Detail

ConfigurationFactory
```
public ConfigurationFactory()
```

ConfigurationFactory

public ConfigurationFactory(boolean offline)

ConfigurationFactory

public ConfigurationFactory(boolean offline,
                            DynamicDeployer preAutoConfigDeployer)

ConfigurationFactory

public ConfigurationFactory(boolean offline,
                            OpenEjbConfiguration configuration)

ConfigurationFactory

public ConfigurationFactory(boolean offline,
                            DynamicDeployer preAutoConfigDeployer,
                            OpenEjbConfiguration configuration)

ConfigurationFactory

public ConfigurationFactory(boolean offline,
                            ConfigurationFactory.Chain deployerChain,
                            OpenEjbConfiguration configuration)

Method Detail

isOffline
```
public boolean isOffline()
```

toHandlerChainInfo

public static java.util.List<HandlerChainInfo> toHandlerChainInfo(HandlerChains chains)

init
```
public void init(java.util.Properties props)
          throws OpenEJBException
```
Specified by:

init in interface OpenEjbConfigurationFactory

Throws:

OpenEJBException

install

protected void install(ContainerInfo serviceInfo)
                throws OpenEJBException

Throws:: OpenEJBException

install

protected void install(ResourceInfo serviceInfo)
                throws OpenEJBException

Throws:: OpenEJBException

getOpenEjbConfiguration

public OpenEjbConfiguration getOpenEjbConfiguration(java.io.File configuartionFile)
                                             throws OpenEJBException

Throws:: OpenEJBException

getOpenEjbConfiguration

public OpenEjbConfiguration getOpenEjbConfiguration(Openejb providedConf)
                                             throws OpenEJBException

Throws:: OpenEJBException

getOpenEjbConfiguration
```
public OpenEjbConfiguration getOpenEjbConfiguration()
                                             throws OpenEJBException
```
Main loop that gets executed when OpenEJB starts up Reads config files and produces the basic "AST" the assembler needs to actually build the contianer system This method is called by the Assembler once at startup.

Specified by:

getOpenEjbConfiguration in interface OpenEjbConfigurationFactory

Returns:

OpenEjbConfiguration

Throws:

OpenEJBException

getModulesFromClassPath

public java.util.ArrayList<java.io.File> getModulesFromClassPath(java.util.List<java.io.File> declaredApps,
                                                                 java.lang.ClassLoader classLoader)

createContainerInfo

public ContainerInfo createContainerInfo(Container container)
                                  throws OpenEJBException

Throws:: OpenEJBException

loadPropertiesDeclaredConfiguration

public static void loadPropertiesDeclaredConfiguration(Openejb openejb)

fillOpenEjb

public static void fillOpenEjb(Openejb openejb,
                               java.util.Properties sysProps)

toConfigDeclaration

protected static java.lang.Object toConfigDeclaration(java.lang.String name,
                                                      java.lang.String value)
                                               throws java.net.URISyntaxException,
                                                      OpenEJBException

Throws:: java.net.URISyntaxException; OpenEJBException

toConfigDeclaration

public static java.lang.Object toConfigDeclaration(java.lang.String id,
                                                   java.net.URI uri)
                                            throws OpenEJBException

Throws:: OpenEJBException

configureApplication

public AppInfo configureApplication(java.io.File jarFile)
                             throws OpenEJBException

Throws:: OpenEJBException

configureApplication

public AppInfo configureApplication(java.lang.ClassLoader classLoader,
                                    java.lang.String id,
                                    java.util.List<java.io.File> jarFiles)
                             throws OpenEJBException

embedded usage

Parameters:: classLoader - classloader; id - id supplied from embedded properties or null; jarFiles - list of ejb modules
Returns:: configured AppInfo
Throws:: OpenEJBException - on error

loadApplication

public AppModule loadApplication(java.lang.ClassLoader classLoader,
                                 java.lang.String id,
                                 java.util.List<java.io.File> jarFiles)
                          throws OpenEJBException

Throws:: OpenEJBException

configureApplication

public EjbJarInfo configureApplication(EjbJar ejbJar)
                                throws OpenEJBException

Throws:: OpenEJBException

configureApplication

public EjbJarInfo configureApplication(EjbModule ejbModule)
                                throws OpenEJBException

Throws:: OpenEJBException

configureApplication

public ClientInfo configureApplication(ClientModule clientModule)
                                throws OpenEJBException

Throws:: OpenEJBException

configureApplication

public ConnectorInfo configureApplication(ConnectorModule connectorModule)
                                   throws OpenEJBException

Throws:: OpenEJBException

configureApplication

public WebAppInfo configureApplication(WebModule webModule)
                                throws OpenEJBException

Throws:: OpenEJBException

configureApplication

public AppInfo configureApplication(AppModule appModule)
                             throws OpenEJBException

Throws:: OpenEJBException

configureService

public <T extends ServiceInfo> T configureService(java.lang.Class<? extends T> type)
                                           throws OpenEJBException

Throws:: OpenEJBException

configureService
```
public <T extends ServiceInfo> T configureService(Service service,
                                                  java.lang.Class<? extends T> infoType)
                                           throws OpenEJBException
```
This is the major piece of code that configures services. It merges the data from the declaration with the data from the openejb.xml file (say ) The end result is a canonical (i.e. flattened) ServiceInfo The ServiceInfo will be of a specific type (ContainerInfo, ResourceInfo, etc)

Type Parameters:

T - infoType

Parameters:

service - Service

infoType - Class

Returns:

ServiceInfo

Throws:

OpenEJBException - On error

resolveClasspath
```
public static java.net.URI[] resolveClasspath(java.lang.String rawstring)
                                       throws java.io.IOException
```
Takes a raw unparsed string expected to be in jvm classpath syntax and parses it, producing a collection of URIs representing the absolute file paths of the classpath to be created. OS specific delimiters are supported.

Parameters:

rawstring - unparsed string in "classpath" syntax

Returns:

URI array

Throws:

java.io.IOException - if path cannot be resolved or file referenced does not exist

configureService

public <T extends ServiceInfo> T configureService(java.lang.String id,
                                                  java.lang.Class<? extends T> type)
                                           throws OpenEJBException

Throws:: OpenEJBException

configureService
```
public <T extends ServiceInfo> T configureService(java.lang.Class<? extends T> type,
                                                  java.lang.String serviceId,
                                                  java.util.Properties declaredProperties,
                                                  java.lang.String providerId,
                                                  java.lang.String serviceType)
                                           throws OpenEJBException
```
Resolving the provider for a particular service follows this algorithm: 1. Attempt to load the provider specified by the 'providerId'. 2. If this fails, throw NoSuchProviderException 3. If providerId is null, attempt to load the specified provider using the 'serviceId' as the 'providerId' 4. If this fails, check the hardcoded defaults for a default providerId using the supplied 'type' 5. If this fails, throw NoSuchProviderException

Parameters:

type - Class T

serviceId - String

declaredProperties - Properties

providerId - String

serviceType - String

Returns:

ServiceInfo T

Throws:

OpenEJBException

getSystemProperties

protected static java.util.Properties getSystemProperties(java.lang.String serviceId,
                                                          java.lang.String serviceType)

getOverrides

protected static java.util.Properties getOverrides(java.util.Properties properties,
                                                   java.lang.String serviceId,
                                                   java.lang.String serviceType)

getContainerInfoType

protected static java.lang.Class<? extends ContainerInfo> getContainerInfoType(java.lang.String ctype)

getResourceIds

protected java.util.List<java.lang.String> getResourceIds()

getResourceIds

protected java.util.List<java.lang.String> getResourceIds(java.lang.String type)

getResourceIds

public java.util.List<java.lang.String> getResourceIds(java.lang.String type,
                                                       java.util.Properties required)

getResourceInfo

protected ResourceInfo getResourceInfo(java.lang.String id)

isResourceType

public static boolean isResourceType(java.lang.String service,
                                     java.util.List<java.lang.String> types,
                                     java.lang.String type)

getContainerIds

protected java.util.List<java.lang.String> getContainerIds()

getContainerInfos

protected java.util.List<ContainerInfo> getContainerInfos()

sort

public static java.util.List<ResourceInfo> sort(java.util.List<ResourceInfo> infos,
                                                java.lang.String prefix)

Class ConfigurationFactory

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPENEJB_JDBC_DATASOURCE_CREATOR

ADDITIONAL_DEPLOYMENTS

VALIDATION_SKIP_PROPERTY

Constructor Detail

ConfigurationFactory

ConfigurationFactory

ConfigurationFactory

ConfigurationFactory

ConfigurationFactory

ConfigurationFactory

Method Detail

isOffline

toHandlerChainInfo

init

install

install

getOpenEjbConfiguration

getOpenEjbConfiguration

getOpenEjbConfiguration

getModulesFromClassPath

createContainerInfo

loadPropertiesDeclaredConfiguration

fillOpenEjb

toConfigDeclaration

toConfigDeclaration

configureApplication

configureApplication

loadApplication

configureApplication

configureApplication

configureApplication

configureApplication

configureApplication

configureApplication

configureService

configureService

resolveClasspath

configureService

configureService

getSystemProperties

getOverrides

getContainerInfoType

getResourceIds

getResourceIds

getResourceIds

getResourceInfo

isResourceType

getContainerIds

getContainerInfos

sort