https://github.com/mrts/vaadin-javaee-clinic-patient-queue-example
An example clinic patient queue application using server push, Vaadin 8 and Java EE 8
https://github.com/mrts/vaadin-javaee-clinic-patient-queue-example
cdi jaas javaee jms long-polling message-driven-bean server-push vaadin vaadin-cdi-addon vaadin-loginform vaadin-testbench
Last synced: 5 months ago
JSON representation
An example clinic patient queue application using server push, Vaadin 8 and Java EE 8
- Host: GitHub
- URL: https://github.com/mrts/vaadin-javaee-clinic-patient-queue-example
- Owner: mrts
- License: mit
- Created: 2017-03-27T19:51:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-11-26T15:56:17.000Z (almost 2 years ago)
- Last Synced: 2024-04-24T12:29:26.941Z (over 1 year ago)
- Topics: cdi, jaas, javaee, jms, long-polling, message-driven-bean, server-push, vaadin, vaadin-cdi-addon, vaadin-loginform, vaadin-testbench
- Language: Java
- Homepage:
- Size: 1.21 MB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vaadin-javaee-clinic-patient-queue-example
An example clinic patient queue application using Vaadin 8, Java EE 8 and
Vaadin CDI add-on.
Demonstrates how to use Vaadin's server push and Java EE messaging APIs to send
messages to client browsers in real time. Uses JMS 2.0 API for sending
messages, message-driven beans for receiving them and a separate singleton
broadcaster to broadcast messages to Vaadin UIs (the broadcaster is recommended
by Vaadin as a bridge for connecting message-driven beans and Vaadin UIs that
have different lifetimes).
Also demonstrates how to authenticate and authorize users using JAAS and Vaadin
login form and view navigator.
Vaadin's server push uses a WebSocket connection by default which unfortunately
[is not compatible](https://github.com/vaadin/cdi/issues/88)
[with CDI](https://github.com/eclipse-ee4j/websocket-api/issues/196), so for the time
being a mixed communication mode with WebSocket for server to client and
XMLHttpRequest for client to server must be used with
`@Push(transport = Transport.WEBSOCKET_XHR)`.
Tested with WildFly 18.0.1, but should work equally well with other Java EE 8
application servers.
The project consists of the following modules:
- parent project: common metadata and configuration
- `vaadin-javaee-clinic-patient-queue-example-ui`: main Vaadin application module
- `vaadin-javaee-clinic-patient-queue-example-backend`: backend module, contains server side code and dependencies.
## Building and running
You need Maven and Java 8 JDK to build and run the application.
Build the application WAR with `mvn package`, deploy it from
`vaadin-javaee-clinic-patient-queue-example-ui/target/vaadin-javaee-clinic-patient-queue-example.war`
to the application server.
**Note that you need to run WildFly with full profile to enable JMS:**
bin/standalone.{bat,sh} -c standalone-full.xml
## Overview
The project consists of three apps:
- Registration kiosk app where patients can register to doctor's appointments
- Doctor's office app for doctors to see when patients arrive and call them in
- Infoscreen where patients are notified when doctor calls them in.
If you have Google Chrome installed, you can launch all the apps in parallel
with `launch-apps.sh`.
The following screencast shows the whole workflow in action:
## Testing
1. Open [doctor's office app](http://localhost:8080/vaadin-javaee-clinic-patient-queue-example/doctors-office) in first browser window
2. Login as *user* with password *user* (see *Adding doctors* below), dr. Anu Võsu's office view opens
3. Open [registration kiosk](http://localhost:8080/vaadin-javaee-clinic-patient-queue-example/registration-kiosk) in second browser window
4. Enter your name and press *Register* under dr. Anu Võsu's name to register to her appointment
5. The kiosk will output your call-in number
6. Open [infoscreen](http://localhost:8080/vaadin-javaee-clinic-patient-queue-example/infoscreen) in third browser window
7. Switch to doctor's office app and observe that your registration is visible on the page
8. Select your registration and press *Call in*
9. Switch to infoscreen and observe that your call in number is visible in the list
A Vaadin TestBench test is also included, if you have a TestBench licence and
[Chrome WebDriver](https://sites.google.com/a/chromium.org/chromedriver/downloads)
installed, you can run it with
mvn -Dtest=ClinicPatientQueueAppIT -DfailIfNoTests=false test
Prerequisite is that the application server is running the application in the background.
## Adding doctors
WildFly has a security realm called *ApplicationRealm* configured by default.
To add a new user to *ApplicationRealm* execute the `add-user.{bat,sh}` script
within the `bin` folder of your WildFly installation and enter the requested
information. Choose *b) Application user* and add the user to the group
*users*.
Add user *user* with password *user* for the test to work.
## References
- [Server Push chapter in official Vaadin documentation](https://vaadin.com/docs/-/part/framework/advanced/advanced-push.html)