feat: Javadoc for server-common integration points

[kabir]

Fixes #477 🦕

[gemini-code-assist]

Summary of Changes

Hello @kabir, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on significantly improving the developer experience by thoroughly documenting critical components of the server-common module. By adding extensive Javadoc to core integration points, it provides clear guidance on how to interact with and extend the server's functionalities, making it easier for developers to understand, use, and contribute to the codebase.

Highlights

• Enhanced Documentation: Comprehensive Javadoc has been added to key interfaces and classes within the server-common module, including AgentExecutor, RequestContext, QueueManager, DefaultRequestHandler, PushNotificationConfigStore, PushNotificationSender, and TaskStore. This significantly improves clarity on their purpose, usage, lifecycle, threading models, and integration patterns.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds comprehensive Javadoc to several core integration points in server-common, including AgentExecutor, RequestContext, QueueManager, DefaultRequestHandler, and various Task related stores. The documentation is well-structured, detailed, and provides valuable context on lifecycle, threading, and extension patterns, which will greatly improve the developer experience.

My review focuses on the accuracy and clarity of the new Javadoc. While the documentation is excellent overall, I've identified a couple of inaccuracies in RequestContext where the Javadoc for getTaskId() and getContextId() incorrectly states that the methods never return null. I've provided suggestions to correct this.