Skip to content

Commit

Permalink
Change the extension to stable status (#178)
Browse files Browse the repository at this point in the history
  • Loading branch information
zhfeng authored Nov 21, 2023
1 parent 4466aff commit bdd4fc5
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
12 changes: 11 additions & 1 deletion docs/modules/ROOT/pages/config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ h|Default

a| [[quarkus-pooled-jms_quarkus.pooled-jms.pooling.enabled]]`link:#quarkus-pooled-jms_quarkus.pooled-jms.pooling.enabled[quarkus.pooled-jms.pooling.enabled]`


[.description]
--
Whether to enable pooling capabilities for JMS connections.
Expand All @@ -28,9 +29,10 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-pooled-jms_quarkus.pooled-jms.transaction]]`link:#quarkus-pooled-jms_quarkus.pooled-jms.transaction[quarkus.pooled-jms.transaction]`


[.description]
--
Whether to enable `javax.jms.XAConnection` support and integrate with `javax.transaction.TransactionManager` If you enable it, you need to include `io.quarkus:quarkus-narayana-jta` extension.
Whether to enable `jakarta.jms.XAConnection` support and integrate with `jakarta.transaction.TransactionManager` If you enable it, you need to include `io.quarkus:quarkus-narayana-jta` extension.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_POOLED_JMS_TRANSACTION+++[]
Expand All @@ -45,6 +47,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-pooled-jms_quarkus.pooled-jms.max-connections]]`link:#quarkus-pooled-jms_quarkus.pooled-jms.max-connections[quarkus.pooled-jms.max-connections]`


[.description]
--
Determines the maximum number of Connections the pool maintains in a single Connection pool (defaults to one).
Expand All @@ -61,6 +64,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-pooled-jms_quarkus.pooled-jms.connection-idle-timeout]]`link:#quarkus-pooled-jms_quarkus.pooled-jms.connection-idle-timeout[quarkus.pooled-jms.connection-idle-timeout]`


[.description]
--
The idle timeout (default 30 seconds) controls how long a Connection that hasn't been or currently isn't loaned out to any client will remain idle in the Connection pool before it is eligible to be closed and discarded. To disable idle timeouts the value should be set to 0 or a negative number.
Expand All @@ -77,6 +81,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-pooled-jms_quarkus.pooled-jms.connection-check-interval]]`link:#quarkus-pooled-jms_quarkus.pooled-jms.connection-check-interval[quarkus.pooled-jms.connection-check-interval]`


[.description]
--
used to establish a periodic check for expired Connections which will close all Connection that have exceeded the set expiration value. This value is set to 0ms by default and only activates if set to a positive non-zero value.
Expand All @@ -93,6 +98,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-pooled-jms_quarkus.pooled-jms.use-provider-jms-context]]`link:#quarkus-pooled-jms_quarkus.pooled-jms.use-provider-jms-context[quarkus.pooled-jms.use-provider-jms-context]`


[.description]
--
by default the JMS pool will use it's own generic JMSContext classes to wrap a Connection borrowed from the pool instead of using the JMSContext functionality of the JMS ConnectionFactory that was configured. This generic JMSContext implementation may be limited compared to the Provider version and if that functionality is critical to the application this option can be enabled to force the pool to use the Provider JMSContext implementation. When enabled the JMSContext API is then not part of the Connections that are pooled by this JMS Connection pooling library.
Expand All @@ -109,6 +115,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-pooled-jms_quarkus.pooled-jms.max-sessions-per-connection]]`link:#quarkus-pooled-jms_quarkus.pooled-jms.max-sessions-per-connection[quarkus.pooled-jms.max-sessions-per-connection]`


[.description]
--
For each Connection in the pool there can be a configured maximum number of Sessions that the pooled Connection will loan out before either blocking or throwing an error (based on configuration). By default this value is 500 meaning that each provider Connection is limited to 500 sessions, this limit can be disabled by setting the value to a negative number.
Expand All @@ -125,6 +132,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-pooled-jms_quarkus.pooled-jms.block-if-session-pool-is-full]]`link:#quarkus-pooled-jms_quarkus.pooled-jms.block-if-session-pool-is-full[quarkus.pooled-jms.block-if-session-pool-is-full]`


[.description]
--
When true (default) a call to createSession on a Connection from the pool will block until another previously created and loaned out session is closed an thereby becomes available. When false a call to createSession when no Session is available will throw an IllegalStateException to indicate that the Connection is not able to provide a new Session at that time.
Expand All @@ -141,6 +149,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-pooled-jms_quarkus.pooled-jms.block-if-session-pool-is-full-timeout]]`link:#quarkus-pooled-jms_quarkus.pooled-jms.block-if-session-pool-is-full-timeout[quarkus.pooled-jms.block-if-session-pool-is-full-timeout]`


[.description]
--
When the blockIfSessionPoolIsFull option is enabled and this value is set then a call to createSession that has blocked awaiting a Session will wait for the specified number of milliseconds before throwing an IllegalStateException. By default this value is set to -1 indicating that the createSession call should block forever if configured to wait.
Expand All @@ -157,6 +166,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-pooled-jms_quarkus.pooled-jms.use-anonymous-producers]]`link:#quarkus-pooled-jms_quarkus.pooled-jms.use-anonymous-producers[quarkus.pooled-jms.use-anonymous-producers]`


[.description]
--
By default a Session that has been loaned out on a call to createSession will use a single anonymous JMS MessageProducer as the underlying producer for all calls to createProducer. In some rare cases this is not desirable and this feature can be disabled using this option, when disabled every call to createProducer will result in a new MessageProducer instance being created.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Quarkus Messaginghub Pooled JMS
:extension-status: preview
:extension-status: stable

Quarkus extension for a JMS Connection pool and transaction manager integration for messaging applications supporting JMS 1.1 and 2.0 clients.

Expand Down
2 changes: 1 addition & 1 deletion runtime/src/main/resources/META-INF/quarkus-extension.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ metadata:
guide: "https://quarkiverse.github.io/quarkiverse-docs/quarkus-pooled-jms/dev/index.html"
categories:
- "miscellaneous"
status: "preview"
status: "stable"

0 comments on commit bdd4fc5

Please sign in to comment.