Red Hat

Developer Materials

Demonstrate usage of DeltaSpike project stage and shows usage of a conditional @Exclude

  • Author:
  • Contributors: Sande Gilda, Ron Smeral
  • Last Update: Feb 28, 2014
  • Level: Beginner
  • Technologies: JSF, CDI, Deltaspike
  • Target Product: WFK

What is it?

Project stages provide a way to customize the implementation based on the type of deployment environment. For example, you may want to generate sample data for system testing, but not for production. You can create a bean that generates sample data and activate it only for project stage SystemTest

Besides custom project stages it's possible to use the following pre-defined project stages:

  • UnitTest
  • Development
  • SystemTest
  • IntegrationTest
  • Staging
  • Production

Furthermore, with @Exclude, it is possible to annotate beans which should be ignored by CDI, even if they are in a CDI enabled archive.

This project has a interface called MyBean that has 4 different implementations:

  • ExcludedExceptOnDevelopment - Uses the annotation @Exclude(exceptIfProjectStage=Development.class) to exclude the implementation if the project stage is anything other than Development..
  • ExcludedOnDevelopment - Uses the annotation @Exclude(ifProjectStage=Development.class) to exclude the implementation for project stage Development.
  • MyExcludedBean - Uses the annotation @Exclude to exclude the implementation for all project stages.
  • NoExcludedBean - The implementation is always available because this bean does not use any annotation.

System requirements

The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform (EAP) 6.1 or later with the Red Hat JBoss Web Framework Kit (WFK) 2.5.

All you need to build this project is Java 6.0 (Java SDK 1.6) or later, Maven 3.0 or later.

Configure Maven

If you have not yet done so, you must Configure Maven before testing the quickstarts.

Start the JBoss EAP Server

  1. Open a command line and navigate to the root of the JBoss EAP directory.
  2. The following shows the command line to start the server with the default profile:

     For Linux:   JBOSS_HOME/bin/standalone.sh
     For Windows: JBOSS_HOME\bin\standalone.bat
    

Build and Deploy the Quickstart

NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Build and Deploy the Quickstarts for complete instructions and additional options.

  1. Make sure you have started the JBoss EAP server as described above.
  2. Open a command line and navigate to the root directory of this quickstart.
  3. Type this command to build and deploy the archive:

     mvn clean package jboss-as:deploy
    
  4. This will deploy target/jboss-deltaspike-projectstage.war to the running instance of the server.

Access the application

Access the running application in a browser at the following URL: http://localhost:8080/jboss-deltaspike-projectstage

You be presented with a simple page that shows the current project stage: Staging. You will se also the List of available CDI instances for MyBean table with two available implementations.

Edit the file src/main/resources/META-INF/apache-deltaspike.properties and change the org.apache.deltaspike.ProjectStage property to Development. Deploy the application again

    mvn clean package jboss-as:deploy

Access the application again at the same URL: http://localhost:8080/jboss-deltaspike-projectstage

Look at List of available CDI instances for MyBean table and realize that the available implementations has changed.

Undeploy the Archive

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

     mvn jboss-as:undeploy
    

Run the Arquillian Functional Tests

This quickstart provides Arquillian functional tests. They are located under the directory "functional-tests". Functional tests verify that your application behaves correctly from the user's point of view - simulating clicking around the page as a normal user would do.

To run these tests, you must build the main project as described above.

  1. Open a command line and navigate to the root directory of this quickstart.
  2. Build the quickstart WAR using the following command:

     mvn clean package
    
  3. Navigate to the functional-tests/ directory in this quickstart.
  4. If you have a running instance of the JBoss EAP server, as described above, run the remote tests by typing the following command:

     mvn clean verify -Parq-jbossas-remote
    
  5. If you prefer to run the functional tests using managed instance of the JBoss EAP server, meaning the tests will start the server for you, type the following command:

NOTE: For this to work, Arquillian needs to know the location of the JBoss EAP server. This can be declared through the JBOSS_HOME environment variable or the jbossHome property in arquillian.xml. See Run the Arquillian Tests for complete instructions and additional options.

    mvn clean verify -Parq-jbossas-managed

Run the Quickstart in JBoss Developer Studio or Eclipse

You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts

Debug the Application

If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.

mvn dependency:sources
mvn dependency:resolve -Dclassifier=javadoc

Recent Changelog

  • Feb 28, 2014(Sande Gilda):Edits to README files to render metadata correctly and to use the correct term for JBoss EAP
  • Feb 17, 2014(Sande Gilda):JDF 614 Update WFK version from 2.4 to 2.5
  • Oct 4, 2013(Ron Smeral):Added note about JBOSS_HOME configuration for arq managed container typo fix
  • Sep 23, 2013(Ron Smeral):Updated READMEs for functional tests of DeltaSpike QS
  • Oct 2, 2013(Sande Gilda):JDF 503 Remove AS 7 references add versions general cleanup remove temp repo from settings
  • Sep 23, 2013(Sande Gilda):Update metadata source URLs to new repository
  • Sep 13, 2013(Sande Gilda):JDF 487 Remove as from quickstart artifactId and archive names and access URLs in README files
  • Jun 12, 2013(Sande Gilda):Modify README file internal links to use generated anchors. Remove hard coded anchors. Fixed obsolete links and other markdown rendering problems
  • Feb 12, 2013(Sande Gilda):Add quickstart source repository of record to the README files
  • Jan 3, 2013(Rafael Benevides):Changed project stage to project stage and other changes
Avg:
Your Rating: