WeldBootstrap (Weld SE (Uber Jar) 2.0.4.Final API)

java.lang.Object
- org.jboss.weld.bootstrap.WeldBootstrap

All Implemented Interfaces:

Bootstrap, CDI11Bootstrap
```
public class WeldBootstrap
extends Object
implements CDI11Bootstrap
```
Common bootstrapping functionality that is run at application startup and detects and register beans

Author:

Pete Muir, Ales Justin

Constructor Summary

Constructors
Constructor and Description

WeldBootstrap()

Constructors
Constructor and Description
`WeldBootstrap()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected Collection<ContextHolder<? extends Context>>`	`createContexts(ServiceRegistry services)`
`Bootstrap`	`deployBeans()` Creates and deploys the application's beans: Creates and deploys the discovered beans Creates and deploys the built-in beans defined by the CDI specification Finally the `AfterBeanDiscovery` is event is fired
`Bootstrap`	`endInitialization()` Cleans up after the initialization
`BeanManagerImpl`	`getManager(BeanDeploymentArchive beanDeploymentArchive)` Get the manager used for this beanDeploymentArchive.
`Iterable<Metadata<Extension>>`	`loadExtensions(ClassLoader classLoader)` Load CDI extensions using the provided ClassLoader
`BeansXml`	`parse(Iterable<URL> urls)` Parse the specified URLs as a series of beans.xml file and merge the result.
`BeansXml`	`parse(Iterable<URL> urls, boolean removeDuplicates)` Parse the specified URLs as a series of beans.xml file and merge the result.
`BeansXml`	`parse(URL url)` Parse the specified URL as a beans.xml file.
`void`	`shutdown()` Causes the container to clean up and shutdown Before the contain is shutdown the `BeforeShutdown` event is fired
`Bootstrap`	`startContainer(Environment environment, Deployment deployment)` Creates the application container: Checks that the services required by the environment have been provided Adds container provided services Creates and initializes the built in contexts Creates the manager context
`TypeDiscoveryConfiguration`	`startExtensions(Iterable<Metadata<Extension>> extensions)` The container bootstrap sequence begins with initializing extensions.
`Bootstrap`	`startInitialization()` Starts the application container initialization process: Reads metadata from beans.xml and the `Deployment` service Starts the application context Starts the request context which lasts until `Bootstrap.endInitialization()` is called Discovers and creates `Extension` service providers Finally, the `BeforeBeanDiscovery` event is fired.
`Bootstrap`	`validateBeans()` Validates the deployment.
`protected static void`	`verifyServices(ServiceRegistry services, Set<Class<? extends Service>> requiredServices)`

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

- Constructor Detail
  - WeldBootstrap
```
public WeldBootstrap()
```
- Method Detail
  - startExtensions
```
public TypeDiscoveryConfiguration startExtensions(Iterable<Metadata<Extension>> extensions)
```
    Description copied from interface: CDI11Bootstrap
    The container bootstrap sequence begins with initializing extensions. The container performs the following actions:
    
    The container fires the BeforeBeanDiscovery event which allows extensions to register scopes. The container combines the registered scopes with scopes associated with the built-in contexts and makes the resulting set available through TypeDiscoveryConfiguration.getKnownBeanDefiningAnnotations()
    
    Afterwards, an EE7-compatible integrator performs type discovery in the following locations:
    - Library jars
    - EJB jars or application client jars
    - The WEB-INF/classes directory of a war
    - Directories in the JVM classpath
    These locations are referred to as available archives hereafter.
    
    Firstly, the integrator discovers every Java annotation annotated with Scope or NormalScope and combines these annotations with the annotations returned from TypeDiscoveryConfiguration.getKnownBeanDefiningAnnotations() . The resulting set is referred to as bean defining annotations hereafter.
    
    Secondly, the integrator processes available archives according to these rules. The rules are exclusive.
    
    If an archive:
    - contains the beans.xml file and the file does not contain the bean-discovery-mode attribute, or
    - contains the beans.xml file and the value of the bean-discovery-mode attribute is set to all
    this archive is an explicit bean archive.
    
    If an archive:
    - contains the beans.xml file and the bean-discovery-mode attribute is set to annotated, or
    - does not contain the beans.xml file nor any implementation of the Extension interface but the archive contains types annotated with a bean defining annotation or session beans
    this archive is an implicit bean archive.
    
    If an archive:
    - contains the beans.xml file and the bean-discovery-mode attribute is set to none, or
    - does not contain the beans.xml file and contains an implementation of the Extension interface, or
    - does not contain the beans.xml file and does not contain any types annotated with a bean defining annotation nor session bean
    this archive is not a bean archive.
    
    For each explicit bean archive the integrator creates an instance of BeanDeploymentArchive representing this archive. The BeanDeploymentArchive.getBeanClasses() method returns a collection of all types present within the archive. Filtering rules defined in BeansXml.getScanning() are not required to be applied by the integrator and are applied later on by Weld. The BeanDeploymentArchive.getEjbs() method returns a collection of EJB descriptors for EJBs present in the archive.
    
    For each implicit bean archive the integrator creates an instance of BeanDeploymentArchive representing this archive. The BeanDeploymentArchive.getBeanClasses() of the bean archive returns all the types found in the archive which are annotated with a bean defining annotations or are Session bean definitions. Filtering rules ( BeansXml.getScanning()) are not required to be applied by the integrator. The BeanDeploymentArchive.getEjbs() method returns a collection of EJB descriptors for Session beans present in the archive.
    
    Initially, the integrator does not need to create a BeanDeploymentArchive instance for an archive which is not a bean archive. Note that although these archives are ignored when building the initial collection of bean archives, the integrator may be required to create a BeanDeploymentArchive later upon a call to Deployment.loadBeanDeploymentArchive(Class). For example, when the method is called for a extension class that is deployed in an archive that is not a bean archive.
    Specified by:
    
    startExtensions in interface CDI11Bootstrap
    
    Parameters:
    extensions - discovered CDI extensions
    
    Returns:
  - startContainer
```
public Bootstrap startContainer(Environment environment,
                       Deployment deployment)
```
    Description copied from interface: Bootstrap
    Creates the application container:
    - Checks that the services required by the environment have been provided
    - Adds container provided services
    - Creates and initializes the built in contexts
    - Creates the manager
    context
    Specified by:
    
    startContainer in interface Bootstrap
    
    Parameters:
    environment - the environment in use, by default Environments.EE
    deployment - the Deployment to be booted
  - getManager
```
public BeanManagerImpl getManager(BeanDeploymentArchive beanDeploymentArchive)
```
    Description copied from interface: Bootstrap
    
    Get the manager used for this beanDeploymentArchive. If #startContainer() has not been called, this method will return null. If the beanDeploymentArchive is not known to Weld (for example, it was not passed to the Weld as part of the Deployment, or has not yet been requested by Deployment.loadBeanDeploymentArchive(Class)), null will be returned.
    
    Specified by:
    
    getManager in interface Bootstrap
    
    Returns:
    the manager or null if not yet available or not found.
  - startInitialization
```
public Bootstrap startInitialization()
```
    Description copied from interface: Bootstrap
    Starts the application container initialization process:
    - Reads metadata from beans.xml and the Deployment service
    - Starts the application context
    - Starts the request context which lasts until Bootstrap.endInitialization() is called
    - Discovers and creates Extension service providers
    Finally, the BeforeBeanDiscovery event is fired.
    Specified by:
    
    startInitialization in interface Bootstrap
  - deployBeans
```
public Bootstrap deployBeans()
```
    Description copied from interface: Bootstrap
    Creates and deploys the application's beans:
    - Creates and deploys the discovered beans
    - Creates and deploys the built-in beans defined by the CDI specification
    Finally the AfterBeanDiscovery is event is fired
    Specified by:
    
    deployBeans in interface Bootstrap
  - validateBeans
```
public Bootstrap validateBeans()
```
    Description copied from interface: Bootstrap
    
    Validates the deployment. After validation, the AfterDeploymentValidation event is fired
    
    Specified by:
    
    validateBeans in interface Bootstrap
  - endInitialization
```
public Bootstrap endInitialization()
```
    Description copied from interface: Bootstrap
    
    Cleans up after the initialization
    
    Specified by:
    
    endInitialization in interface Bootstrap
  - createContexts
```
protected Collection<ContextHolder<? extends Context>> createContexts(ServiceRegistry services)
```
  - shutdown
```
public void shutdown()
```
    Description copied from interface: Bootstrap
    
    Causes the container to clean up and shutdown Before the contain is shutdown the BeforeShutdown event is fired
    
    Specified by:
    
    shutdown in interface Bootstrap
  - verifyServices
```
protected static void verifyServices(ServiceRegistry services,
                  Set<Class<? extends Service>> requiredServices)
```
  - parse
```
public BeansXml parse(Iterable<URL> urls)
```
    Description copied from interface: Bootstrap
    
    Parse the specified URLs as a series of beans.xml file and merge the result. Duplicate entries are not removed.
    
    Specified by:
    
    parse in interface Bootstrap
    
    Returns:
    the BeansXml data structure which represents the URL
  - parse
```
public BeansXml parse(Iterable<URL> urls,
             boolean removeDuplicates)
```
    Description copied from interface: Bootstrap
    
    Parse the specified URLs as a series of beans.xml file and merge the result.
    
    Specified by:
    
    parse in interface Bootstrap
    
    Parameters:
    urls - the urls to parse
    removeDuplicates - whether duplicate entries (alternatives, interceptors, etc) are removed
    
    Returns:
    the BeansXml data structure which represents the URL
  - parse
```
public BeansXml parse(URL url)
```
    Description copied from interface: Bootstrap
    
    Parse the specified URL as a beans.xml file.
    
    Specified by:
    
    parse in interface Bootstrap
    
    Parameters:
    url - the url to parse
    
    Returns:
    the BeansXml data structure which represents the URL
  - loadExtensions
```
public Iterable<Metadata<Extension>> loadExtensions(ClassLoader classLoader)
```
    Description copied from interface: Bootstrap
    
    Load CDI extensions using the provided ClassLoader
    
    Specified by:
    
    loadExtensions in interface Bootstrap
    
    Parameters:
    classLoader - the ClassLoader to use to load the extensions

Class WeldBootstrap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WeldBootstrap

Method Detail

startExtensions

startContainer

getManager

startInitialization

deployBeans

validateBeans

endInitialization

createContexts

shutdown

verifyServices

parse

parse

parse

loadExtensions