Skip to content

Improve Javadoc for CredentialsProvider #51200

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.

Sign up for GitHub

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

Merged
geoand merged 1 commit into from
Nov 25, 2025
Merged

Improve Javadoc for CredentialsProvider #51200

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions extensions/credentials/runtime/src/main/java/io/quarkus/credentials/CredentialsProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,17 @@
* <p>
* The default implementation of asynchronous variant invokes the synchronous {@link #getCredentials(String)} on a worker
* thread.
* <p>
* Note that there is a price to pay for offloading a task to a worker thread.
* Nevertheless, if the implementation of the synchronous {@link #getCredentials(String)} involves blocking APIs, it is the
* right thing to do.
* Otherwise, it could block an event-loop thread, which
* <a href="https://quarkus.io/guides/duplicated-context#the-reactive-model"><strong>MUST</strong> be avoided</a>.
* <p>
* When the implementation does not invoke blocking APIs, prefer overriding the asynchronous
* {@link #getCredentialsAsync(String)}, instead of the synchronous variant.
* For example, if a provider caches credentials in memory and refreshes them in the background, it is not necessary to switch
* to a worker thread to read them.
*/
public interface CredentialsProvider {

Expand Down
Loading