Skip to content

Commit a57a4c0

Browse files
Updated documentation to describe TLS based OAuth setup
1 parent 8a1d6d4 commit a57a4c0

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

docs/modules/ROOT/pages/index.adoc

+25-3
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ include::includes/quarkus-solace-extension-common.adoc[leveloffset=+1, opts=opti
6969
[[configuring-quarkus-solace-client]]
7070
== Configuring Quarkus Solace Client
7171

72-
Solace Broker supports different ways to connect and authenticate users. This section shows how to pass <<quarkus-solace_quarkus.solace-extra, extra properties>> to quarkus solace client in different scenarios.
72+
Solace Broker supports different ways to connect and authenticate users. This section shows how to pass <<quarkus-solace_quarkus.solace-extra, extra properties>> to quarkus solace client in different scenarios. Please refer to https://docs.solace.com/API-Developer-Online-Ref-Documentation/pubsubplus-java/constant-values.html#com.solace.messaging.config.SolaceProperties[Solace Properties] for supported properties and definitions.
7373

7474
{empty}1. Connecting to a standalone broker with basic authentication
7575
[source,yaml]
@@ -131,11 +131,33 @@ quarkus.oidc-client.solace.credentials.secret=<client-secret>
131131
quarkus.oidc-client.solace.grant.type=client
132132
----
133133

134-
For more details on Quarkus OIDC client supported configuration please refer to https://quarkus.io/guides/security-openid-connect-client-reference[OPENID CONNECT (OIDC) AND OAUTH2 CLIENT AND FILTERS]
134+
{empty}6. Connecting to a standalone broker with TLS and OAUTH authentication scheme.
135+
[source,yaml]
136+
----
137+
quarkus.solace.host=tcps://localhost:55443
138+
quarkus.solace.vpn=default
139+
quarkus.solace.authentication.scheme=AUTHENTICATION_SCHEME_OAUTH2
140+
quarkus.solace.tls.trust-store-path=
141+
quarkus.solace.tls.trust-store-type=
142+
quarkus.solace.tls.trust-store-password=
143+
quarkus.solace.oidc.client-name=solace // client name provided in oidc client config below
144+
quarkus.solace.oidc.refresh.interval=50s // Refresh interval should be less than access token expiry time. Otherwise extension will fail to update access token in solace session.
145+
146+
quarkus.oidc-client.solace.auth-server-url=http://localhost:7777/auth/realms/master
147+
quarkus.oidc-client.solace.client-id=<client-id>
148+
quarkus.oidc-client.solace.credentials.secret=<client-secret>
149+
# 'client' is a shortcut for `client_credentials`
150+
quarkus.oidc-client.solace.grant.type=client
151+
quarkus.oidc-client.solace.tls.trust-store-file=<path-to-truststore-file>
152+
quarkus.oidc-client.solace.tls.key-store-password=
153+
quarkus.oidc-client.solace.tls.verification=<enable-or-disable-tls-verification>
154+
----
155+
156+
For more details on Quarkus OIDC client supported configuration please refer to https://quarkus.io/guides/security-openid-connect-client-reference[OPENID CONNECT (OIDC) AND OAUTH2 CLIENT AND FILTERS] and https://quarkus.io/guides/security-oidc-configuration-properties-reference[OIDC configuration reference]
135157

136158
NOTE: The current version is tested with client_credentials grant type where Solace broker is configured as Resource Server.
137159

138-
{empty}6. Connecting to a HA broker. Here you can configure both active and standby URL and the client will switch connectivity based on availability. Remaining configurations and authentication mechanisms can be used as-is.
160+
{empty}7. Connecting to a HA broker. Here you can configure both active and standby URL and the client will switch connectivity based on availability. Remaining configurations and authentication mechanisms can be used as-is.
139161
[source,yaml]
140162
----
141163
quarkus.solace.host=tcp://active-host-name:55555,tcp://standby-host-name:55555

0 commit comments

Comments
 (0)