This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch faq in repository https://gitbox.apache.org/repos/asf/camel.git
commit d01b8a033b25657a8940f2efb5d34587c9df7756 Author: Claus Ibsen <[email protected]> AuthorDate: Tue Mar 3 19:48:36 2026 +0100 CAMEL-16861: Cleanup docs --- .../modules/ROOT/pages/consumertemplate.adoc | 21 ++++++++++++ docs/user-manual/modules/ROOT/pages/endpoint.adoc | 16 ++++++++++ .../modules/ROOT/pages/producertemplate.adoc | 22 +++++++++++++ docs/user-manual/modules/faq/nav.adoc | 2 -- ...size-for-producercache-or-producertemplate.adoc | 31 ------------------ ...ximum-endpoint-cache-size-for-camelcontext.adoc | 37 ---------------------- docs/user-manual/modules/faq/pages/index.adoc | 2 -- 7 files changed, 59 insertions(+), 72 deletions(-) diff --git a/docs/user-manual/modules/ROOT/pages/consumertemplate.adoc b/docs/user-manual/modules/ROOT/pages/consumertemplate.adoc index 5b04ac70e7b6..57334d6e925a 100644 --- a/docs/user-manual/modules/ROOT/pages/consumertemplate.adoc +++ b/docs/user-manual/modules/ROOT/pages/consumertemplate.adoc @@ -45,6 +45,27 @@ body = template.receiveBody("activemq:MyQueue", 5000); Here we wait at most 5 seconds for a message to be consumed, if there was no message, then `null` is returned as response. +== Configuring default cache size + +You can configure globally the default cache size for both `ProducerTemplate` and `ConsumerTemplate` +which will be created or dependency inject by `CamelContext`. + +This can be done on the `CamelContext` as a global option as shown in the following Java code: + +[source,java] +---- +getCamelContext().getGlobalOptions().put(Exchange.MAXIMUM_CACHE_POOL_SIZE, "50"); +---- + +Or in `application.properties`: + +[source,properties] +---- +camel.main.consumerTemplateCacheSize = 50 +---- + +The default maximum cache size is 1000. + == See Also See xref:producertemplate.adoc[ProducerTemplate] \ No newline at end of file diff --git a/docs/user-manual/modules/ROOT/pages/endpoint.adoc b/docs/user-manual/modules/ROOT/pages/endpoint.adoc index f5ba03c9dfc7..f73805fb9458 100644 --- a/docs/user-manual/modules/ROOT/pages/endpoint.adoc +++ b/docs/user-manual/modules/ROOT/pages/endpoint.adoc @@ -306,6 +306,22 @@ And then we would need to remove the `RAW` from the properties file: myFtpPassword=se+re?t&23 ---- +== Configuring CamelContext default cache size + +The xref:ROOT:camelcontext.adoc[CamelContext] will by default cache the last 1000 +used endpoints (based on a LRUCache). + +This must be done on the `CamelContext` as a global option as shown in the following Java code: + +[source,java] +---- +getCamelContext().getGlobalOptions().put(Exchange.MAXIMUM_ENDPOINT_CACHE_SIZE, "500"); +---- + +The default maximum cache size is 1000. + +You need to configure this before xref:ROOT:camelcontext.adoc[CamelContext] is started. + == Java Endpoint API diff --git a/docs/user-manual/modules/ROOT/pages/producertemplate.adoc b/docs/user-manual/modules/ROOT/pages/producertemplate.adoc index 9a6f59db008d..ee1ac12d8fdb 100644 --- a/docs/user-manual/modules/ROOT/pages/producertemplate.adoc +++ b/docs/user-manual/modules/ROOT/pages/producertemplate.adoc @@ -109,6 +109,28 @@ Object result = FluentProducerTemplate.on(context) .request(); ---- +== Configuring default cache size + +You can configure globally the default cache size for both `ProducerTemplate` and `ConsumerTemplate` +which will be created or dependency inject by `CamelContext`. + +This can be done on the `CamelContext` as a global option as shown in the following Java code: + +[source,java] +---- +getCamelContext().getGlobalOptions().put(Exchange.MAXIMUM_CACHE_POOL_SIZE, "50"); +---- + +Or in `application.properties`: + +[source,properties] +---- +camel.main.producerTemplateCacheSize = 50 +---- + +The default maximum cache size is 1000. + + == See Also See xref:consumertemplate.adoc[ConsumerTemplate] \ No newline at end of file diff --git a/docs/user-manual/modules/faq/nav.adoc b/docs/user-manual/modules/faq/nav.adoc index 767a840ce965..714294e47bda 100644 --- a/docs/user-manual/modules/faq/nav.adoc +++ b/docs/user-manual/modules/faq/nav.adoc @@ -16,8 +16,6 @@ ** xref:how-do-i-specify-which-method-to-use-when-using-beans-in-routes.adoc[How do I specify which method to use when using beans in routes?] ** xref:how-can-i-create-a-custom-component-or-endpoint.adoc[How can I create a custom component or endpoint?] ** xref:how-does-camel-look-up-beans-and-endpoints.adoc[How does Camel look up beans and endpoints?] -** xref:how-do-i-configure-the-default-maximum-cache-size-for-producercache-or-producertemplate.adoc[How do I configure the default maximum cache size for ProducerCache or ProducerTemplate?] -** xref:how-do-i-configure-the-maximum-endpoint-cache-size-for-camelcontext.adoc[How do I configure the maximum endpoint cache size for CamelContext?] ** xref:how-do-i-debug-my-route.adoc[How do I debug my route?] ** xref:how-do-i-disable-jmx.adoc[How do I disable JMX?] ** xref:how-do-i-enable-streams-when-debug-logging-messages-in-camel.adoc[How do I enable streams when debug logging messages in Camel?] diff --git a/docs/user-manual/modules/faq/pages/how-do-i-configure-the-default-maximum-cache-size-for-producercache-or-producertemplate.adoc b/docs/user-manual/modules/faq/pages/how-do-i-configure-the-default-maximum-cache-size-for-producercache-or-producertemplate.adoc deleted file mode 100644 index c15d4a8028af..000000000000 --- a/docs/user-manual/modules/faq/pages/how-do-i-configure-the-default-maximum-cache-size-for-producercache-or-producertemplate.adoc +++ /dev/null @@ -1,31 +0,0 @@ -= How do I configure the default maximum cache size for ProducerCache or ProducerTemplate? - -*Since Camel 2.3* - -This applies to ConsumerCache and ConsumerTemplate as well. - -You can configure the default maximum cache size by setting the -`Exchange.MAXIMUM_CACHE_POOL_SIZE` property on `CamelContext`. - -[source,java] ----- -getCamelContext().getGlobalOptions().put(Exchange.MAXIMUM_CACHE_POOL_SIZE, "50"); ----- - -And in Spring XML its done as: - -[source,java] ----- -<camelContext> - <properties> - <property key="CamelMaximumCachePoolSize" value="50"/> - </properties> -... -</camelContext> ----- - -The default maximum cache size is 1000. - -At runtime you can see the `ProducerCache` in JMX as they are listed in -the `services` category. - diff --git a/docs/user-manual/modules/faq/pages/how-do-i-configure-the-maximum-endpoint-cache-size-for-camelcontext.adoc b/docs/user-manual/modules/faq/pages/how-do-i-configure-the-maximum-endpoint-cache-size-for-camelcontext.adoc deleted file mode 100644 index 41cc9fbb3ed9..000000000000 --- a/docs/user-manual/modules/faq/pages/how-do-i-configure-the-maximum-endpoint-cache-size-for-camelcontext.adoc +++ /dev/null @@ -1,37 +0,0 @@ -= How do I configure the maximum endpoint cache size for CamelContext? - -xref:ROOT:camelcontext.adoc[CamelContext] will by default cache the last 1000 -used endpoints (based on a LRUCache). - -[[HowdoIconfigurethemaximumendpointcachesizeforCamelContext-Configuringcachesize]] -== Configuring cache size - -*Since Camel 2.8* - -You can configure the default maximum cache size by setting the -`Exchange.MAXIMUM_ENDPOINT_CACHE_SIZE` property on -xref:ROOT:camelcontext.adoc[CamelContext]. - -[source,java] ----- -getCamelContext().getGlobalOptions().put(Exchange.MAXIMUM_ENDPOINT_CACHE_SIZE, "500"); ----- - -You need to configure this before xref:ROOT:camelcontext.adoc[CamelContext] -is started. - -And in Spring XML its done as: - -[source,java] ----- -<camelContext> - <properties> - <property key="CamelMaximumEndpointCacheSize" value="500"/> - </properties> -... -</camelContext> ----- - -At runtime you can see the `EndpointRegistry` in JMX as they are listed -in the `services` category. - diff --git a/docs/user-manual/modules/faq/pages/index.adoc b/docs/user-manual/modules/faq/pages/index.adoc index 3f75c3aeb317..ce28e6300339 100644 --- a/docs/user-manual/modules/faq/pages/index.adoc +++ b/docs/user-manual/modules/faq/pages/index.adoc @@ -37,8 +37,6 @@ Questions on using Apache Camel * xref:how-do-i-specify-which-method-to-use-when-using-beans-in-routes.adoc[How do I specify which method to use when using beans in routes?] * xref:how-can-i-create-a-custom-component-or-endpoint.adoc[How can I create a custom component or endpoint?] * xref:how-does-camel-look-up-beans-and-endpoints.adoc[How does Camel look up beans and endpoints?] -* xref:how-do-i-configure-the-default-maximum-cache-size-for-producercache-or-producertemplate.adoc[How do I configure the default maximum cache size for ProducerCache or ProducerTemplate?] -* xref:how-do-i-configure-the-maximum-endpoint-cache-size-for-camelcontext.adoc[How do I configure the maximum endpoint cache size for CamelContext?] * xref:how-do-i-debug-my-route.adoc[How do I debug my route?] * xref:how-do-i-disable-jmx.adoc[How do I disable JMX?] * xref:how-do-i-enable-streams-when-debug-logging-messages-in-camel.adoc[How do I enable streams when debug logging messages in Camel?]
