Red Hat

Developer Materials

An example of a Portable Extension and some of the APIs / SPIs of CDI

  • Author:
  • Contributors: Sande Gilda, Ron Smeral, Rafael Benevides
  • Last Update: Feb 28, 2014
  • Level: Intermediate
  • Technologies: CDI, DeltaSpike
  • Target Product: WFK

What is it?

This project demonstrates a simple CDI Portable Extension and some of the SPI classes used to complete that task. This particular extension explores ProcessAnnotatedType and interceptor bindings from CDI, and AnnotatedTypeBuilder from DeltaSpike. It demonstrates how to automatically add an interceptor binding to a class based on method parameter annotations.

A Portable Extension is essentially an extension to Java EE which is tailored to a specific use case that will run on any Java EE 6 or higher implementation. This may be something that the specifications don't support just yet, but could be implemented via a portable extension such as type safe messages or external configuration of beans.

The project contains very simple domain model classes, an extension class, the service registration file for that extension and an Arquillian test to verify the extension is working correctly.

It does not contain any user interface, the tests must be run to verify everything is working correctly.

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
    

Run the Arquillian Tests

This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container.

NOTE: The following commands assume you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Run the Arquillian Tests 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 the following command to run the test goal with the following profile activated:

     mvn clean test -Parq-jbossas-remote
    

NOTE: If you use the Maven settings command line argument with this quickstart, you need to pass an additional argument to allow ShrinkWrap Resolver to function properly:

mvn clean test -Parq-jbossas-remote -s /path/to/custom/settings.xml -Dorg.apache.maven.user-settings=/path/to/custom/settings.xml

Run tests from JBDS

To be able to run the tests from JBDS, first set the active Maven profile in project properties to be either 'arq-jbossas-managed' for running on managed server or 'arq-jbossas-remote' for running on remote server.

To run the tests, right click on the project or individual classes and select Run As –> JUnit Test in the context menu.

For more information, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts

Investigate the Console Output

Maven

Maven prints summary of performed tests into the console:

-------------------------------------------------------
T E S T S
-------------------------------------------------------
Running org.jboss.as.quickstart.cdi.extension.test.ParameterLoggerTest
log4j:WARN No appenders could be found for logger (org.jboss.logging).
log4j:WARN Please initialize the log4j system properly.
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 5.032 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

Server log

There is a logging statement when the tests are run:

Example

19:56:12,018 INFO  [org.jboss.as.server.deployment] (MSC service thread 1-4) JBAS015876: Starting deployment of "parameter-logger.war"
19:56:12,261 INFO  [org.jboss.weld.deployer] (MSC service thread 1-1) JBAS016002: Processing weld deployment parameter-logger.war
19:56:12,292 INFO  [org.jboss.weld.deployer] (MSC service thread 1-3) JBAS016005: Starting Services for CDI deployment: parameter-logger.war
19:56:12,297 INFO  [org.jboss.as.osgi] (MSC service thread 1-8) JBAS011907: Register module: Module "deployment.parameter-logger.war:main" from Service Module Loader
19:56:12,298 INFO  [org.jboss.weld.deployer] (MSC service thread 1-2) JBAS016008: Starting weld service for deployment parameter-logger.war
19:56:12,358 INFO  [org.apache.deltaspike.core.util.ClassDeactivationUtils] (MSC service thread 1-2) class: org.apache.deltaspike.core.impl.exclude.extension.ExcludeExtension activated=true
19:56:12,358 INFO  [org.apache.deltaspike.core.util.ClassDeactivationUtils] (MSC service thread 1-2) class: org.apache.deltaspike.core.impl.exclude.GlobalAlternative activated=true
19:56:12,358 INFO  [org.apache.deltaspike.core.util.ClassDeactivationUtils] (MSC service thread 1-2) class: org.apache.deltaspike.core.impl.exclude.CustomProjectStageBeanFilter activated=true
19:56:12,359 INFO  [org.apache.deltaspike.core.util.ClassDeactivationUtils] (MSC service thread 1-2) class: org.apache.deltaspike.core.impl.config.ConfigurationExtension activated=true
19:56:12,359 INFO  [org.apache.deltaspike.core.util.ClassDeactivationUtils] (MSC service thread 1-2) class: org.apache.deltaspike.core.impl.exception.control.extension.ExceptionControlExtension activated=true
19:56:12,359 INFO  [org.apache.deltaspike.core.util.ClassDeactivationUtils] (MSC service thread 1-2) class: org.apache.deltaspike.core.impl.message.MessageBundleExtension activated=true
19:56:12,364 INFO  [org.apache.deltaspike.core.util.ProjectStageProducer] (MSC service thread 1-2) Computed the following DeltaSpike ProjectStage: Production
19:56:12,700 INFO  [org.jboss.web] (MSC service thread 1-1) JBAS018210: Registering web context: /parameter-logger
19:56:12,708 INFO  [org.jboss.as.server] (management-handler-thread - 19) JBAS018559: Deployed "parameter-logger.war"
19:56:13,163 INFO  [org.jboss.as.quickstart.cdi.parameterlogger.model.ParameterLogger] (http-/127.0.0.1:8080-2) Logging parameter value for parameter 1 of method sayHello: Hardy
19:56:13,195 INFO  [org.jboss.as.osgi] (MSC service thread 1-2) JBAS011908: Unregister module: Module "deployment.parameter-logger.war:main" from Service Module Loader
19:56:13,208 INFO  [org.jboss.weld.deployer] (MSC service thread 1-5) JBAS016009: Stopping weld service for deployment parameter-logger.war
19:56:13,229 INFO  [org.jboss.as.server.deployment] (MSC service thread 1-6) JBAS015877: Stopped deployment parameter-logger.war in 36ms
19:56:13,235 INFO  [org.jboss.as.repository] (management-handler-thread - 20) JBAS014901: Content removed from location /Users/pmuir/development/jboss/standalone/data/content/d7/b3a96b69d25b93b0385b7d7fa17524fcd3343b/content
19:56:13,236 INFO  [org.jboss.as.server] (management-handler-thread - 20) JBAS018558: Undeployed "parameter-logger.war"    

The statement to look for is:

19:56:13,163 INFO  [org.jboss.as.quickstart.cdi.parameterlogger.model.ParameterLogger] (http-/127.0.0.1:8080-2) Logging parameter value for parameter 1 of method sayHello: Hardy

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 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
  • 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
  • Jun 7, 2013(Ron Smeral):Allow configuration of custom Maven settings for ShrinkWrap Resolver
  • Jun 4, 2013(Ron Smeral):All DeltaSpike examples now target WFK since SWR will be supported
  • Feb 26, 2013(Rafael Benevides):Removed Target Product from quickstarts that uses ShrinkWrap Maven Resolver
  • Feb 12, 2013(Sande Gilda):Add quickstart source repository of record to the README files
  • Jan 23, 2013(Sande Gilda):Change target product from EAP to WFK
Avg:
Your Rating: