Fix: Update custom user store manager documentation to use Unique ID user store managers for all affected versions (Product IS issue #26513)

[wso2-engineering-bot]

This PR was automatically generated by Claude AI.

• Fixes Mandatory Methods for Unique ID JDBC User Store Managers product-is#26513
• Type: Documentation / Suggestions
• Summary: Updated the custom user store manager documentation to clearly specify that developers should extend Unique ID-based user store manager classes instead of AbstractUserStoreManager directly. Added comprehensive guidance on which classes to extend and updated all references throughout the document.
• Affected Versions: 7.0.0, 7.1.0, 7.2.0, and next (all versions using the shared include file)
• Style Scope Verification: Microsoft Style Guidelines have been applied to newly added content without modifying existing content style.
• Verification: mkdocs build passed successfully

Changes Made

1. Updated introduction section to clearly state that Unique ID-based user store managers should be extended, not AbstractUserStoreManager
2. Added a bulleted list of the four Unique ID user store manager classes with their use cases
3. Added an important note emphasizing not to extend AbstractUserStoreManager directly
4. Updated method descriptions to reference Unique ID user store manager classes instead of AbstractUserStoreManager
5. Updated table headers in the Implementations section for clarity
6. Updated implementation instructions to explicitly mention extending UniqueIDJDBCUserStoreManager

All changes are in the shared include file en/includes/references/extend/user-stores/write-a-custom-user-store-manager.md, which is used by versions 7.0.0, 7.1.0, 7.2.0, and next.

Summary by CodeRabbit

• Documentation
  • Updated user store manager extension guidance to recommend Unique ID-based manager classes instead of generic implementations.
  • Clarified method override requirements and flexibility with updated code samples and examples.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

---

wso2-engineering-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[coderabbitai]

Walkthrough

Documentation updates to a custom user store manager guide that replace references to generic AbstractUserStoreManager with guidance to extend Unique ID-based user store manager classes, including updated code samples, method overrides, and deployment/configuration notes.

Changes

Cohort / File(s)

Summary

Documentation Update en/includes/references/extend/user-stores/write-a-custom-user-store-manager.md

Replaced AbstractUserStoreManager references with Unique ID-based classes (UniqueIDJDBCUserStoreManager, UniqueIDReadOnlyLDAPUserStoreManager, UniqueIDReadWriteLDAPUserStoreManager, UniqueIDActiveDirectoryLDAPUserStoreManager); expanded available methods section; revised method override guidance to allow keeping unused methods empty; updated code samples and class name references; modified deployment/configuration notes to reference UniqueIDJDBCUserStoreManager; updated terminology and table headers throughout.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A rabbit hops through docs so old,
Replacing classes, updating the fold,
From Abstract to Unique ID's gleaming light,
The guidance now shines, precise and bright!
✨📖

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: updating custom user store manager documentation to use Unique ID user store managers instead of AbstractUserStoreManager, covering all affected versions and referencing the issue.
Description check	✅ Passed	The PR description is comprehensive and complete, covering purpose, changes made, affected versions, and verification. However, it lacks the template structure with explicit sections like 'Test environment' and 'Security checks' as defined in the repository's description template.
Linked Issues check	✅ Passed	The PR directly addresses issue #26513 by updating documentation to specify extending Unique ID-based user store manager classes instead of AbstractUserStoreManager, providing clear guidance on which classes to extend and updating all references throughout the documentation.
Out of Scope Changes check	✅ Passed	All changes are within scope as they focus solely on updating documentation in a shared include file to clarify guidance on Unique ID-based user store manager classes, directly addressing the linked issue requirements.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c75a6e2 and 64a8119.

📒 Files selected for processing (1)

• en/includes/references/extend/user-stores/write-a-custom-user-store-manager.md

🔇 Additional comments (4)

en/includes/references/extend/user-stores/write-a-custom-user-store-manager.md (4)

7-24: Clear and actionable guidance on Unique ID-based class selection.

The restructured introduction effectively guides developers to select the appropriate Unique ID class based on their use case, and the revised method selection guidance is practical for both read-write and read-only scenarios.

---

176-189: Effective warning placement and class reference clarity.

The important note prominently directs developers to extend Unique ID classes and provides rationale (enhanced capabilities with unique identifiers). Table header terminology ("When to extend this class") is clearer than the original phrasing and guides selection effectively.

---

350-371: Code sample correctly demonstrates extending Unique ID class.

The example properly extends UniqueIDJDBCUserStoreManager, includes necessary imports, and implements realistic method overrides (password encryption). Constructor delegation and exception handling follow best practices for custom user store managers.

Also applies to: 387-387

---

554-556: Configuration guidance appropriately notes inheritance benefit.

The note correctly explains that extending UniqueIDJDBCUserStoreManager means configuration remains unchanged, reducing deployment friction and providing a clear benefit of extending the specific Unique ID class over generic AbstractUserStoreManager.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}