Fixed docs to include solace connection configuration

SolaceLabs · Jan 24, 2024 · 7fecd65 · 7fecd65
1 parent e8179dc
commit 7fecd65
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 1 deletion.
diff --git a/docs/modules/ROOT/pages/includes/quarkus-solace.adoc b/docs/modules/ROOT/pages/includes/quarkus-solace.adoc
@@ -120,6 +120,40 @@ endif::add-copy-button-to-env-var[]
 |`solace`
 
 
+a| [[quarkus-solace_quarkus.solace.host]]`link:#quarkus-solace_quarkus.solace.host[quarkus.solace.host]`
+
+
+[.description]
+--
+The Solace host (hostname:port)
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_SOLACE_HOST+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_SOLACE_HOST+++`
+endif::add-copy-button-to-env-var[]
+--|string 
+|required icon:exclamation-circle[title=Configuration property is required]
+
+
+a| [[quarkus-solace_quarkus.solace.vpn]]`link:#quarkus-solace_quarkus.solace.vpn[quarkus.solace.vpn]`
+
+
+[.description]
+--
+The Solace VPN
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_SOLACE_VPN+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_SOLACE_VPN+++`
+endif::add-copy-button-to-env-var[]
+--|string 
+|required icon:exclamation-circle[title=Configuration property is required]
+
+
 a|icon:lock[title=Fixed at build time] [[quarkus-solace_quarkus.solace.devservices.container-env-container-env]]`link:#quarkus-solace_quarkus.solace.devservices.container-env-container-env[quarkus.solace.devservices.container-env]`
 
 
@@ -136,4 +170,27 @@ endif::add-copy-button-to-env-var[]
 --|`Map<String,String>` 
 |
 
+
+a| [[quarkus-solace_quarkus.solace-extra]]`link:#quarkus-solace_quarkus.solace-extra[quarkus.solace]`
+
+
+[.description]
+--
+Any extra parameters to pass to the Solace client.  +
+ +
+ +
+Refer to link:https://docs.solace.com/API-Developer-Online-Ref-Documentation/pubsubplus-java/constant-values.html#com.solace.messaging.config.SolaceProperties.AuthenticationProperties.SCHEME[AuthenticationProperties] and link:https://docs.solace.com/API-Developer-Online-Ref-Documentation/pubsubplus-java/constant-values.html#com.solace.messaging.config.SolaceProperties.TransportLayerProperties.COMPRESSION_LEVEL[TransportLayerProperties] for more configuration options  +
+ +
+ +
+Example: To configure compression `quarkus.solace.transport.compression-level`
+
+ifdef::add-copy-button-to-env-var[]
+Environment variable: env_var_with_copy_button:+++QUARKUS_SOLACE+++[]
+endif::add-copy-button-to-env-var[]
+ifndef::add-copy-button-to-env-var[]
+Environment variable: `+++QUARKUS_SOLACE+++`
+endif::add-copy-button-to-env-var[]
+--|`Map<String,String>` 
+|
+
 |===
diff --git a/runtime/src/main/java/com/solace/quarkus/runtime/SolaceConfig.java b/runtime/src/main/java/com/solace/quarkus/runtime/SolaceConfig.java
@@ -22,7 +22,21 @@ public interface SolaceConfig {
     String vpn();
 
     /**
-     * Any extra parameters to pass to the Solace client
+     * Any extra parameters to pass to the Solace client.
+     * <br/>
+     * <br/>
+     * <br/>
+     * Refer to
+     * <a href=
+     * "https://docs.solace.com/API-Developer-Online-Ref-Documentation/pubsubplus-java/constant-values.html#com.solace.messaging.config.SolaceProperties.AuthenticationProperties.SCHEME">AuthenticationProperties</a>
+     * and
+     * <a href=
+     * "https://docs.solace.com/API-Developer-Online-Ref-Documentation/pubsubplus-java/constant-values.html#com.solace.messaging.config.SolaceProperties.TransportLayerProperties.COMPRESSION_LEVEL">TransportLayerProperties</a>
+     * for more configuration options
+     * <br/>
+     * <br/>
+     * <br/>
+     * Example: To configure compression `quarkus.solace.transport.compression-level`
      */
     @WithParentName
     Map<String, String> extra();