jakarta.enterprise.inject.se

Class SeContainerInitializer

java.lang.Object

jakarta.enterprise.inject.se.SeContainerInitializer

public abstract class SeContainerInitializer
extends Object

A CDI container initializer for Java SE. An instance may be obtained by calling newInstance() static method.

Typical usage looks like this:

 SeContainer container = SeContainerInitializer.newInstance().initialize();
 container.select(Foo.class).get();
 container.close();
 

Since SeContainer interface implements AutoCloseable:

 try (SeContainer container = SeContainerInitializer.newInstance().initialize()) {
     container.select(Foo.class).get();
 }
 

By default, the discovery is enabled so that all beans from all discovered bean archives are considered. However, it's possible to define a "synthetic" bean archive, or the set of bean classes and enablement respectively:

 SeContainer container = SeContainerInitializer.newInstance().addBeanClasses(Foo.class, Bar.class).selectAlternatives(Bar.class).initialize());
 

Moreover, it's also possible to disable the discovery completely so that only the "synthetic" bean archive is considered:

 SeContainer container = SeContainerInitializer.newInstance().disableDiscovery().addBeanClasses(Foo.class, Bar.class).initialize());
 

In the same manner, it is possible to explicitly declare interceptors, decorators, extensions and implementation specific options using the builder.

 SeContainerInitializer containerInitializer = SeContainerInitializer.newInstance()
         .disableDiscovery()
         .addPackages(Main.class, Utils.class)
         .enableInterceptors(TransactionalInterceptor.class)
         .addProperty("property", true);
 SeContainer container = container.initialize();
 

Since:

2.0

Author:

Antoine Sabot-Durand, Martin Kouba, John D. Ament

Constructor Summary

Constructors

Constructor and Description
SeContainerInitializer()

Method Summary

Modifier and Type	Method and Description
abstract SeContainerInitializer	addBeanClasses(Class<?>... classes) Add provided bean classes to the synthetic bean archive.
abstract SeContainerInitializer	addExtensions(Class<? extends Extension>... extensions) Add extensions to the set of extensions.
abstract SeContainerInitializer	addExtensions(Extension... extensions) Add extensions to the set of extensions.
abstract SeContainerInitializer	addPackages(boolean scanRecursively, Class<?>... packageClasses) Packages of the specified classes will be scanned and found classes will be added to the set of bean classes for the synthetic bean archive.*
abstract SeContainerInitializer	addPackages(boolean scanRecursively, Package... packages) All classes from the specified packages will be added to the set of bean classes for the synthetic bean archive.
abstract SeContainerInitializer	addPackages(Class<?>... packageClasses) All classes from the packages of the specified classes will be added to the set of bean classes for the synthetic bean archive.
abstract SeContainerInitializer	addPackages(Package... packages) All classes from the specified packages will be added to the set of bean classes for the synthetic bean archive.
abstract SeContainerInitializer	addProperty(String key, Object value) Add a configuration property to the container
abstract SeContainerInitializer	disableDiscovery() By default, the discovery is enabled.
abstract SeContainerInitializer	enableDecorators(Class<?>... decoratorClasses) Add decorator classes to the list of enabled decorators for the synthetic bean archive.
abstract SeContainerInitializer	enableInterceptors(Class<?>... interceptorClasses) Add interceptor classes to the list of enabled interceptors for the synthetic bean archive.
abstract SeContainer	initialize() Initializes a CDI SeContainerInitializer.
static SeContainerInitializer	newInstance() Returns an instance of SeContainerInitializer Each call returns a new instance
abstract SeContainerInitializer	selectAlternatives(Class<?>... alternativeClasses) Add alternatives classes to the list of selected alternatives for the synthetic bean archive.
abstract SeContainerInitializer	selectAlternativeStereotypes(Class<? extends Annotation>... alternativeStereotypeClasses) Add alternative stereotype classes to the list of selected alternative stereotypes for the synthetic bean archive.
abstract SeContainerInitializer	setClassLoader(ClassLoader classLoader) Set a ClassLoader.
abstract SeContainerInitializer	setProperties(Map<String,Object> properties) Set all the configuration properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

SeContainerInitializer

public SeContainerInitializer()

Method Detail

newInstance

public static SeContainerInitializer newInstance()

Returns an instance of SeContainerInitializer Each call returns a new instance

Returns:

a new SeContainerInitializer instance.

Throws:

IllegalStateException - if called in a Java EE container

addBeanClasses

public abstract SeContainerInitializer addBeanClasses(Class<?>... classes)

Add provided bean classes to the synthetic bean archive.

Parameters:

classes - classes to add to the synthetic bean archive

Returns:

self

addPackages

public abstract SeContainerInitializer addPackages(Class<?>... packageClasses)

All classes from the packages of the specified classes will be added to the set of bean classes for the synthetic bean archive.

Note that the scanning possibilities are limited. Therefore, only directories and jar files from the filesystem are supported.

Scanning may also have negative impact on SE performance.

Parameters:

packageClasses - classes whose packages will be added to the synthetic bean archive

Returns:

self

addPackages

public abstract SeContainerInitializer addPackages(boolean scanRecursively,
                                                   Class<?>... packageClasses)

Packages of the specified classes will be scanned and found classes will be added to the set of bean classes for the synthetic bean archive.*

Note that the scanning possibilities are limited. Therefore, only directories and jar files from the filesystem are supported.

Scanning may also have negative impact on SE performance.

Parameters:

scanRecursively - should subpackages be scanned or not

packageClasses - classes whose packages will be scanned

Returns:

self

addPackages

public abstract SeContainerInitializer addPackages(Package... packages)

All classes from the specified packages will be added to the set of bean classes for the synthetic bean archive.

Note that the scanning possibilities are limited. Therefore, only directories and jar files from the filesystem are supported.

Scanning may also have negative impact on SE performance.

Parameters:

packages - packages that will be added to the synthetic bean archive

Returns:

self

addPackages

public abstract SeContainerInitializer addPackages(boolean scanRecursively,
                                                   Package... packages)

All classes from the specified packages will be added to the set of bean classes for the synthetic bean archive.

Note that the scanning possibilities are limited. Therefore, only directories and jar files from the filesystem are supported.

Scanning may also have negative impact on SE performance.

Parameters:

scanRecursively - should subpackages be scanned or not

packages - packages that will be added to the synthetic bean archive

Returns:

self

addExtensions

public abstract SeContainerInitializer addExtensions(Extension... extensions)

Add extensions to the set of extensions.

Parameters:

extensions - extensions to use in the container

Returns:

self

addExtensions

public abstract SeContainerInitializer addExtensions(Class<? extends Extension>... extensions)

Add extensions to the set of extensions.

Parameters:

extensions - extensions class to use in the container

Returns:

self

enableInterceptors

public abstract SeContainerInitializer enableInterceptors(Class<?>... interceptorClasses)

Add interceptor classes to the list of enabled interceptors for the synthetic bean archive.

This method does not add any class to the set of bean classes of the synthetic bean archive.

Parameters:

interceptorClasses - classes of the interceptors to enable.

Returns:

self

enableDecorators

public abstract SeContainerInitializer enableDecorators(Class<?>... decoratorClasses)

Add decorator classes to the list of enabled decorators for the synthetic bean archive.

This method does not add any class to the set of bean classes of the synthetic bean archive.

Parameters:

decoratorClasses - classes of the decorators to enable.

Returns:

self

selectAlternatives

public abstract SeContainerInitializer selectAlternatives(Class<?>... alternativeClasses)

Add alternatives classes to the list of selected alternatives for the synthetic bean archive.

This method does not add any class to the set of bean classes of the synthetic bean archive.

Parameters:

alternativeClasses - classes of the alternatives to select

Returns:

self

selectAlternativeStereotypes

public abstract SeContainerInitializer selectAlternativeStereotypes(Class<? extends Annotation>... alternativeStereotypeClasses)

Add alternative stereotype classes to the list of selected alternative stereotypes for the synthetic bean archive.

This method does not add any class to the set of bean classes of the synthetic bean archive.

Parameters:

alternativeStereotypeClasses - alternatives stereotypes to select

Returns:

self

addProperty

public abstract SeContainerInitializer addProperty(String key,
                                                   Object value)

Add a configuration property to the container

Parameters:

key - property name

value - property value

Returns:

self

setProperties

public abstract SeContainerInitializer setProperties(Map<String,Object> properties)

Set all the configuration properties. Erase previous properties set

Parameters:

properties - a map containing properties to add

Returns:

self

disableDiscovery

public abstract SeContainerInitializer disableDiscovery()

By default, the discovery is enabled. However, it's possible to disable the discovery completely so that only the "synthetic" bean archive is considered.

Returns:

self

setClassLoader

public abstract SeContainerInitializer setClassLoader(ClassLoader classLoader)

Set a ClassLoader. The given ClassLoader will be scanned automatically for bean archives if scanning is enabled.

Parameters:

classLoader - the class loader to use

Returns:

self

initialize

public abstract SeContainer initialize()

Initializes a CDI SeContainerInitializer.

Cannot be called within an application server.

Returns:

the SeContainer instance associated with the container.

Throws:

UnsupportedOperationException - if called within an application server