cdi-stereotype: Example Using CDI Stereotype.

Author: Ievgen Shulga
Level: Intermediate
Technologies: JPA, JSF, EJB
Summary: The cdi-stereotype quickstart demonstrates how to apply CDI stereotypes to beans to encapsulate CDI interceptor bindings and CDI alternatives.
Target Product: ${product.name}
Source: <${github.repo.url}>

What is it?

The cdi-stereotype quickstart is an extension of the cdi-interceptors quickstart and demonstrates how to use a CDI stereotype in ${product.name.full}.

A stereotype is an annotation, annotated @Stereotype, that packages several other annotations. Stereotypes allow a developer to declare common metadata for beans in a central place.

In this example, the stereotype encapsulates the following :

• All beans with this stereotype inherit the following interceptor bindings: @Logging and @Audit
• All beans with this stereotype are alternatives

This quickstart defines stereotype with 2 interceptors bindings (@Logging and @Audit) to be inherited by all beans with that stereotype. It also indicates that all beans to which it is applied are @Alternatives. An alternative stereotype lets us classify beans by deployment scenario. Arquillian tests added in cdi-interceptors quickstart.

Note: This quickstart uses the H2 database included with ${product.name.full} ${product.version}. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment!

Note: This quickstart uses a *-ds.xml datasource configuration file for convenience and ease of database configuration. These files are deprecated in ${product.name} and should not be used in a production environment. Instead, you should configure the datasource using the Management CLI or Management Console. Datasource configuration is documented in the Configuration Guide for ${product.name.full}.

System Requirements

The application this project produces is designed to be run on ${product.name.full} ${product.version} or later.

All you need to build this project is ${build.requirements}. See Configure Maven for ${product.name} ${product.version} to make sure you are configured correctly for testing the quickstarts.

Use of ${jboss.home.name}

In the following instructions, replace ${jboss.home.name} with the actual path to your ${product.name} installation. The installation path is described in detail here: Use of ${jboss.home.name} and JBOSS_HOME Variables.

Start the ${product.name} Server

1. Open a command prompt and navigate to the root of the ${product.name} directory.

2. The following shows the command line to start the server:

    For Linux:   ${jboss.home.name}/bin/standalone.sh
    For Windows: ${jboss.home.name}\bin\standalone.bat
   

Build and Deploy the Quickstart

1. Make sure you have started the ${product.name} 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 will deploy target/${project.artifactId}.war to the running instance of the server.

Access the Application

The application will be running at the following URL http://localhost:8080/${project.artifactId}/

You can now comment out classes in the WEB-INF/beans.xml file to disable one or both of the interceptors or alternative stereotype and view the results.

• Comment the <class>org.jboss.as.quickstarts.cdi.interceptor.AuditInterceptor</class> and you will no longer see the audit history on the browser page.
• Comment the <class>org.jboss.as.quickstarts.cdi.interceptor.LoggingInterceptor</class> and you will no longer see the log messages in the server log.
• Comment the <stereotype>org.jboss.as.quickstarts.cdi.interceptor.ServiceStereotype</stereotype> and you no longer see ItemAlternativeServiceBean implementation invoked.

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

Server Log: Expected Warnings and Errors

Note: You will see the following warnings in the server log. You can ignore these warnings.

WFLYJCA0091: -ds.xml file deployments are deprecated. Support may be removed in a future version.

HHH000431: Unable to determine H2 database version, certain features may not work

Undeploy the Archive

1. Make sure you have started the ${product.name} 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 ${product.name} 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