SeamFramework.orgCommunity Documentation
If you are using JBoss AS 6.0, no additional configuration is required to use Weld (or CDI for that matter).
All you need to do is make your application a bean bean archive by adding META-INF/beans.xml
to the classpath or WEB-INF/beans.xml to the web root!
Additionally, Weld Servlet supports JBoss EAP 5.1, to do this use the jboss5 variant
of Weld Servlet.
Weld is also built into GlassFish from V3 onwards. Since GlassFish V3 is the Java EE 6 reference implementation, it must support all features of CDI. What better way for GlassFish to support these features than to use Weld, the JSR-299 reference implementation? Just package up your CDI application and deploy.
While JSR-299 does not require support for servlet environments, Weld can be used in a servlet container, such as Tomcat 6.0 or Jetty 6.1.
There is a major limitation to using a servlet container. Weld doesn't support deploying session beans,
injection using @EJB or @PersistenceContext, or using transactional
events in servlet containers. For enterprise features such as these, you should really be looking at a Java
EE application server.
Weld can be used as a library in an web application that is deployed to a Servlet container. You should place
weld-servlet.jar within the WEB-INF/lib directory relative to the web
root. weld-servlet.jar is an "uber-jar", meaning it bundles all the bits of Weld and CDI
required for running in a Servlet container, for your convenience. Alternatively, you can use its component
jars. A list of transitive dependencies can be found in the META-INF/DEPENDENCIES.txt file
inside the weld-servlet.jar artifact.
You also need to explicitly specify the servlet listener (used to boot Weld, and control its interaction
with requests) in WEB-INF/web.xml in the web root:
<listener>
<listener-class>org.jboss.weld.environment.servlet.Listener</listener-class>
</listener>
Tomcat has a read-only JNDI, so Weld can't automatically bind the BeanManager extension SPI. To bind
the BeanManager into JNDI, you should populate META-INF/context.xml in the web root with
the following contents:
<Context>
<Resource name="BeanManager"
auth="Container"
type="javax.enterprise.inject.spi.BeanManager"
factory="org.jboss.weld.resources.ManagerObjectFactory"/>
</Context>
and make it available to your deployment by adding this to the bottom of web.xml:
<resource-env-ref>
<resource-env-ref-name>BeanManager</resource-env-ref-name>
<resource-env-ref-type>
javax.enterprise.inject.spi.BeanManager
</resource-env-ref-type>
</resource-env-ref>
Tomcat only allows you to bind entries to java:comp/env, so the BeanManager will be
available at java:comp/env/BeanManager
Weld also supports Servlet injection in Tomcat 6.
Like Tomcat, Jetty has a read-only JNDI, so Weld can't automatically bind the BeanManager. To
bind the BeanManager to JNDI in Jetty 6, you should populate WEB-INF/jetty-env.xml with
the following contents:
<!DOCTYPE Configure PUBLIC "-//Mort Bay Consulting//DTD Configure//EN"
"http://jetty.mortbay.org/configure.dtd">
<Configure id="webAppCtx" class="org.mortbay.jetty.webapp.WebAppContext">
<New id="BeanManager" class="org.mortbay.jetty.plus.naming.Resource">
<Arg><Ref id="webAppCtx"/></Arg>
<Arg>BeanManager</Arg>
<Arg>
<New class="javax.naming.Reference">
<Arg>javax.enterprise.inject.spi.BeanManager</Arg>
<Arg>org.jboss.weld.resources.ManagerObjectFactory</Arg>
<Arg/>
</New>
</Arg>
</New>
</Configure>
Jetty 7 has moved to the Eclipse Foundation; if you are using Jetty 7 put the following in your
WEB-INF/jetty-env.xml:
<!DOCTYPE Configure PUBLIC "-//Mort Bay Consulting//DTD Configure//EN"
"http://www.eclipse.org/jetty/configure.dtd">
<Configure id="webAppCtx" class="org.eclipse.jetty.webapp.WebAppContext">
<New id="BeanManager" class="org.eclipse.jetty.plus.jndi.Resource">
<Arg> <Ref id="webAppCtx"/> </Arg>
<Arg>BeanManager</Arg>
<Arg>
<New class="javax.naming.Reference">
<Arg>javax.enterprise.inject.spi.BeanManager</Arg>
<Arg>org.jboss.weld.resources.ManagerObjectFactory</Arg>
<Arg/>
</New>
</Arg>
</New>
</Configure>
Just like in Tomcat, you need to make it available to your deployment by adding this to the bottom of web.xml:
<resource-env-ref>
<resource-env-ref-name>BeanManager</resource-env-ref-name>
<resource-env-ref-type>
javax.enterprise.inject.spi.BeanManager
</resource-env-ref-type>
</resource-env-ref>
Notice that Jetty doesn't not have built-in support for an javax.naming.spi.ObjectFactory
like Tomcat, so it's necessary to manually create the javax.naming.Reference to wrap
around it.
Jetty only allows you to bind entries to java:comp/env, so the BeanManager will be
available at java:comp/env/BeanManager
Weld also supports Servlet injection in Jetty 6. To enable this, add the file
META-INF/jetty-web.xml with the following content to your war:
<!DOCTYPE Configure PUBLIC "-//Mort Bay Consulting//DTD Configure//EN"
"http://jetty.mortbay.org/configure.dtd">
<Configure id="webAppCtx" class="org.mortbay.jetty.webapp.WebAppContext">
<Call class="org.jboss.weld.environment.jetty.WeldServletHandler" name="process">
<Arg><Ref id="webAppCtx"/></Arg>
</Call>
</Configure>
In addition to improved integration of the Enterprise Java stack, the "Contexts and Dependency Injection for the Java EE platform" specification also defines a state of the art typesafe, stateful dependency injection framework, which can prove useful in a wide range of application types. To help developers take advantage of this, Weld provides a simple means for being executed in the Java Standard Edition (SE) environment independently of any Java EE APIs.
When executing in the SE environment the following features of Weld are available:
Managed beans with @PostConstruct and @PreDestroy
lifecycle callbacks
Dependency injection with qualifiers and alternatives
@Application, @Dependent and
@Singleton scopes
Interceptors and decorators
Stereotypes
Events
Portable extension support
EJB beans are not supported.
Weld provides an extension which will boot a CDI bean manager in Java SE, automatically registering all simple beans found on the classpath. The command line parameters can be injected using either of the following:
@Inject @Parameters List<String> params;
@Inject @Parameters String[] paramsArray;
The second form is useful for compatibility with existing classes.
The command line parameters do not become available for injection until the
ContainerInitialized event is fired. If you need access to the parameters during
initialization you can do so via the
public static String[] getParameters() method in
StartMain.
Here's an example of a simple CDI SE application:
@Singleton
public class HelloWorld
{
public void printHello(@Observes ContainerInitialized event, @Parameters List<String> parameters) {
System.out.println("Hello " + parameters.get(0));
}
}
CDI SE applications can be bootstrapped in the following ways.
Thanks to the power of CDI's typesafe event model, application developers
need not write any bootstrapping code. The Weld SE module comes
with a built-in main method which will bootstrap CDI for you and
then fire a ContainerInitialized event. The entry
point for your application code would therefore be a simple bean which observes
the ContainerInitialized event, as in the previous example.
In this case your application can be started by calling the provided main method like so:
java org.jboss.weld.environment.se.StartMain <args>
For added flexibility, CDI SE also comes with a bootstrap API
which can be called from within your application in order to initialize
CDI and obtain references to your application's beans and events. The
API consists of two classes: Weld and
WeldContainer.
public class Weld
{
/** Boots Weld and creates and returns a WeldContainer instance, through which
* beans and events can be accesed. */
public WeldContainer initialize() {...}
/** Convenience method for shutting down the container. */
public void shutdown() {...}
}
public class WeldContainer
{
/** Provides access to all beans within the application. */
public Instance<Object> instance() {...}
/** Provides access to all events within the application. */
public Event<Object> event() {...}
/** Provides direct access to the BeanManager. */
public BeanManager getBeanManager() {...}
}
Here's an example application main method which uses this API
to initialize a bean of type MyApplicationBean.
public static void main(String[] args) {
WeldContainer weld = new Weld().initialize();
weld.instance().select(MyApplicationBean.class).get();
weld.shutdown();
}
Alternatively the application could be started by firing a custom
event which would then be observed by another simple bean. The following
example fires MyEvent on startup.
public static void main(String[] args) {
WeldContainer weld = new Weld().initialize();
weld.event().select(MyEvent.class).fire( new MyEvent() );
weld.shutdown();
}
In contrast to Java EE applications, Java SE applications place no restrictions
on developers regarding the creation and usage of threads.
Therefore Weld SE provides a custom scope annotation, @ThreadScoped,
and corresponding context implementation which can be used to bind bean instances
to the current thread. It is intended to be used in scenarios where you might otherwise
use ThreadLocal, and does in fact use
ThreadLocal under the hood.
To use the @ThreadScoped annotation you need to enable the RunnableDecorator
which 'listens' for all executions of Runnable.run() and
decorates them by setting up the thread context beforehand, bound to
the current thread, and destroying the context afterwards.
<beans>
<decorators>
<decorator>org.jboss.weld.environment.se.threading.RunnableDecorator</decorator>
</decorator>
</beans>
It is not necessary to use @ThreadScoped in all multithreaded applications. The thread context is not intended as a replacement for defining your own application-specific contexts. It is generally only useful in situtations where you would otherwise have used ThreadLocal directly, which are typically rare.
Weld SE comes packaged as a 'shaded' jar which includes the CDI API,
Weld Core and all dependant classes bundled into a single jar. Therefore the
only Weld jar you need on the classpath, in addition to your application's
classes and dependant jars, is the Weld SE jar. If you are working with a pure
Java SE application you launch using java, this may be simpler
for you.
If you prefer to work with individual dependencies, then you can use the
weld-core jar which just contains the Weld SE classes.
Of course in this mode you will need to assemble the classpath yourself.
This mode is useful, for example, if you wish to use an alternative slf4j
log binding.
If you work with a dependency management solution such as
Maven you can declare a dependency on org.jboss.weld.se:weld-se-core.