Skip to content

Commit 6e4b0ff

Browse files
Documentation update
1 parent d8fb8f5 commit 6e4b0ff

File tree

2 files changed

+54
-2
lines changed

2 files changed

+54
-2
lines changed

docs/modules/ROOT/pages/includes/quarkus-solace.adoc

+32
Original file line numberDiff line numberDiff line change
@@ -193,4 +193,36 @@ endif::add-copy-button-to-env-var[]
193193
--|`Map<String,String>`
194194
|
195195

196+
a| [[quarkus-solace_quarkus.solace-oidc-client-name]]`link:#quarkus-solace_quarkus.solace-oidc-client-name[quarkus.solace.oidc.client-name]`
197+
198+
199+
[.description]
200+
--
201+
Optional value to configure client name provided in oidc client configuration in extension.
202+
203+
ifdef::add-copy-button-to-env-var[]
204+
Environment variable: env_var_with_copy_button:+++QUARKUS_SOLACE_OIDC_CLIENT-NAMEL+++[]
205+
endif::add-copy-button-to-env-var[]
206+
ifndef::add-copy-button-to-env-var[]
207+
Environment variable: `+++QUARKUS_SOLACE_OIDC_CLIENT-NAME+++`
208+
endif::add-copy-button-to-env-var[]
209+
--|`Map<String,String>`
210+
|
211+
212+
a| [[quarkus-solace_quarkus.solace-oidc-refresh-interval]]`link:#quarkus-solace_quarkus.solace-oidc-refresh-interval[quarkus.solace.oidc.refresh.interval]`
213+
214+
215+
[.description]
216+
--
217+
Interval in seconds to fetch new access token by extension and update current solace session. This interval should be less than access token expiry time. For example if access token expires in 60s then refresh interval should be configured to 50s. The interval time should make sure that extension has sufficient time to fetch and update access token.
218+
219+
ifdef::add-copy-button-to-env-var[]
220+
Environment variable: env_var_with_copy_button:+++QUARKUS_SOLACE_OIDC_REFRESH_INTERVAL+++[]
221+
endif::add-copy-button-to-env-var[]
222+
ifndef::add-copy-button-to-env-var[]
223+
Environment variable: `+++QUARKUS_SOLACE_OIDC_REFRESH_INTERVAL+++`
224+
endif::add-copy-button-to-env-var[]
225+
--|`Map<String,String>`
226+
|
227+
196228
|===

docs/modules/ROOT/pages/index.adoc

+22-2
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ quarkus.solace.tls.trust-store-type=
101101
quarkus.solace.tls.trust-store-password=
102102
----
103103

104-
{empty}3. Connecting to a standalone broker with TLS, trust store and client certificate authentication. In case of client certificate authentication broker will read from configured username source(ex: Common Name, Subject Alt Name etc...). Refer to https://docs.solace.com/Security/Configuring-Client-Authentication.htm#Client-Cert[Solace Client Certificate Authentication].
104+
{empty}4. Connecting to a standalone broker with TLS, trust store and client certificate authentication. In case of client certificate authentication broker will read from configured username source(ex: Common Name, Subject Alt Name etc...). Refer to https://docs.solace.com/Security/Configuring-Client-Authentication.htm#Client-Cert[Solace Client Certificate Authentication].
105105
[source,yaml]
106106
----
107107
quarkus.solace.host=tcps://localhost:55443
@@ -115,7 +115,27 @@ quarkus.solace.authentication.client-cert.keystore-password=
115115
quarkus.solace.authentication.client-cert.keystore-format=
116116
----
117117

118-
{empty}4. Connecting to a HA broker. Here you can configure both active and standby URL and the client will switch connectivity based on availability.
118+
{empty}5. Connecting to a standalone broker with OAUTH authentication scheme.
119+
[source,yaml]
120+
----
121+
quarkus.solace.host=tcp://localhost:55555
122+
quarkus.solace.vpn=default
123+
quarkus.solace.authentication.scheme=AUTHENTICATION_SCHEME_OAUTH2
124+
quarkus.solace.oidc.client-name=solace
125+
quarkus.solace.oidc.refresh.interval=50s
126+
127+
quarkus.oidc-client.solace.auth-server-url=http://localhost:7777/auth/realms/master
128+
quarkus.oidc-client.solace.client-id=<client-id>
129+
quarkus.oidc-client.solace.credentials.secret=<client-secret>
130+
# 'client' is a shortcut for `client_credentials`
131+
quarkus.oidc-client.solace.grant.type=client
132+
----
133+
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]
135+
136+
NOTE: The current version is tested with client_credentials grant type where Solace broker is configured as Resource Server.
137+
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.
119139
[source,yaml]
120140
----
121141
quarkus.solace.host=tcp://active-host-name:55555,tcp://standby-host-name:55555

0 commit comments

Comments
 (0)