SpringCloud/stream-applications
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Link to function catalog docs for config props (#526)

Browse Source 
Prior to this commit, each app documented its available config props
in its README.adoc. Now that the functions have been moved to the
function catalog, these inline docs are replaced w/ a link to the
respective function catalog docs.

See #524
This commit is contained in:
Chris Bono
2024-03-28 10:44:08 -05:00
committed by GitHub
parent 782e21ac1b
commit 7487dc8f61
55 changed files with 114 additions and 1384 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
applications/source/jms-source/README.adoc
View File

@@ -7,33 +7,8 @@ The JMS source enables receiving messages from JMS.
The **JMS** $$source$$ has the following options:
//tag::configuration-properties[]
Properties grouped by prefix:
=== jms.supplier
$$client-id$$:: $$Client id for durable subscriptions.$$ *($$String$$, default: `$$<none>$$`)*
$$destination$$:: $$The destination from which to receive messages (queue or topic).$$ *($$String$$, default: `$$<none>$$`)*
$$message-selector$$:: $$A selector for messages.$$ *($$String$$, default: `$$<none>$$`)*
$$session-transacted$$:: $$True to enable transactions and select a DefaultMessageListenerContainer, false to select a SimpleMessageListenerContainer.$$ *($$Boolean$$, default: `$$true$$`)*
$$subscription-durable$$:: $$True for a durable subscription.$$ *($$Boolean$$, default: `$$<none>$$`)*
$$subscription-name$$:: $$The name of a durable or shared subscription.$$ *($$String$$, default: `$$<none>$$`)*
$$subscription-shared$$:: $$True for a shared subscription.$$ *($$Boolean$$, default: `$$<none>$$`)*
=== spring.jms
$$jndi-name$$:: $$Connection factory JNDI name. When set, takes precedence to others connection factory auto-configurations.$$ *($$String$$, default: `$$<none>$$`)*
$$pub-sub-domain$$:: $$Whether the default destination type is topic.$$ *($$Boolean$$, default: `$$false$$`)*
=== spring.jms.listener
$$acknowledge-mode$$:: $$<documentation missing>$$ *($$AcknowledgeMode$$, default: `$$<none>$$`)*
$$auto-startup$$:: $$Start the container automatically on startup.$$ *($$Boolean$$, default: `$$true$$`)*
$$concurrency$$:: $$<documentation missing>$$ *($$Integer$$, default: `$$<none>$$`)*
$$max-concurrency$$:: $$Maximum number of concurrent consumers.$$ *($$Integer$$, default: `$$<none>$$`)*
$$min-concurrency$$:: $$Minimum number of concurrent consumers. When max-concurrency is not specified the minimum will also be used as the maximum.$$ *($$Integer$$, default: `$$<none>$$`)*
$$receive-timeout$$:: $$Timeout to use for receive calls. Use -1 for a no-wait receive or 0 for no timeout at all. The latter is only feasible if not running within a transaction manager and is generally discouraged since it prevents clean shutdown.$$ *($$Duration$$, default: `$$1s$$`)*
//tag::configuration-properties[link-to-catalog=true]
https://github.com/spring-cloud/spring-functions-catalog/tree/main/supplier/spring-jms-supplier#configuration-options[See Spring Functions Catalog for configuration options].
//end::configuration-properties[]
//end::ref-doc[]