payment-cdi-event: Use CDI Events to Process Debit and Credit Operations

Author: Elvadas Nono
Level: Beginner
Technologies: CDI, JSF
Summary: The payment-cdi-event quickstart demonstrates how to create credit and debit CDI Events in ${product.name}, using a JSF front-end client.
Target Product: ${product.name}
Source: <${github.repo.url}>

What is it?

The payment-cdi-event quickstart demonstrates how to use CDI Events in ${product.name.full}.

The JSF front-end client allows you to create both credit and debit operation events.

To test this quickstart, enter an amount, choose either a Credit or Debit operation, and then click on Pay to create the event.

A Session scoped (@SessionScoped) payment event handler catches the operation and produces (@Produces) a named list of all operations performed during this session. The event is logged in the ${product.name} server log and the event list is displayed in a table at the bottom of the form.

The payment-cdi-event quickstart defines the following classes and interfaces:

• The beans package contains the PaymentBean bean class:
  • This is a session scoped bean that stores the payment form information:
    • payment amount
    • operation type: debit or credit
  • It contains the following utility methods:
    • private void init(): This is a PostConstruct (@PostConstruct) method that performs initialization before the class is put into service. It resets the amount to $0 and the paymentOption to the default type of debit.
    • public String pay(): This method processes the operation when the user clicks on submit. We have only one JSF page, so the method does not return anything and the flow of control does not change.
    • public void reset(): Reset calls the init() method reinitialize the form values.
• The events package contains the PaymentEvent class and the enum PaymentTypeEnum.
  • PaymentEvent: We have only one event that handles both credit and debit operations. Qualifiers help us to make the difference at injection point.
  • PaymentTypeEnum: A typesafe enum is used to represent the operation payment type. It contains utility methods to convert between String and Enum.
• The qualifiers package contains the Credit and Debit interfaces. The annotation determines the operation of the injecting Event.
• The handler package contains interfaces and implementations of PaymentEvent observers.
  • ICreditEventObserver: Interface to listen to CREDIT event only (@Observes @Credit).
  • IDebitEventObserver: Interface to listen to DEBIT event (@Observes @Debit).
  • PaymentHandler: The concrete implementation of the payment handler.
    • It implements both ICreditEventObserver and IDebitEventObserver.
    • The payment handler exposes the list of events caught during a session (@Named name=payments).
• The resources package contains the Resources class that produces the logger for the application.

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}/.

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