Synchronized core docs from refs/heads/main

infinispan · Nov 22, 2024 · 526545d · 526545d
1 parent 30dfd5b
commit 526545d
Show file tree

Hide file tree

Showing 23 changed files with 90 additions and 100 deletions.
diff --git a/docs/dev/cheat-sheets/cache-configuration.html b/docs/dev/cheat-sheets/cache-configuration.html
@@ -1176,7 +1176,7 @@ <h2 id="configuration_formats"><a class="anchor" href="#configuration_formats"><
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/index.html b/docs/dev/index.html
@@ -614,7 +614,7 @@ <h2 id="developing_applications_with_infinispan" class="discrete">Developing app
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/cli/cli.html b/docs/dev/titles/cli/cli.html
@@ -6392,7 +6392,7 @@ <h4 id="see_also_32"><a class="anchor" href="#see_also_32"></a>8.43.4. SEE ALSO<
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/configuring/configuring.html b/docs/dev/titles/configuring/configuring.html
@@ -3864,7 +3864,7 @@ <h4 id="remote_cache_statistics" class="discrete">Remote cache statistics</h4>
 <div class="sect2">
 <h3 id="enabling-hotrod-client-statistics_statistics-jmx"><a class="anchor" href="#enabling-hotrod-client-statistics_statistics-jmx"></a>4.3. Enabling Hot Rod client statistics</h3>
 <div class="paragraph">
-<p>Hot Rod Java clients can provide statistics that include remote cache and near-cache hits and misses as well as connection pool usage.</p>
+<p>Hot Rod Java clients can provide statistics that include remote cache and near-cache hits and misses.</p>
 </div>
 <div class="olist arabic">
 <div class="title">Procedure</div>
@@ -13149,7 +13149,7 @@ <h4 id="asynchronous_thread_pool" class="discrete">Asynchronous thread pool</h4>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/contributing/contributing.html b/docs/dev/titles/contributing/contributing.html
@@ -3704,7 +3704,7 @@ <h3 id="infinispan_methods_and_corresponding_verbs"><a class="anchor" href="#inf
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/developing/developing.html b/docs/dev/titles/developing/developing.html
@@ -536,7 +536,7 @@ <h1>Infinispan Developer Guide</h1>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/embedding/embedding.html b/docs/dev/titles/embedding/embedding.html
@@ -7432,7 +7432,7 @@ <h3 id="extending_the_configuration_builders_and_parsers"><a class="anchor" href
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/encoding/encoding.html b/docs/dev/titles/encoding/encoding.html
@@ -2612,7 +2612,7 @@ <h3 id="converting-data-on-demand_transcoding"><a class="anchor" href="#converti
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/getting_started/getting_started.html b/docs/dev/titles/getting_started/getting_started.html
@@ -746,7 +746,7 @@ <h3 id="mvn_archetypes"><a class="anchor" href="#mvn_archetypes"></a>1.2. Genera
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/hibernate/hibernate.html b/docs/dev/titles/hibernate/hibernate.html
@@ -1473,7 +1473,7 @@ <h3 id="using_minimal_puts"><a class="anchor" href="#using_minimal_puts"></a>1.6
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/hotrod_java/hotrod_java.html b/docs/dev/titles/hotrod_java/hotrod_java.html
@@ -547,7 +547,6 @@ <h1>Using Hot Rod Java clients</h1>
 <ul class="sectlevel3">
 <li><a href="#configuring-hotrod-clusters_hotrod-client-configuration">3.2.1. Defining Infinispan Clusters in Client Configuration</a></li>
 <li><a href="#switching-hotrod-clusters_hotrod-client-configuration">3.2.2. Manually Switching Infinispan Clusters</a></li>
-<li><a href="#configuring-hotrod-connection-pools_hotrod-client-configuration">3.2.3. Configuring Connection Pools</a></li>
 </ul>
 </li>
 <li><a href="#configuring-hotrod-authentication_hotrod-client-configuration">3.3. Configuring Authentication Mechanisms for Hot Rod Clients</a>
@@ -666,6 +665,22 @@ <h3 id="hotrod_hotrod-java-client"><a class="anchor" href="#hotrod_hotrod-java-c
 </li>
 </ul>
 </div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>The client only supports Hot Rod protocol version 3.0 and newer.
+The server supports Hot Rod protocol version 2.0 and newer.
+If a client is needed that supports older versions up to 2.0 the hotrod-client-legacy module can be used.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
 </div>
 <div class="sect2">
 <h3 id="hotrod-client-intelligence_hotrod-java-client"><a class="anchor" href="#hotrod-client-intelligence_hotrod-java-client"></a>1.2. Client Intelligence</h3>
@@ -892,8 +907,22 @@ <h3 id="client-server-compatibility_hotrod-java-client"><a class="anchor" href="
 <div class="title">Infinispan 10 and later</div>
 <p>Hot Rod protocol version 3.x automatically negotiates the highest version possible for clients with Infinispan Server.</p>
 </div>
-<div class="paragraph">
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-tip" title="Tip"></i>
+</td>
+<td class="content">
 <div class="title">Infinispan 9.4 and earlier</div>
+<div class="paragraph">
+<p>The client no longer supports HotRod protocol versions older than 3.0. As such you must use an older client or the <code>hotrod-client-legacy</code> module.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+<div class="paragraph">
 <p>Clients that use a Hot Rod protocol version that is higher than the Infinispan Server version must set the <code>infinispan.client.hotrod.protocol_version</code> property.</p>
 </div>
 <div class="ulist _additional-resources">
@@ -1171,60 +1200,6 @@ <h4 id="switching-hotrod-clusters_hotrod-client-configuration"><a class="anchor"
 </ul>
 </div>
 </div>
-<div class="sect3">
-<h4 id="configuring-hotrod-connection-pools_hotrod-client-configuration"><a class="anchor" href="#configuring-hotrod-connection-pools_hotrod-client-configuration"></a>3.2.3. Configuring Connection Pools</h4>
-<div class="paragraph">
-<p>Hot Rod Java clients keep pools of persistent connections to Infinispan servers to reuse TCP connections instead of creating them on each request.</p>
-</div>
-<div class="ulist">
-<div class="title">Procedure</div>
-<ul>
-<li>
-<p>Configure Hot Rod client connection pool settings as in the following examples:</p>
-</li>
-</ul>
-</div>
-<div class="listingblock primary">
-<div class="title">ConfigurationBuilder</div>
-<div class="content">
-<pre class="highlight nowrap"><code class="language-java" data-lang="java">ConfigurationBuilder clientBuilder = new ConfigurationBuilder();
-clientBuilder.addServer()
-               .host("127.0.0.1")
-               .port(11222)
-             .connectionPool()
-               .maxActive(10)
-               .exhaustedAction(ExhaustedAction.valueOf("WAIT"))
-               .maxWait(1)
-               .minIdle(20)
-               .minEvictableIdleTime(300000)
-               .maxPendingRequests(20);
-RemoteCacheManager remoteCacheManager = new RemoteCacheManager(clientBuilder.build());</code></pre>
-</div>
-</div>
-<div class="listingblock secondary">
-<div class="title">hotrod-client.properties</div>
-<div class="content">
-<pre class="highlight nowrap"><code>infinispan.client.hotrod.server_list = 127.0.0.1:11222
-infinispan.client.hotrod.connection_pool.max_active = 10
-infinispan.client.hotrod.connection_pool.exhausted_action = WAIT
-infinispan.client.hotrod.connection_pool.max_wait = 1
-infinispan.client.hotrod.connection_pool.min_idle = 20
-infinispan.client.hotrod.connection_pool.min_evictable_idle_time = 300000
-infinispan.client.hotrod.connection_pool.max_pending_requests = 20</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>These configuration options give fine-grained control over the pool.
-We recommend tuning the pool according to the application needs.
-Otherwise, you might experience an increase in latency for new connections opening or a decrease in throughput with few connections available.</p>
-</div>
-<div class="paragraph">
-<p>A large pool could lead to a "herd effect" of new connections, given an abrupt increase in load.
-However, it should help in throughput with more connections to attend requests.
-A smaller pool avoids this effect and consumes fewer resources.
-However, it can only handle so many requests before starting to degrade.</p>
-</div>
-</div>
 </div>
 <div class="sect2">
 <h3 id="configuring-hotrod-authentication_hotrod-client-configuration"><a class="anchor" href="#configuring-hotrod-authentication_hotrod-client-configuration"></a>3.3. Configuring Authentication Mechanisms for Hot Rod Clients</h3>
@@ -1239,19 +1214,6 @@ <h3 id="configuring-hotrod-authentication_hotrod-client-configuration"><a class=
 </li>
 </ul>
 </div>
-<div class="admonitionblock warning">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-warning" title="Warning"></i>
-</td>
-<td class="content">
-Authorization is an expensive operation performed on each new connection.
-We strongly recommend tuning the connection pool.
-</td>
-</tr>
-</table>
-</div>
 <div class="listingblock primary">
 <div class="title">SCRAM</div>
 <div class="content">
@@ -1709,7 +1671,7 @@ <h3 id="configuring-hotrod-encryption_hotrod-client-configuration"><a class="anc
 <div class="sect2">
 <h3 id="enabling-hotrod-client-statistics_hotrod-client-configuration"><a class="anchor" href="#enabling-hotrod-client-statistics_hotrod-client-configuration"></a>3.5. Enabling Hot Rod client statistics</h3>
 <div class="paragraph">
-<p>Hot Rod Java clients can provide statistics that include remote cache and near-cache hits and misses as well as connection pool usage.</p>
+<p>Hot Rod Java clients can provide statistics that include remote cache and near-cache hits and misses.</p>
 </div>
 <div class="olist arabic">
 <div class="title">Procedure</div>
@@ -1858,9 +1820,6 @@ <h3 id="near-caches-hotrod-client-configuration"><a class="anchor" href="#near-c
 <p>Reside on Infinispan Server and keep track of the entries that the client has requested.</p>
 </li>
 <li>
-<p>Require a connection pool configuration that has a maximum of one active connection per server and uses the <code>WAIT</code> exhausted action.</p>
-</li>
-<li>
 <p>Cannot be used with unbounded near caches.</p>
 </li>
 </ul>
@@ -2084,7 +2043,7 @@ <h3 id="creating-caches-hotrod_hotrod-client-configuration"><a class="anchor" hr
 <div class="sect2">
 <h3 id="configuring-hotrod-metrics_hotrod-client-configuration"><a class="anchor" href="#configuring-hotrod-metrics_hotrod-client-configuration"></a>3.10. Configuring Hot Rod Client metrics</h3>
 <div class="paragraph">
-<p>Hot Rod Java clients collect and expose metrics related to the connection pool and cache requests.
+<p>Hot Rod Java clients collect and expose metrics related to the cache requests.
 Implement the SPI <code>RemoteCacheManagerMetricsRegistry</code> to register metrics in the collector of your choice.
 Infinispan provides an implementation using Micrometer.</p>
 </div>
@@ -3656,7 +3615,7 @@ <h4 id="adding_the_test_container_to_your_project_dependencies"><a class="anchor
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/hotrod_protocol/hotrod_protocol.html b/docs/dev/titles/hotrod_protocol/hotrod_protocol.html
@@ -8914,7 +8914,7 @@ <h3 id="hot_rod_protocol_4_1"><a class="anchor" href="#hot_rod_protocol_4_1"></a
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/memcached/memcached.html b/docs/dev/titles/memcached/memcached.html
@@ -689,7 +689,7 @@ <h4 id="individual_statistics"><a class="anchor" href="#individual_statistics"><
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/query/query.html b/docs/dev/titles/query/query.html
@@ -4246,7 +4246,7 @@ <h3 id="tuning-query-performance_query-monitoring-tuning"><a class="anchor" href
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/resp/resp-endpoint.html b/docs/dev/titles/resp/resp-endpoint.html
@@ -1500,7 +1500,7 @@ <h3 id="redis-commands_resp-endpoint"><a class="anchor" href="#redis-commands_re
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/rest/rest.html b/docs/dev/titles/rest/rest.html
@@ -7625,7 +7625,7 @@ <h3 id="rest_server_client_http"><a class="anchor" href="#rest_server_client_htt
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/security/security.html b/docs/dev/titles/security/security.html
@@ -6131,7 +6131,7 @@ <h4 id="cross_site_replication" class="discrete">Cross-site replication</h4>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/server/server.html b/docs/dev/titles/server/server.html
@@ -2812,8 +2812,22 @@ <h4 id="client-server-compatibility_server-endpoints"><a class="anchor" href="#c
 <div class="title">Infinispan 10 and later</div>
 <p>Hot Rod protocol version 3.x automatically negotiates the highest version possible for clients with Infinispan Server.</p>
 </div>
-<div class="paragraph">
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-tip" title="Tip"></i>
+</td>
+<td class="content">
 <div class="title">Infinispan 9.4 and earlier</div>
+<div class="paragraph">
+<p>The client no longer supports HotRod protocol versions older than 3.0. As such you must use an older client or the <code>hotrod-client-legacy</code> module.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+<div class="paragraph">
 <p>Clients that use a Hot Rod protocol version that is higher than the Infinispan Server version must set the <code>infinispan.client.hotrod.protocol_version</code> property.</p>
 </div>
 <div class="ulist _additional-resources">
@@ -8316,7 +8330,7 @@ <h4 id="remote_cache_statistics" class="discrete">Remote cache statistics</h4>
 <div class="sect2">
 <h3 id="enabling-hotrod-client-statistics_statistics-jmx"><a class="anchor" href="#enabling-hotrod-client-statistics_statistics-jmx"></a>9.2. Enabling Hot Rod client statistics</h3>
 <div class="paragraph">
-<p>Hot Rod Java clients can provide statistics that include remote cache and near-cache hits and misses as well as connection pool usage.</p>
+<p>Hot Rod Java clients can provide statistics that include remote cache and near-cache hits and misses.</p>
 </div>
 <div class="olist arabic">
 <div class="title">Procedure</div>
@@ -13490,7 +13504,7 @@ <h3 id="accessing-health-jmx_server"><a class="anchor" href="#accessing-health-j
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/spring/spring.html b/docs/dev/titles/spring/spring.html
@@ -994,7 +994,7 @@ <h3 id="externalizing-spring-session_externalizing-sessions-spring"><a class="an
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/spring_boot/starter.html b/docs/dev/titles/spring_boot/starter.html
@@ -1209,7 +1209,7 @@ <h2 id="spring-application-properties"><a class="anchor" href="#spring-applicati
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/tuning/tuning.html b/docs/dev/titles/tuning/tuning.html
@@ -2372,7 +2372,7 @@ <h4 id="use_simple_cache_for_local_caches" class="discrete">Use simple cache for
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-11-21 18:26:40 UTC
+Last updated 2024-11-22 07:34:42 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">