Skip to content

Conversation

@b-long
Copy link
Contributor

@b-long b-long commented Jul 16, 2025

The rendered page for Creating TDF's , with the heading "Encrypting / Decrypting zTDF" is here:

You'll notice, on that page, that the Go example is much more approachable and provides friendly output to the user about the status of work being performed.

This PR is meant to update the Java & TypeScript code sample to be just as approachable.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @b-long, I'm Gemini Code Assist1! 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 updating the Java code sample within the encryption_ztdf.mdx documentation file. The primary intent is to modernize the usage of the Java SDK for TDF encryption and decryption, bringing it into closer alignment with the patterns and best practices observed in the Go-lang examples. The changes streamline the API interactions, enhance the clarity of the demonstration, and improve the overall robustness of the provided code snippet.

Highlights

  • Java SDK Modernization: The Java code sample has been updated to utilize a more modern and simplified SDK API for encryption and decryption operations, specifically for createTDF and loadTDF methods.
  • Improved Example Flow: The example now demonstrates a complete encrypt-then-decrypt cycle within the same main method, leveraging in-memory streams for initial encryption and temporary files for subsequent decryption, providing a clearer and more robust demonstration.
  • Enhanced Readability and Debugging: Informative System.out.println statements have been added throughout the Java code to provide better logging and clarity on the execution flow. Unused imports and complex exception declarations were also removed to simplify the code.
  • Configuration Alignment: The platformEndpoint now explicitly includes the http:// scheme, and the kasInfo.URL is dynamically constructed based on this endpoint, improving consistency and adaptability.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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 is currently in preview and 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 to provide feedback.

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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the Java code sample for TDF encryption to be more comprehensive, including both encryption and decryption steps. The review identifies several areas for improvement in the new Java code, focusing on adherence to Java conventions, code clarity, and robust resource management.

@jp-ayyappan
Copy link
Contributor

@b-long Can you please review the code review from the bot and make changes as needed?

@b-long b-long force-pushed the chore/dspx-1442--update-java-and-ts-docs branch 2 times, most recently from 71dc9ed to 3fede04 Compare August 11, 2025 18:32
@b-long b-long marked this pull request as ready for review August 11, 2025 19:17
@b-long b-long requested a review from a team as a code owner August 11, 2025 19:17
@b-long b-long requested a review from jp-ayyappan August 11, 2025 19:20
@b-long b-long enabled auto-merge (squash) August 11, 2025 19:27
Copy link
Contributor

@jentfoo jentfoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commits need to be cherry-picked due to main squash

@b-long b-long force-pushed the chore/dspx-1442--update-java-and-ts-docs branch from 0b0f74e to f947818 Compare August 12, 2025 18:57
@b-long b-long force-pushed the chore/dspx-1442--update-java-and-ts-docs branch from 57d716e to 55932de Compare August 13, 2025 20:18
@b-long b-long force-pushed the chore/dspx-1442--update-java-and-ts-docs branch from 634746e to 64a6c28 Compare August 13, 2025 20:32
Copy link
Contributor

@jp-ayyappan jp-ayyappan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@b-long b-long merged commit 2e9b0b8 into main Aug 15, 2025
3 checks passed
@b-long b-long deleted the chore/dspx-1442--update-java-and-ts-docs branch August 15, 2025 13:31
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.

5 participants