# javieryeow/merlionhotelreservation architecture

> Architecture diagram of the GitHub repository javieryeow/merlionhotelreservation, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/javieryeow/merlionhotelreservation
- Repository: https://github.com/javieryeow/merlionhotelreservation

## Overview

##### Project type and purpose
- This is a multi-module Java EE hotel reservation system (“MerlionHotelReservation”) consisting of:
– An EJB application (“MerlionHotelReservation-ejb”) providing business logic and a JAX-WS endpoint.
– A shared library module with JPA entities and remote EJB interfaces.
– Several Java SE application-client modules that drive the system:
- HolidayReservationSystem (core reservation client)
- MerlionHotelManagementClient (back-office client)
- HolidayReservationSystemSeClient (SOAP client for the PartnerWebService)
- MerlionHotelReservationClient (generic Java client)
- The system’s goal is to manage customers, employees, reservations and rooms, expose functionality via EJB session beans and a web service, and allow multiple client UIs to interact.

##### File structure
– Top-level modules under NetBeansProjects/MerlionHotelReservation:
- MerlionHotelReservation-ejb: EJB3.1 session beans, persistence.xml, GlassFish resource setup
- MerlionHotelReservationLibrary: remote interfaces, entity classes, custom exceptions
- HolidayReservationSystem, MerlionHotelManagementClient, MerlionHotelReservationClient: Java SE application-clients with application-client.xml
- HolidayReservationSystemSeClient: JAX-WS client consuming PartnerWebService WSDL
– Build scripts (build.xml) and NetBeans project descriptors (nbproject) in each module
– EJB module exposes both stateless/session beans and a singleton bean; also publishes a JAX-WS web service (PartnerWebService).

##### README
– README is empty (“# orbital”)—no architecture details here. All insights come from the file tree.

##### Main components & their interactions
a. Component list
1) EJB Container (GlassFish) hosting:
- Session Beans (stateless & singleton) implementing business operations (CreateCustomer, RoomSessionBean, AllocatingRoomSessionBean, etc.)
- JAX-WS endpoint (PartnerWebService) wrapping selected session beans
- JPA Persistence layer (persistence.xml → database tables for Customer, Room, Reservation, etc.)
2) Shared Library Module (MERLION-Library) loaded by both EJB and clients – contains:
- Entity classes
- Remote and local EJB interfaces
- Exception definitions
3) Java SE Application-Clients:
- HolidayReservationSystem (invokes remote EJB interfaces over RMI)
- MerlionHotelManagementClient (similar EJB lookups for management tasks)
- MerlionHotelReservationClient (general client stub)
4) SOAP Client (HolidayReservationSystemSeClient) consuming the PartnerWebService WSDL exposed by the EJB module
5) External Database (e.g., MySQL/Derby) holding persistent state
6) (Optionally) External Partner Web Service endpoints if the system invokes outside services

b. Relationships & Data Flow
- Application-Client → EJB Container: remote JNDI lookups → Session Bean methods → JPA → DB
- SOAP Client → HTTP/SOAP → EJB’s PartnerWebService → delegates to Session Beans → JPA → DB
- EJB Container manages transactions, security, and resource pooling

##### Architectural patterns & principles
– Layered architecture: Presentation (clients) → Business (EJB session beans) → Persistence (JPA entities) → Data (DB)
– Service-oriented: JAX-WS web service for integration with partners
– Separation of concerns: Shared library defines contracts (interfaces/entities), EJB module implements them, clients consume them
– Enterprise design patterns:
- Session Façade (stateless beans group business calls)
- Singleton Session Bean for application-wide data caching (DataInSessionBean)
- Service Locator pattern in clients for JNDI lookups

##### Essential elements
- Clear labels on all components and interfaces
- Optional: list of major technologies near each component (EJB 3.1, JPA, JAX-WS, Java SE)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients Layer
    subgraph "Java SE Application Clients" 
        direction TB
        HRS["HolidayReservationSystem"]:::clients
        MHMC["MerlionHotelManagementClient"]:::clients
        MHRC["MerlionHotelReservationClient"]:::clients
        HRSec["HolidayReservationSystemSeClient"]:::clients
    end

    %% Shared Library
    ML["MerlionHotelReservationLibrary (JAR)"]:::library

    %% EJB Container
    subgraph "GlassFish EJB Container" 
        direction TB
        SL["Stateless Session Beans"]:::ejb
        SB["Singleton Session Bean"]:::ejb
        WS["PartnerWebService (JAX-WS)"]:::ejb
        PU["JPA Persistence Unit"]:::persistence
    end

    %% Database
    DB[(Database)]:::database

    %% External Services
    EW[(External Partner Web Service)]:::external

    %% Relationships
    HRS -->|RMI/JNDI| SL
    MHMC -->|RMI/JNDI| SL
    MHRC -->|RMI/JNDI| SL
    HRSec -->|SOAP over HTTP| WS
    SL -->|uses| PU
    SB -->|uses| PU
    WS -->|delegates| SL
    PU -->|JDBC| DB
    WS -->|may call| EW
    ML --> SL
    ML --> HRS
    ML --> MHMC
    ML --> MHRC
    ML --> HRSec

    %% Click Events - Clients
    click HRS "https://github.com/javieryeow/merlionhotelreservation/tree/main/NetBeansProjects/MerlionHotelReservation/HolidayReservationSystem"
    click MHMC "https://github.com/javieryeow/merlionhotelreservation/tree/main/NetBeansProjects/MerlionHotelReservation/MerlionHotelManagementClient"
    click MHRC "https://github.com/javieryeow/merlionhotelreservation/tree/main/NetBeansProjects/MerlionHotelReservation/MerlionHotelReservationClient"
    click HRSec "https://github.com/javieryeow/merlionhotelreservation/tree/main/NetBeansProjects/MerlionHotelReservation/HolidayReservationSystemSeClient"

    %% Click Events - Shared Library
    click ML "https://github.com/javieryeow/merlionhotelreservation/tree/main/NetBeansProjects/MerlionHotelReservation/MerlionHotelReservationLibrary"
    click ML "https://github.com/javieryeow/merlionhotelreservation/tree/main/NetBeansProjects/MerlionHotelReservation/MerlionHotelReservationLibrary/src/ejb/session/stateless"
    click ML "https://github.com/javieryeow/merlionhotelreservation/tree/main/NetBeansProjects/MerlionHotelReservation/MerlionHotelReservationLibrary/src/entity"
    click ML "https://github.com/javieryeow/merlionhotelreservation/tree/main/NetBeansProjects/MerlionHotelReservation/MerlionHotelReservationLibrary/src/util/exception"

    %% Click Events - EJB Module
    click SL "https://github.com/javieryeow/merlionhotelreservation/tree/main/NetBeansProjects/MerlionHotelReservation/MerlionHotelReservation-ejb/src/java/ejb/session/stateless"
    click SB "https://github.com/javieryeow/merlionhotelreservation/blob/main/NetBeansProjects/MerlionHotelReservation/MerlionHotelReservation-ejb/src/java/ejb/session/singleton/DataInSessionBean.java"
    click WS "https://github.com/javieryeow/merlionhotelreservation/blob/main/NetBeansProjects/MerlionHotelReservation/MerlionHotelReservation-ejb/src/java/ejb/session/ws/PartnerWebService.java"
    click PU "https://github.com/javieryeow/merlionhotelreservation/blob/main/NetBeansProjects/MerlionHotelReservation/MerlionHotelReservation-ejb/src/conf/persistence.xml"
    click PU "https://github.com/javieryeow/merlionhotelreservation/blob/main/NetBeansProjects/MerlionHotelReservation/MerlionHotelReservation-ejb/setup/glassfish-resources.xml"

    %% Click Events - SOAP Client details
    click HRSec "https://github.com/javieryeow/merlionhotelreservation/blob/main/NetBeansProjects/MerlionHotelReservation/HolidayReservationSystemSeClient/src/holidayreservationsystemseclient/HolidayReservationSystemSeClient.java"
    click HRSec "https://github.com/javieryeow/merlionhotelreservation/blob/main/NetBeansProjects/MerlionHotelReservation/HolidayReservationSystemSeClient/xml-resources/web-service-references/PartnerWebService/wsdl/localhost_8080/PartnerWebService/PartnerWebService.wsdl"
    click HRSec "https://github.com/javieryeow/merlionhotelreservation/blob/main/NetBeansProjects/MerlionHotelReservation/HolidayReservationSystemSeClient/src/META-INF/jax-ws-catalog.xml"

    %% Styles
    classDef clients fill:#AED6F1,stroke:#3498DB,color:#1B4F72
    classDef library fill:#D5DBDB,stroke:#808B96,color:#1B2631
    classDef ejb fill:#ABEBC6,stroke:#27AE60,color:#145A32
    classDef persistence fill:#F9E79F,stroke:#F1C40F,color:#7D6608
    classDef database fill:#F5CBA7,stroke:#CD6155,color:#641E16
    classDef external fill:#E8DAEF,stroke:#8E44AD,color:#4A235A
```
