Skip to content

Latest commit

 

History

History
107 lines (59 loc) · 6.78 KB

README.md

File metadata and controls

107 lines (59 loc) · 6.78 KB
Raw

cdi-interceptors: Example Using CDI Interceptors

Author: Ievgen Shulga
Level: Intermediate
Technologies: JPA, JSF, EJB
Summary: The cdi-interceptors quickstart demonstrates how to use CDI interceptors for cross-cutting concerns such as logging and simple auditing.
Target Product: JBoss EAP
Source: https://github.com/jbossas/eap-quickstarts/

What is it?

The cdi-interceptors quickstart demonstrates how to use CDI interceptors for cross-cutting concerns such as logging and simple auditing in applications deployed to Red Hat JBoss Enterprise Application Platform. Interceptors can be applied to any business methods or beans, simply by adding appropriate interceptor binding type annotation. The project contains EJB service that can create and retrieve object from database. This example demonstrates 2 interceptors: AuditInterceptor and LoggingInterceptor

The quickstart defines the @Audit and @Logging interceptor binding types. The AuditInterceptor and LoggingInterceptor classes are annotated with the binding type annotation and contain a method annotated @AroundInvoke. If the interceptor is enabled, this method will be called when the intercepted methods are invoked. In the ItemServiceBean bean, notice the create()and getList() methods are annotated with the @Audit and @Logging binding types. This means the aroundInvoke() method in the AuditInterceptor and LoggingInterceptor classes will be called when the ItemServiceBean bean's create() and getList() methods are called, but only if that interceptor is enabled. To enable an interceptor, you must add the interceptor class to the WEB-INF/beans.xml descriptor file.

Note: This quickstart uses the H2 database included with Red Hat JBoss Enterprise Application Platform 7.1. 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 JBoss EAP 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 Red Hat JBoss Enterprise Application Platform.

System Requirements

The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 7.1 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 JBoss EAP 7.1 to make sure you are configured correctly for testing the quickstarts.

Use of EAP7_HOME

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

Start the Server

  1. Open a command prompt and navigate to the root of the JBoss EAP directory.

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

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

Build and Deploy the Quickstart

  1. Make sure you have started the JBoss EAP 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/cdi-interceptors.war to the running instance of the server.

Access the Application

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

You can now comment out classes in the WEB-INF/beans.xml file to disable one or both of the interceptors 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.

In this quickstart, in order to switch back to the default implementation, comment the interceptors 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 JBoss EAP 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 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.

  1. Make sure you have started the JBoss EAP server as described above.

  2. Open a command prompt 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 verify -Parq-remote

You can also let Arquillian manage the JBoss EAP server by using the arq-managed profile. For more information about how to run the Arquillian tests, see Run the Arquillian Tests.

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 JBoss EAP 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