Skip to content

Conversation

@GaneshPatil7517
Copy link
Contributor

This PR resolves issue #219 by providing a simpler alternative to using the Shiro Jakarta EE BOM for dependency management.
Users can now include FlowLogix depchain examples directly in their Maven or Gradle projects.

Summary

The FlowLogix dependency chain (com.flowlogix.depchain:shiro-jakarta) bundles all required Shiro Jakarta EE components in a single dependency, eliminating common configuration errors associated with BOM usage.

Included

✔ New documentation page (dependency-chain.adoc) with:

  • Clear Maven and Gradle examples
  • Step-by-step guidance
  • Complete example project
  • Migration instructions from BOM to dependency chain

✔ Updated Jakarta EE documentation (jakarta-ee.adoc) presenting both approaches:

  • FlowLogix dependency chain (recommended)
  • Traditional BOM with individual dependencies

✔ Explanation of benefits over BOM:

  • Single dependency instead of multiple declarations
  • Automatic jakarta classifier configuration
  • Includes all required transitive dependencies
  • Consistent versions across all components

Validation Checklist

✔ Examples compile successfully (verified Maven coordinates against Maven Central)
✔ Documentation matches site style (AsciiDoc format consistent with existing pages)
✔ No build errors
✔ Links between pages are properly configured

References

- Created src/site/content/security-model.adoc with detailed explanation
- Covers trust boundaries, authentication, authorization guarantees
- Includes session management and cryptography security considerations
- Documents operator responsibilities and deployment recommendations
- Follows existing site documentation style and AsciiDoc format
…ache#219)

This commit introduces documentation for the FlowLogix dependency chain
as a simpler alternative to managing Apache Shiro Jakarta EE dependencies
using the traditional BOM approach.

Changes:
- Add dependency-chain.adoc with complete documentation covering:
  - Maven and Gradle configuration examples
  - Comparison with traditional BOM approach
  - Complete example project
  - Migration guide from BOM to dependency chain
- Update jakarta-ee.adoc to reference the dependency chain option
  as the recommended approach alongside existing BOM documentation

The FlowLogix shiro-jakarta dependency chain bundles all required
Shiro Jakarta EE modules (shiro-core, shiro-web, shiro-jakarta-ee,
shiro-cdi, shiro-jaxrs) with the correct jakarta classifier, plus
required dependencies like OmniFaces, in a single dependency.

Resolves: apache#219
@lprimak lprimak merged commit dac7d84 into apache:main Jan 13, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants