← Back to ProjectsView Architecture

Camel Migrator 2.0#

Project Identity and Purpose##

Camel Migrator 2.0 is a JavaFX desktop application designed to automate the migration of Apache Camel configurations from version 2.x to 4.x. The project specifically targets Apache Camel 4.4.0 compliance and handles both XML configurations and Java source code modifications.

Technical Architecture##

Core Technology Stack###

  • Primary Language: Java 17
  • UI Framework: JavaFX 17.0.1
  • Build System: Maven with multiple specialized plugins
  • Secondary Language: Python (for XML processing logic)
  • XML Processing: LXML library with XSD schema validation
  • Java Code Analysis: JavaParser 3.26.1 for AST manipulation

Project Structure###

txt

Functional Capabilities##

XML Migration Features###

  1. Schema Validation: Validates XML files against Camel 4.4.0 XSD schema
  2. Automatic Corrections: Applies predefined correction rules for common migration issues
  3. Intelligent Commenting: Comments out non-compliant elements while preserving structure
  4. Route Separation: Separates REST and Route configurations into distinct files
  5. Batch Processing: Handles multiple files simultaneously
  6. Change Logging: Generates detailed logs of all modifications made

Java Code Modernization Features###

  1. Import Statement Updates: Maps legacy package imports to new locations (javax.→ jakarta.)
  2. Annotation Modernization: Converts Swagger v2 annotations to OpenAPI v3 annotations
  3. Code Pattern Refactoring: Updates deprecated method calls and patterns
  4. AST-based Processing: Uses JavaParser for precise code analysis and modification

User Interface Design##

Three-Tab Interface Architecture###

  1. Modify XML Tab: Configuration for XML file processing
  2. Modify Java Tab: Configuration for Java code modifications
  3. Console Tab: Real-time process logging and output display

Configuration Options###

  • Project Directory Selection: Source directory containing Camel files
  • Output Directory Selection: Destination for processed files
  • Structure Preservation: Option to maintain original folder hierarchy
  • Plugin Integration: Special handling for plugin-based configurations
  • Configuration Type: SFO (San Francisco Office) vs AO (Austin Office) specific processing
  • Selective Processing: Independent toggles for imports, annotations, and code snippets

Processing Workflows##

XML Processing Workflow###

  1. File discovery using glob patterns (-rest.xml,-routes.xml)
  2. Python script execution with schema validation
  3. Application of correction rules and transformations
  4. Separation of REST and Route configurations
  5. Generation of change logs and validation reports
  6. File output with preserved or restructured hierarchy

Java Processing Workflow###

  1. Recursive traversal of Java source files under src/ directory
  2. AST parsing using JavaParser with Java 17 language level
  3. Application of import mappings, annotation updates, and code transformations
  4. Lexical preservation during modifications
  5. File replacement with updated content
  6. Logging of all modifications made

Import Mapping Rules##

The system maintains comprehensive mapping tables for:

  • Jakarta Migration: javax.validation.→ jakarta.validation.
  • Camel Package Restructuring: org.apache.camel.impl.→ org.apache.camel.support.
  • HTTP Client Updates: Apache HttpComponents 4.x → 5.x API changes
  • Swagger Migration: io.swagger.annotations.→ io.swagger.v3.oas.annotations.

Code Pattern Transformations##

Automated refactoring includes:

  • Route definition management API changes
  • Exchange property handling updates
  • JSON data format configuration modernization
  • HTTP response status code access patterns
  • Stream collection method updates (Collectors.toList() → Stream.toList())

Dependencies and Libraries##

  • JavaFX Components: Controls, FXML for UI framework
  • Apache Commons IO: File system operations
  • JAXB: XML binding and processing
  • Xerces: XML parsing and validation
  • SLF4J: Logging framework
  • JavaParser: Java source code analysis and manipulation

Build Configuration##

  • Maven Shade Plugin: Creates executable JAR with all dependencies
  • JavaFX Maven Plugin: Handles JavaFX-specific build requirements
  • Resource Processing: Includes Python scripts and XSD files in final artifact
  • Module System: Uses Java Platform Module System (JPMS)

File Processing Capabilities##

  • Input Patterns: Handles -rest.xml and-routes.xml file patterns
  • Output Structure: Creates separate directories for REST, routes, change logs, and validations
  • Duplicate Detection: Identifies and reports duplicate file names across directories
  • Error Handling: Comprehensive error logging and validation reporting
  • Encoding: UTF-8 encoding for all file operations

Validation and Quality Assurance##

  • XSD Schema Compliance: All XML outputs validated against Camel 4.4.0 schema
  • Modification Tracking: Complete audit trail of all changes made
  • Error Context: Provides surrounding code context for validation errors
  • File Statistics: Reports number of files processed and modified
  • Interface Skipping: Automatically skips Java interface files during processing

Runtime Environment Requirements##

  • Java Version: Java 17 runtime environment
  • Python Dependency: Python interpreter with LXML library for XML processing
  • Memory Requirements: Suitable for processing large codebases with multiple files
  • File System Access: Read/write permissions for source and destination directories

This project represents a comprehensive migration tool that combines JavaFX desktop application development with sophisticated code analysis and transformation capabilities, specifically tailored for Apache Camel framework modernization.

Architecture Diagram

Drag to pan, scroll to zoom