Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix and document thread-safety #427

Merged
merged 8 commits into from
Jun 16, 2020
Merged

Fix and document thread-safety #427

merged 8 commits into from
Jun 16, 2020

Conversation

lbalmaceda
Copy link
Contributor

Changes

Made a few fixes to behave better in terms of thread-safety. Also, documented the thread-safety of the classes after our evaluation.

The reviewer might find useful to navigate the diff on a per-commit approach. The last commit is purely Javadoc changes.

References

Closes #419

Testing

I've added failure test cases right before the fix commit. Check the commit history.

  • This change adds test coverage
  • This change has been tested on the latest version of Java or why not

Checklist

@lbalmaceda lbalmaceda added CH: Fixed small This PR may require low effort to action, or contains few changes to review labels Jun 12, 2020
@lbalmaceda lbalmaceda added this to the v3-Next milestone Jun 12, 2020
@lbalmaceda lbalmaceda requested a review from a team June 12, 2020 21:45
@@ -365,20 +366,20 @@ public String toString() {
/**
* Sign the given content using this Algorithm instance.
*
* @param headerBytes an array of bytes representing the base64 encoded header content to be verified against the signature.
* @param headerBytes an array of bytes representing the base64 encoded header content to be verified against the signature.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* @param headerBytes an array of bytes representing the base64 encoded header content to be verified against the signature.
* @param headerBytes an array of bytes representing the base64 encoded header content to be verified against the signature.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

white spaces are being added because the class wasn't properly formatted following the project defaults (IDE default settings).

Widcket
Widcket previously approved these changes Jun 16, 2020
Co-authored-by: Rita Zerrizuela <zeta@widcket.com>
@lbalmaceda lbalmaceda merged commit 9fdf105 into master Jun 16, 2020
@lbalmaceda lbalmaceda deleted the threading-docs branch June 16, 2020 20:22
@jimmyjames jimmyjames modified the milestones: v3-Next, 3.11.0 Sep 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CH: Fixed small This PR may require low effort to action, or contains few changes to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document thread-safety
3 participants