How relic7663/utncoindev-main works
Project type and purpose
• This is a full-stack Jakarta EE web application (“utncoin”) for a university virtual-coin platform.
• Frontend: JSF-based webapp (XHTML pages under src/main/webapp).
• Backend: Jakarta EE modules (Java packages: core, security, audit, project, jakarta).
• Persistence: JPA entities + PostgreSQL (configured in persistence.xml).
• Objectives: attendance tracking, coin issuance, rewards, badges, AAA and audit.
File structure
Top-level folders
• src/main/webapp: UI layer (JSF pages, CSS, images)
• src/main/java packages:
– ec.utncoin.security: authentication/authorization controllers, DTOs, ManagerSecurity
– ec.utncoin.audit: audit controllers, ManagerAudit, AudBitacora entity
– ec.utncoin.core: core business (events, coins, wallets), entities & DAOs
– ec.utncoin.project: project-management controllers, managers
– ec.utncoin.jakarta.hello: sample REST endpoints (HelloApplication)
• src/main/resources/META-INF/persistence.xml: JPA config
• Dockerfile, pom.xml, Maven wrapper: build & deployment artifacts
README for additional insights
• Defines high-level modules: Security (AAA), Events & Attendance, Coin Issuer (bank), Rewards & Badges, Advertising.
• Technology stack: Jakarta EE, PostgreSQL, JSF frontend, JWT recommended.
Main components & relationships
a. User personas (external actors):
• Student, Administrator, Sponsor (Auspiciante)
b. Frontend layer (UI):
• JSF pages (login.xhtml, menu.xhtml, etc.) served by Web Container (e.g., Tomcat/Payara)
• REST endpoints (HelloWorldResource) for potential mobile/web API
c. Backend layer:
• Authentication & Authorization Module (ec.utncoin.security): BeanSegLogin, ManagerSecurity, JWT/token validation
• Audit Module (ec.utncoin.audit): BeanAudBitacora, ManagerAudit, record all critical actions
• Core Business Module (ec.utncoin.core):
• Event & Attendance Manager (entities: EveEvent, EveAttendance, etc.)
• Coin Issuer (entities: BnkTransaction, BnkUserBalance, WallWallet)
• Reward & Badge Manager (RanAchievement, BnkProduct, etc.)
• Project Module (ec.utncoin.project): project/task management (PryProyecto, PryTarea)
• REST API Module (ec.utncoin.jakarta): example JAX-RS endpoints
d. Persistence/Data layer:
• JPA Entities → PostgreSQL DB (tables for users, roles, events, transactions, rewards, audit logs)
e. External services:
• University email/identity provider (for initial login)
• Sponsor systems (for coupon validations, ad campaigns)
• Cloud DB hosting, JWT issuer (if external)
Architectural patterns and principles
• Layered architecture:
• Presentation (JSF pages)
• Controller/Managed Beans (JSF + JAX-RS)
• Service/Manager layer (business logic)
• Repository/DAO (JPA via ManagerDAO)
• Database
• Modularity by functional package (security, audit, core, project)
• AAA (Authentication, Authorization, Auditing) cross-cutting concern
• Use of Jakarta EE standard (CDI, JPA, JSF, JAX-RS) for portability
• Scalability: stateless beans, externalized config (persistence.xml, Dockerfile)
Essential elements to capture
• All five high-level modules (Security, Events/Attendance, Coin Issuer, Rewards/Badges, Advertising)
• JPA persistence as a shared service under all modules
• The audit trail as a cross-cutting component receiving logs from each module
• External identity/email provider for authentication
• Docker container or application server for deployment