The payment-cdi-event
quickstart demonstrates how to create credit and debit CDI Events in JBoss EAP, using a JSF front-end client.
What is it?
The payment-cdi-event
quickstart demonstrates how to use CDI Events in Red Hat JBoss Enterprise Application Platform.
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 JBoss EAP 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 thePaymentBean
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 theamount
to$0
and thepaymentOption
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 theinit()
method reinitialize the form values.
-
-
The
events
package contains thePaymentEvent
class and the enumPaymentTypeEnum
. -
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 betweenString
andEnum
. -
The
qualifiers
package contains theCredit
andDebit
interfaces. The annotation determines the operation of the injectingEvent
. -
The
handler
package contains interfaces and implementations ofPaymentEvent
observers. -
ICreditEventObserver
: Interface to listen toCREDIT
event only (@Observes
@Credit
). -
IDebitEventObserver
: Interface to listen toDEBIT
event (@Observes
@Debit
). -
PaymentHandler
: The concrete implementation of the payment handler.-
It implements both
ICreditEventObserver
andIDebitEventObserver
. -
The payment handler exposes the list of events caught during a session (
@Named
name=payments
).
-
-
The
resources
package contains theResources
class that produces the logger for the application.
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 to Build and Deploy the Quickstarts to make sure you are configured correctly for testing the quickstarts.
Use of EAP_HOME
In the following instructions, replace EAP_HOME
with the actual path to your JBoss EAP installation. The installation path is described in detail here: Use of EAP_HOME and JBOSS_HOME Variables.
Start the JBoss EAP Standalone Server
-
Open a terminal and navigate to the root of the JBoss EAP directory.
-
Start the JBoss EAP server with the default profile by typing the following command.
$ EAP_HOME/bin/standalone.sh
NoteFor Windows, use the EAP_HOME\bin\standalone.bat
script.
Build and Deploy the Quickstart
-
Make sure you start the JBoss EAP server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type the following command to build the artifacts.
$ mvn clean package wildfly:deploy
This deploys the payment-cdi-event/target/payment-cdi-event.war
to the running instance of the server.
You should see a message in the server log indicating that the archive deployed successfully.
Access the Application
The application will be running at the following URL: http://localhost:8080/payment-cdi-event/.
Undeploy the Quickstart
When you are finished testing the quickstart, follow these steps to undeploy the archive.
-
Make sure you start the JBoss EAP server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
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 in Red Hat JBoss Developer Studio or 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.
Deploy the Quickstart to OpenShift Online
Use these instructions to deploy the quickstart to Red Hat OpenShift Online. If you do not yet have an OpenShift Online account and are interested in signing up for one, see Choose a Plan in the OpenShift Online documentation located on the Red Hat Customer Portal. For information about running JBoss EAP on Red Hat OpenShift Online, see Getting Started with JBoss EAP for OpenShift Online, also located on the Red Hat Customer Portal.
Create and Deploy the Quickstart Project
Follow these instructions to deploy this quickstart to OpenShift Online.
-
Browse to OpenShift Online console and login with your credentials.
-
On the View All Projects or Welcome to Project page, click Create Project.
-
On the Create Project page, enter the following information:
Name: payment-cdi-event Display Name payment-cdi-event Description: payment-cdi-event
-
Click Create to create the project.
-
On the My Projects page, choose your new payment-cdi-event and click Browse Catalog.
-
Choose JBoss EAP CD (no https) and then click Next to view the Information page.
-
Click Next to navigate to the Configuration page. . . Enter the following information. You can leave the remaining fields as they are.
Add to Project: payment-cdi-event Application Name: payment-cdi-event Custom http Route Hostname: (leave blank) Git Repository URL: https://github.com/jboss-developer/jboss-eap-quickstarts/ Git Reference: openshift Context directory: payment-cdi-event
-
Click the Create button.
-
Click on the Continue to the project overview link.
-
You should see "Build #1 is running …" with the console log below.
Cloning ... Downloading ... Building ... Copying ... Pushing ...
-
At the end of the build, you should see "Push successful".
-
Click View Full Log to see the entire log.
-
-
Click the Overview tab to see the
payment-cdi-event
deployment. -
Click on the application URL on the right side of the page to view the running application. It should be in the following pattern:
http://APPLICATION_NAME-PROJECT_NAME.PORT.HOST.openshiftapps.com
Delete the Quickstart Project
Follow these instructions to delete the project from OpenShift Online.
-
Go to the View All Projects page and select Delete Project from the drop down list to the right of the payment-cdi-event project.
-
Type the name of the project to confirm, and then click Delete
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