cdi-alternative: Demonstrates CDI Alternatives

Author: Nevin Zhu
Level: Intermediate
Technologies: CDI, Servlet, JSP
Summary: The cdi-alternative quickstart demonstrates how to create a bean that can be implemented for different purposes without changing the source code.
Target Product: WildFly
Source: https://github.com/wildfly/quickstart/

What is it?

The cdi-alternative quickstart demonstrates how to create beans that can be implemented for different purposes in WildFly Application Server without changing the Java source code. Instead, you define the default and alternative (@Alternative) bean implementations during the development phase. Then at deployment time, rather than modifying the source code, you can choose to deploy the default or alternative beans by modifying the <alternatives> element in the WEB-INF/beans.xml file.

Alternatives can be used to customize deployments for specific situations, to handle client-side business logic that is determined at runtime, and to create dummy beans to be used for test purposes.

This quickstart demonstrates how to deploy an example with alternative sales tax rates. It defines the following classes, interfaces, and WEB-INF/beans.xml files:

System Requirements

The application this project produces is designed to be run on WildFly Application Server 11 or later.

All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See Configure Maven for WildFly 11 to make sure you are configured correctly for testing the quickstarts.

Use of WILDFLY_HOME

In the following instructions, replace WILDFLY_HOME with the actual path to your WildFly installation. The installation path is described in detail here: Use of WILDFLY_HOME and JBOSS_HOME Variables.

Start the Server

  1. Open a command prompt and navigate to the root of the WildFly directory.
  2. The following shows the command line to start the server:
    For Linux:   WILDFLY_HOME/bin/standalone.sh
    For Windows: WILDFLY_HOME\bin\standalone.bat
    

Build and Deploy the Quickstart

  1. Make sure you have started the WildFly server as described above.
  2. Open a command prompt and navigate to the root directory of this quickstart.
  3. Type this command to build and deploy the archive:
    mvn clean install wildfly:deploy
    
  4. This deploys target/cdi-alternative.war to the running instance of the server.

Access the Application

The application will be running at the following URL: http://localhost:8080/cdi-alternative/.

You can specify alternative versions of the bean in the WEB-INF/beans.xml file by doing one of the following:

  1. You can remove the <alternatives> tag so that it defaults to use TaxImpl_1.
  2. You can create another alternative bean class and use that class name as an alternative.

In this quickstart, in order to switch back to the default implementation, comment the <alternatives> block in the WEB-INF/beans.xml file and redeploy the quickstart.

Undeploy the Archive

  1. Make sure you have started the WildFly server as described above.
  2. Open a command prompt and navigate to the root directory of this quickstart.
  3. When you are finished testing, type this command to undeploy the archive:
    mvn wildfly:undeploy
    

Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse

You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a WildFly server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.

Debug the Application

If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.

mvn dependency:sources