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

Added explanation for OAuthAwareClientExample #463

Merged
merged 1 commit into from
Oct 31, 2024
Merged
Changes from all commits
Commits
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 web-client-examples/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -151,3 +151,14 @@ This examples shows how to download an oauth2 protected resource, the example ma
* get the resource using the token

link:src/main/java/io/vertx/example/webclient/oauth/TwitterOAuthExample.java[Twitter OAuth Example]

=== Receiving a OAUTH2 protected resource using OAuth2WebClient

This example shows how to utilise the OAuth2WebClient which simplifies the process of acquiring and managing an OAuth2
access token and using it to access a protected resource.

First you configure the OAuth2 flow and then you create the client using the specified configuration.
When sending request to the protected resource, the client will automatically acquire the token if it is not already
available or is expired. Flow that will be used to acquire the token is specified per request.

link:src/main/java/io/vertx/example/webclient/oauth/OAuthAwareClientExample.java[OAuth Aware Client Example]
Loading