Improve Javadoc for CredentialsProvider

[tsegismont]

See #50047 (comment)

The goal is to provide guidance to implementors on whether to implement the synchronous or the asynchronous variant.

[tsegismont]

@michalvavrik it's not possible to send a PR to the wiki, and I don't believe I'm granted to commit. My plan was to reuse the comments added here to the migration guide. Would you mind taking care of it?

[michalvavrik]

Thanks for the PR.

@michalvavrik it's not possible to send a PR to the wiki, and I don't believe I'm granted to commit. My plan was to reuse the comments added here to the migration guide. Would you mind taking care of it?

I am not a committer, but I think @sberyozkin could also review this PR and add it to the migration guide, since this concerns Quarkus OIDC as well.

[michalvavrik]

Thanks for the PR.

@michalvavrik it's not possible to send a PR to the wiki, and I don't believe I'm granted to commit. My plan was to reuse the comments added here to the migration guide. Would you mind taking care of it?

I am not a committer, but I think @sberyozkin could also review this PR and add it to the migration guide, since this concerns Quarkus OIDC as well.

@geoand could review & add the migration guide as well, I didn't know Georgios was interested / available.

[sberyozkin]

@tsegismont Thanks, LGTM,

I suggested to avoid shortcuts like doesn't as I believe the Doc Team prefers complete ones. The other suggestion is to offer a slightly stronger encouragement to use the async option. I'll let you decide if you'd like to apply them, thanks

[geoand]

Can you please squash the commits?

Thanks!

[quarkus-bot]

Status for workflow Quarkus CI

This is the status report for running Quarkus CI on commit a51222f.

Failing Jobs

Status	Name	Step	Failures	Logs	Raw logs	Build scan
✔️	JVM Integration Tests - JDK 17			Logs	Raw logs	🚧
✔️	JVM Integration Tests - JDK 17 Windows			Logs	Raw logs	🚧
❌	JVM Integration Tests - JDK 21	Build	Failures	Logs	Raw logs	🚧
✔️	JVM Integration Tests - JDK 21 Semeru			Logs	Raw logs	🚧
✔️	JVM Integration Tests - JDK 25			Logs	Raw logs	🚧

Full information is available in the Build summary check run.
You can consult the Develocity build scans.

Failures

⚙️ JVM Integration Tests - JDK 21 #

- Failing: integration-tests/oidc-wiremock 

📦 integration-tests/oidc-wiremock

❌ io.quarkus.it.keycloak.CodeFlowAuthorizationTest. - History - More details - Source on GitHub

Details

java.lang.RuntimeException: java.lang.RuntimeException: Failed to start quarkus
	at io.quarkus.test.junit.QuarkusTestExtension.throwBootFailureException(QuarkusTestExtension.java:663)
	at io.quarkus.test.junit.QuarkusTestExtension.interceptBeforeAllMethod(QuarkusTestExtension.java:730)
	at java.base/java.util.ArrayList.forEach(ArrayList.java:1596)
Caused by: java.lang.RuntimeException: Failed to start quarkus
	at io.quarkus.runner.ApplicationImpl.doStart(Unknown Source)
	at io.quarkus.runtime.Application.start(Application.java:101)
	at java.base/java.lang.reflect.Method.invoke(Method.java:580)

❌ io.quarkus.it.keycloak.CodeFlowAuthorizationTest.testCodeFlowUserInfoCachedInIdToken line 431 - History - More details - Source on GitHub

Details

org.opentest4j.AssertionFailedError: expected: <true> but was: <false>
	at org.junit.jupiter.api.AssertionFailureBuilder.build(AssertionFailureBuilder.java:151)
	at org.junit.jupiter.api.AssertionFailureBuilder.buildAndThrow(AssertionFailureBuilder.java:132)
	at org.junit.jupiter.api.AssertTrue.failNotTrue(AssertTrue.java:63)
	at org.junit.jupiter.api.AssertTrue.assertTrue(AssertTrue.java:36)
	at org.junit.jupiter.api.AssertTrue.assertTrue(AssertTrue.java:31)
	at org.junit.jupiter.api.Assertions.assertTrue(Assertions.java:183)
	at io.quarkus.it.keycloak.CodeFlowAuthorizationTest.testCodeFlowUserInfoCachedInIdToken(CodeFlowAuthorizationTest.java:431)

---

Flaky tests - Develocity

⚙️ JVM Tests - JDK 25

📦 extensions/smallrye-reactive-messaging/deployment

❌ io.quarkus.smallrye.reactivemessaging.hotreload.ConnectorChangeTest.testUpdatingConnector - History

• Condition with Lambda expression in io.quarkus.smallrye.reactivemessaging.hotreload.ConnectorChangeTest was not fulfilled within 10 seconds. - org.awaitility.core.ConditionTimeoutException

Details

org.awaitility.core.ConditionTimeoutException: Condition with Lambda expression in io.quarkus.smallrye.reactivemessaging.hotreload.ConnectorChangeTest was not fulfilled within 10 seconds.
	at org.awaitility.core.ConditionAwaiter.await(ConditionAwaiter.java:167)
	at org.awaitility.core.CallableCondition.await(CallableCondition.java:78)
	at org.awaitility.core.CallableCondition.await(CallableCondition.java:26)
	at org.awaitility.core.ConditionFactory.until(ConditionFactory.java:1160)
	at org.awaitility.core.ConditionFactory.until(ConditionFactory.java:1129)
	at io.quarkus.smallrye.reactivemessaging.hotreload.ConnectorChangeTest.testUpdatingConnector(ConnectorChangeTest.java:40)
	at java.base/java.lang.reflect.Method.invoke(Method.java:565)

---

⚙️ JVM Tests - JDK 17 Windows

📦 extensions/micrometer-opentelemetry/deployment

❌ io.quarkus.micrometer.opentelemetry.deployment.compatibility.MicrometerTimedInterceptorTest.testTimeMethod - History

• Stream has no elements - java.lang.IllegalArgumentException

Details

java.lang.IllegalArgumentException: Stream has no elements
	at io.quarkus.micrometer.opentelemetry.deployment.common.MetricDataFilter.lambda$lastReading$2(MetricDataFilter.java:213)
	at java.base/java.util.Optional.orElseThrow(Optional.java:403)
	at io.quarkus.micrometer.opentelemetry.deployment.common.MetricDataFilter.lastReading(MetricDataFilter.java:213)
	at io.quarkus.micrometer.opentelemetry.deployment.common.MetricDataFilter.lastReadingDataPoint(MetricDataFilter.java:231)
	at io.quarkus.micrometer.opentelemetry.deployment.compatibility.MicrometerTimedInterceptorTest.testTimeMethod(MicrometerTimedInterceptorTest.java:77)
	at java.base/java.lang.reflect.Method.invoke(Method.java:569)
	at io.quarkus.test.QuarkusUnitTest.runExtensionMethod(QuarkusUnitTest.java:532)

---

⚙️ MicroProfile TCKs Tests

📦 tcks/microprofile-lra

❌ org.eclipse.microprofile.lra.tck.TckRecoveryTests.testCancelWhenParticipantIsUnavailable - History

• Expecting the metric Compensated callback was called Expected: a value equal to or greater than <1> but: <0> was less than <1> - java.lang.AssertionError

Details

java.lang.AssertionError: 
Expecting the metric Compensated callback was called
Expected: a value equal to or greater than <1>
     but: <0> was less than <1>
	at org.hamcrest.MatcherAssert.assertThat(MatcherAssert.java:20)
	at org.eclipse.microprofile.lra.tck.TckRecoveryTests.assertMetricCallbackCalled(TckRecoveryTests.java:210)
	at org.eclipse.microprofile.lra.tck.TckRecoveryTests.testCancelWhenParticipantIsUnavailable(TckRecoveryTests.java:195)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)