How chkal/krazo works
Main Components
a) Core MVC Components:
• Controllers Layer (org.eclipse.krazo.core)
• View Engines (org.eclipse.krazo.engine)
• Model Management (org.eclipse.krazo.core.ModelsImpl)
• Binding System (org.eclipse.krazo.binding)
b) Integration Components:
• Jersey Integration (jersey/)
• RESTEasy Integration (resteasy/)
• JAX-RS Integration (org.eclipse.krazo.jaxrs)
c) Security Components:
• CSRF Protection (org.eclipse.krazo.security)
• Form Validation (org.eclipse.krazo.binding.validate)
d) Infrastructure:
• CDI Integration (org.eclipse.krazo.cdi)
• Bootstrap System (org.eclipse.krazo.bootstrap)
• Lifecycle Management (org.eclipse.krazo.lifecycle)
Relationships and Data Flow
[HTTP Request] → [JAX-RS Layer] → [Krazo Core] → [Controller] → [View Engine] → [HTTP Response]
• ↕ ↕ ↕
• [Security Layer] [CDI Layer] [Model Layer]
Specific Implementation Details
a) Request Processing Pipeline:
PreMatchingRequestFilter → PostMatchingRequestFilter → Controller → ViewResponseFilter → ViewableWriter
b) View Resolution Chain:
ViewEngineBase → ViewEngineFinder → Specific View Engine (JSP/Facelets)
Component Relationships
• How the binding system connects to controllers
• How view engines interact with the core
• How security filters integrate into the request pipeline
• How CDI manages component lifecycle
Integration Points
Integration with:
• Jakarta RESTful Web Services
• CDI (Context and Dependency Injection)
• Bean Validation
• Different view technologies (JSP, Facelets)
Cross-Cutting Concerns
How these aspects span multiple components:
• Security (CSRF, validation)
• Locale handling
• Event system
• Configuration management
[Client Layer]
• ↓
[Integration Layer (Jersey/RESTEasy)]
• ↓
[Core MVC Layer]
• ↓
[Infrastructure Layer]
• Component types
• Integration points
Keep the abstraction level high enough to show the overall architecture while including enough detail to understand the component interactions and system boundaries.
• How requests flow through the system
• Where to add new features
• How components interact
• Integration points with external systems
• Security boundaries and implementation
Remember to include version information and any specific server compatibility notes (WildFly, Glassfish, Liberty) as mentioned in the README.