How oracle/opengrok works
Main modules (nodes)
• opengrok-indexer
• opengrok-web
• suggester
• plugins
• tools
• distribution (assembly, Docker)
• Third-party libraries (Lucene, Jersey/JAX-RS, JFlex, ChronicleMap, various SCM client libs)
• Runtime environment (JVM, Python runtime for tools, Docker container)
Dependencies (directed edges)
• opengrok-web → opengrok-indexer (uses indexer’s search API and configuration classes)
• opengrok-web → plugins (loads authorization plugins at startup)
• opengrok-web → suggester (optional: web’s API/v1/suggester controllers call suggester library)
• suggester → opengrok-indexer (reads Lucene index files produced by indexer)
• plugins → opengrok-web (plugins implement IAuthorizationPlugin interfaces used by web)
• tools → opengrok-indexer (calls Java indexer CLI or REST API to perform indexing)
• tools → opengrok-web (deploys or configures webapp via REST)
• distribution → all Java modules (bundles .war/.jar artifacts into one distribution)
• Docker container (docker/*) → distribution artifacts + Python tools (requires Python runtime)
• All Java modules → JFlex (code generation for analyzers), Lucene (index persistence), SLF4J/log4j (logging)
Architectural patterns and principles
• Maven multi-module project — each subdirectory (opengrok-indexer, opengrok-web, suggester, plugins, tools) is a separate artifact.
• Separation of concerns — indexer (backend indexing/search core), web (REST/UI layer), suggester (suggestion engine), tools (administration scripts).
• Plugin framework — indexer and web load plugins via a classloader; show “plugins” node pointing into both indexer and web.