= Upgrading from 12.1 to 13.0

== Search

The optional ```IndexedQueryMode``` parameter has been removed from queries in library mode, CLI, Hot Rod and REST.
Since 12.0, {brandname} ignores this parameter since it detects the optimal way of performing indexed queries.

== REST

=== Indexer

The ```mass-index``` operation from the cache resource has been deprecated.
Use ```reindex``` instead:

  /v2/caches/{cacheName}/search/indexes?action=reindex

=== Rolling Upgrades

The following operation has been deprecated:

* ```POST /v2/caches/{cacheName}?action=disconnect-source```

Use the substitute:

* ```DELETE /v2/caches/{cacheName}/rolling-upgrade/source-connection```

== File-Based Cache Store (`file-store`) Configuration Defaults to SoftIndexFileStore

Including `file-store` persistence in cache configuration now creates a soft index file-based cache store, `SoftIndexFileStore`, instead of a single-file cache store, `SingleFileStore`.
In previous versions `SingleFileStore` was the default for file-based cache stores.

Any `file-store` configuration with a schema version of 13 is automatically migrated to a `SoftIndexFileStore` after upgrading to Infinispan 13.

=== Schema changes

The following changes apply to the Infinispan 13 configuration schemas:

* The `urn:infinispan:config:store:soft-index` namespace is no longer available.
* The `file-store` element in the `urn:infinispan:config` namespace now defaults to soft-index file stores.
* The `single-file-store` element has been added to the `urn:infinispan:config` namespace if you want to configure a single file store, which is deprecated.
* The `endpoints` element in the `urn:infinispan:server` namespace is no longer a repeating element, but a wrapper for 0 or more `endpoint` elements.

=== Migrating Soft-Index File Stores

==== Declarative

If you are upgrading to Infinispan 13 from a previous version, and your caches include any configuration with the `soft-index-file-store` element, you should convert that configuration to use the `file-store` element instead.

.Infinispan 12.1 and earlier
[source,xml,options="nowrap",subs=attributes+,role="primary"]
----
<persistence>
  <soft-index-file-store xmlns="urn:infinispan:config:soft-index:12.1">
    <index path="testCache/index" />
    <data path="testCache/data" />
  </soft-index-file-store>
</persistence>
----

.Infinispan 13 and later
[source,xml,options="nowrap",subs=attributes+,role="secondary"]
----
<persistence>
  <file-store>
    <index path="testCache/index" />
    <data path="testCache/data" />
  </file-store>
</persistence>
----

==== Programmatic

.Infinispan 12.1 and earlier
[source,xml,options="nowrap",subs=attributes+,role="primary"]
----
ConfigurationBuilder b = new ConfigurationBuilder();
b.persistence()
    .addStore(SoftIndexFileStoreConfigurationBuilder.class)
        .indexLocation("testCache/index");
        .dataLocation("testCache/data")
----

.Infinispan 13 and later
[source,xml,options="nowrap",subs=attributes+,role="secondary"]
----
ConfigurationBuilder b = new ConfigurationBuilder();
b.persistence()
    .addSoftIndexFileStore()
        .indexLocation("testCache/index")
        .dataLocation("testCache/data");
----

=== Migrating Single File Stores

To use `SingleFileStore` as a file-based cache store with Infinispan 13 or later, do one of the following:

.Declarative
[source,xml,options="nowrap",subs=attributes+,role="primary"]
----
<persistence passivation="false">
  <single-file-store shared="false"
                     preload="true"
                     fetch-state="true"
                     read-only="false"/>
</persistence>
----

.Programmatic
[source,java,options="nowrap",subs=attributes+,role="secondary"]
----
ConfigurationBuilder b = new ConfigurationBuilder();
b.persistence()
    .addSingleFileStore();
----

However, Infinispan does not recommend using `SingleFileStore`.
Instead you should use `SoftIndexFileStore` for file-based cache stores because it offers better scalability.

Find out more details about configuring file-based cache stores in the _Configuration Guide_.

== Accurate size metrics

The `currentNumberOfEntries` statistics now return `-1` by default as the calculation is expensive. Accurate values can be restored using the following configuration:

.Declarative
[source,xml,options="nowrap",subs=attributes+,role="primary"]
----
<cache-container>
  <metrics accurate-size="true"/>
</cache-container>
----

.Programmatic
[source,java,options="nowrap",subs=attributes+,role="secondary"]
----
GlobalConfigurationBuilder b = new GlobalConfigurationBuilder();
b.metrics()
    .accurateSize(true);
----

= Upgrading from 11.x or 12.0 to 12.1

  If you are upgrading from 11.x to 12.1, you should also review the 11.0 to 12.0 upgrade notes.

== Upgrading Deployments with Single File Cache Store Persistence

When upgrading Infinispan to 12.1, caches that include a `SingleFileStore` persistence configuration can encounter an issue that leads to data corruption.

This issue affects upgrades to Infinispan 12.1.0.Final through 12.1.4.Final only.
As of Infinispan 12.1.5.Final this issue no longer occurs during upgrade.

If you have already upgraded from 11.x to 12.1, you should do the following as soon as possible:

. Back up any `$ISPN_HOME/server/data/*.dat` files.
. Upgrade to Infinispan 12.1.5.Final or later.

After successful upgrade, Infinispan recovers any corrupted data and restores the Single File Store on first start.

.Cross-site replication state transfer

For caches that backup to other clusters via cross-site replication, you should perform a state transfer after upgrading to 12.1.

From the Infinispan CLI use the `site push-site-state` command as follows:

[source,options="nowrap",subs=attributes+]
----
[//containers/default]> site push-site-state --cache=cacheName --site=NYC
----


== JGroups configuration changes

=== Message bundler
The default JGroups bundler has changed from
"no-bundler" (a thread sending a message writes it to the TCP socket or sends the UDP datagram directly) to
"transfer-queue" (a thread sending a message only adds the message to a queue, and a separate
bundler thread groups the messages in "batches" then sends the batches).

== Encoding

* `org.infinispan.commons.dataconversion.Encoder` has been deprecated and will be removed in a future version.

== Authorization

A new `CREATE` permission has been introduced, with the following effects:
* users now require the `CREATE` permission to be able to create/remove caches/counters/locks instead of the `ADMIN` permission
* it supersedes the internal `___schema_manager` role, which has now been deprecated. It is required in order to add/remove schemas.
* it supersedes the internal `___script_manager` role, which has now been deprecated. It is required in order to add/remove scripts.

=== Server

Authorization is now enabled out-of-the-box in the default server configuration.
Authorization only applies to "global" operations (administrative and management), so normal cache usage is unaffected.
You can revert to the previous behavior by removing the `<authorization>` element from the `<cache-container>` configuration.

The default logging configuration now includes an audit logging which is disabled by default.

== Server Trust Store

The trust store configuration is now part of the server identity to allow client certificate validation
without requiring authentication. Adding a `truststore-realm` will reference the identity's trust store.

[source,xml]
----
<!-- 12.0 -->
<security-realm name="default">
   <server-identities>
      <ssl>
         <keystore path="server.pfx"
                   keystore-password="password" alias="server"/>
      </ssl>
   </server-identities>
   <truststore-realm path="trust.pfx" password="secret"/>
</security-realm>
----

[source,xml]
----
<!-- 12.1 -->
<security-realm name="default">
   <server-identities>
      <ssl>
         <keystore path="server.pfx"
                   keystore-password="password" alias="server"/>
         <truststore path="trust.pfx" password="secret"/>
      </ssl>
   </server-identities>
   <truststore-realm/>
</security-realm>
----


= Upgrading from 11.0 to 12.0

== Encoding

Conversions of cache data between `application/x-java-object` and `application/json` are deprecated and will be removed
in a future version. For JSON support, it is recommend to configure the cache with `application/x-protostream` encoding.

== OSGi

Support for OSGi was deprecated and has been removed.

== REST

Some operations that previously supported both `GET` and `POST` now support only `POST`:

* ```/v2/caches/{cacheName}?action=clear```
* ```/v2/caches/{cacheName}?action=sync-data```
* ```/v2/caches/{cacheName}?action=disconnect-source```
* ```/v2/cluster?action=stop```
* ```/v2/counters/{counterName}?action=reset```
* ```/v2/counters/{counterName}?action=increment```
* ```/v2/counters/{counterName}?action=decrement```
* ```/v2/counters/{counterName}?action=add```

* ```/v2/counters/{counterName}?action=compareAndSet```
* ```/v2/counters/{counterName}?action=compareAndSwap```

* ```/v2/caches/{cacheName}/search/indexes?action=mass-index```
* ```/v2/caches/{cacheName}/search/indexes?action=clear```
* ```/v2/caches/{cacheName}/search/query/stats?action=clear```

* ```/v2/server/?action=stop```

* ```/v2/tasks/{taskName}?action=exec```

* ```/v2/caches/{cacheName}/x-site/local/?action=clear-push-state-status```

* ```/v2/caches/{cacheName}/x-site/backups/{site}?action=take-offline```
* ```/v2/caches/{cacheName}/x-site/backups/{site}?action=bring-online```
* ```/v2/caches/{cacheName}/x-site/backups/{site}?action=start-push-state```
* ```/v2/caches/{cacheName}/x-site/backups/{site}?action=cancel-push-state```
* ```/v2/caches/{cacheName}/x-site/backups/{site}?action=cancel-receive-state```

* ```/v2/cache-managers/{name}/x-site/backups/{site}?action=bring-online```
* ```/v2/cache-managers/{name}/x-site/backups/{site}?action=take-offline```
* ```/v2/cache-managers/{name}/x-site/backups/{site}?action=start-push-state```
* ```/v2/cache-managers/{name}/x-site/backups/{site}?action=cancel-push-state```

* The following query statistics operation:

** ```/v2/caches/{cacheName}/search/query/stats```
** ```/v2/caches/{cacheName}/search/indexes/stats```

have been deprecated and will be removed in a future version.

Users should migrate to the ```/v2/caches/{cacheName}/search/stats``` endpoint. Please consult the REST API docs for more details.

== Search

* It's not possible anymore to enable or disable search statistics via JMX. Query and Index statistics are only exposed when the cache "statistics" configuration is enabled.

* `MassIndexer`, `CacheQuery` and `SearchManager` were deprecated and are now removed.

* Indexed type names must be declared for all indexed caches, regardless of their storage format.
  This requirement was introduced in 11 in a more lenient form and failing to comply just logged a warning.
  Starting with version 12 this results in a fatal error preventing the cache to start.
  Please update your configurations accordingly.

=== Indexing configuration

Configuring indexing using the `property` element is deprecated and will be removed in a future version.
Use the `<index-reader>` and `<index-writer>` configuration elements to define indexing behaviour.
For the programmatic configuration, use `builder.indexing().reader()` and `builder.indexing().writer()`.

To migrate your configuration, please refer to the sections below:

==== Storage

.Memory Storage

[source,xml]
----
<!-- 11.0 -->
<indexing>
 <property name="default.directory_provider">local-heap</property>
</indexing>
----

[source,xml]
----
<!-- 12.0 -->
<indexing storage="local-heap">
</indexing>
----

.Filesystem storage

[source,xml]
----
<!-- 11.0 -->
<indexing>
  <property name="default.directory_provider">filesystem</property>
  <property name="default.indexBase">${java.io.tmpdir}/baseDir</property>
</indexing>
----

[source,xml]
----
<!-- 12.0 -->
<indexing storage="filesystem" path="${java.io.tmpdir}/baseDir"/>
----

==== Reader refresh
[source,xml]
----
<!-- 11.0 -->
<indexing>
  <property name="default.reader.async_refresh_period_ms">1000</property>
</indexing>
----

[source,xml]
----
<!-- 12.0 -->
<indexing>
  <index-reader refresh-interval="1000"/>
</indexing>
----

==== IndexManager

From 12.0, `near-real-time` is the default index manager and no configuration is needed:

[source,xml]
----
<!-- 11.0 -->
<indexing>
  <property name="default.indexmanager">near-real-time</property>
</indexing>
----

[source,xml]
----
<!-- 12.0 -->
<indexing enabled="true"/>
----

==== Worker sync/async

The `default.worker.execution` is redundant as the indexing process is async by default:

[source,xml]
----
<!-- 11.0 -->
<indexing>
   <property name="default.worker.execution">async</property>
   <property name="default.index_flush_interval">500</property>
</indexing>
----

[source,xml]
----
<!-- 12.0 -->
<indexing>
   <index-writer commit-interval="500"/>
</indexing>
----

==== Low level Lucene options

The properties used previously to tune the Lucene index directly are now
available under the `<index-writer>` element.

[source,xml]
----
<!-- 11.0 -->
<indexing>
   <property name="default.indexwriter.merge_factor">30</property>
   <property name="default.indexwriter.merge_max_size">1024</property>
   <property name="default.indexwriter.ram_buffer_size">256</property>
</indexing>
----

[source,xml]
----
<!-- 12.0 -->
<indexing>
   <index-writer ram-buffer-size="256">
       <index-merge factor="30" max-size="1024"/>
   </index-writer>
</indexing>
----

==== Supporting older indexes

The property `lucene_version` is deprecated and will not be supported in a future version. It is recommended to re-index when migrating from older Infinispan versions instead of reusing the underlying indexes on disk created
in an older Lucene version.

==== Sharding

Configuration of sharding through the property `default.sharding_strategy.nbr_of_shards` is deprecated and will be removed in a future version.

==== Maximum boolean clauses

The property `infinispan.query.lucene.max-boolean-clauses` is now only supported when used via JVM property. Support for using
it inside the `<property>` element of the index configuration was removed.


== Cache Health
A new status `FAILED` has been added to the cache health, to indicate that a cache failed to start with the
provided configuration. The possible statuses of the cache health are now HEALTHY, HEALTHY_REBALANCING, DEGRADED and FAILED.

== Marshalling

=== Kryo and Protostuff marshaller deprecation

The Kryo and Protostuff marshallers have been deprecated and will be removed in Infinispan 15.0

=== {brandname} includes an upgraded version of the ProtoStream API that can
affect upgrade from previous {brandname} versions.

In previous versions, the ProtoStream API did not correctly nest message types
with the result that the messages were generated as top-level only. For this
reason, if you have Protobuf messages in a persistent cache store and upgrade
to {brandname} 12, then you should modify Java classes so that Protobuf
annotations are at top-level. This ensures that the nesting in your persisted
messages matches the nesting in your Java classes, otherwise data
incompatibility issues can occur.

=== Allow lists

All occurrences of "white list" have been renamed to "allow list".

== Persistence

=== JdbcStringBasedStore
The JDBC string based store now creates an additional `_META` to ensure that any database content is compatible with
the current {brandname} version and configuration.

=== Rest Store
The rest-store has been removed. Users should utilise the HotRod based remote-store for reading/writing to Infinispan clusters.

=== Hot Rod client
The `trust_store_path` property has been deprecated. Use `trust_store_filename` instead and specify `pem` in `trust_store_type`.

= Upgrading from 10.1 to 11.0

== HotRod Client
The `GenericJBossMarshaller` is no longer automatically configured if the `infinispan-jboss-marshalling` module is on the
classpath. If jboss-marshalling is required, it's necessary for the aforementioned jar to be on the classpath and for
the `org.infinispan.jboss.marshalling.commons.GenericJBossMarshaller` to be explicitly configured when creating the
RemoteCacheManager.

== Wildfly modules

The Wildfly modules are now deprecated. The `jgroups`, `infinispan` and `endpoint` extensions have been removed and
all the components are now in a single `org.infinispan` module.

== Cross Site Replication

* The `org.infinispan.xsite.CustomFailurePolicy` interface has been deprecated and it will be replaced by
`org.infinispan.configuration.cache.CustomFailurePolicy`.

* Cross Site Replication was disabled for local caches. They are unable to send or receive updates.

== Total Order transaction protocol removed

Total Order transaction protocol was deprecated in 10.0 and now it is removed.

== JGroups configuration system property changes

The default stacks now now use system property `jgroups.bind.address` to configure the bind address.
System properties `jgroups.tcp.address` and `jgroups.udp.address` still work, but they are considered deprecated and will be removed.

== OSGi

OSGi support has been deprecated and will be removed in a future release.

== Search

=== Indexing

* The Infinispan Lucene Directory, the `InfinispanIndexManager` and `AffinityIndexManager` index managers, and the Infinispan Directory provider for Hibernate Search were deprecated and are now removed.

* The `auto-config` attribute is deprecated and will be removed in a future version.

*  The index mode configuration ```index()``` is no longer necessary. The system will automatically choose the best
way to manage indexing once it is enabled and several previously supported values are no longer supported and will
result in a fatal configuration error when used.
The following substitutions should be done:
** `.indexing().index(Index.NONE)` -> `indexing().enabled(false)`
** All the other enum values -> `indexing().enabled(true)`

In the XML configuration it is possible to omit `enabled="true"` if the configuration contains others sub-elements. Programmatic and JSON configurations must use it.

It is forbidden to use both the `.indexing().enabled( )` and the deprecated `.indexing().index( )` configuration.

* Indexed types required: starting with version 11 it is mandatory to declare all indexed types in the indexing configuration or else warnings will be logged when the undeclared type is firstly used.
This requirement exists solely for indexed caches and applies to both Java classes and protobuf types.
Please consider updating your cache configurations in order to avoid these warnings now.
Starting with version 12 such incomplete configurations will be considered invalid and will result in a fatal error at cache startup time.

=== Querying

* The `SearchManager` has been deprecated and no longer supports Lucene and Hibernate Search native objects:
** `.getQuery()` methods that take a Lucene Query have been removed. The alternative methods that take an Ickle query from the `org.infinispan.query.Search` entry point should be used instead.
** `.buildQueryBuilderForClass()`, that allows to build Hibernate Search queries directly has been removed. Ickle queries should be used instead.
** It is not possible anymore to specify multiple target entity(ies) class(es) when calling `.getQuery()`. The entity will come from the Ickle query string, so multi-entity queries are not supported anymore.

* `CacheQuery` has been deprecated and `org.infinispan.query.dsl.Query` obtained from `Search.getQueryFactory()` should be used instead.

* Instances of `org.infinispan.query.dsl.Query` don't cache query results anymore and allow queries to be re-executed when
calling methods such as `list()`.

==== Entity Mappings

* It is now required to annotate a field that requires sorting with `@SortableField`, both for embedded and remote queries.

* Several features have been deprecated:

** Custom bridges, declared with  `@FieldBridge` and `@ClassBridge`
** Analyzer definitions, declared with `@AnalyzerDef` and `@NormalizerDef`
** Dynamic selection of analyzers based on a discriminator, declared with `@AnalyzerDiscriminator`
** Index time boosting, declared as an attribute of the `@Field` annotation
** Definition of a default analyzer, either using the configuration property `hibernate.search.analyzer` or using the `@Analyzer` annotation
** `indexNullAs`, used as an attribute in the `@Field` declaration
** The configuration `hibernate.search.index_uninverting_allowed`, that allows regular `@Field` to be sortable by un-inverting them at runtime

== ThreadFactoryConfiguration changes

The ThreadGroup configuration setting has been removed and only thread group name is allowed now.
This configuration was inconsistent between programmatic and declarative configuration and is now
consistent.

== Persistence

=== Single File Store
The `<file-store relative-to=""">` attribute has been removed. This attribute will be ignored in pre 11.0 schemas with
only the `path` attribute being taking into account when configuring the stores location.

=== ClusterLoader
The `ClusterLoader` has been deprecated and will be removed in a future release with no direct replacement.

== HotRod
The `LAZY_RETRIEVAL` option utilises the now deprecated `ClusterLoader` and consequently has also been deprecated. It will be removed in a
future release with no direct replacement.

== Memory configuration changes

* The `BINARY` storage has been deprecated, and will no longer store primitives and String mixed with `byte[]`, but only `byte[]`.
* The child elements `<object>`, `<binary>` and `<off-heap>` are also deprecated. The following config changes should be done:

** On heap storage:

 10.1
[source,xml]
----
<memory>
   <object size="1000000" strategy="REMOVE"/>
</memory>
----

 11.0
[source,xml]
----
<memory max-count="1000000" when-full="REMOVE"/>
----

** Binary, on heap storage:

 10.1
[source,xml]
----
<cache>
   <memory>
      <binary size="500000000" strategy="EXCEPTION" eviction="MEMORY"/>
   </memory>
</cache>
----

 11.0
[source,xml]
----
<cache>
   <!-- Or any other binary format -->
   <encoding media-type="application/x-protostream"/>
   <!-- Sizes are human-readable, e.g.: "1 GB", "0.5TB" -->
   <memory max-size="500 MB" when-full="EXCEPTION"/>
</cache>
----

** Off-heap:

 10.1
[source,xml]
----
<cache>
   <memory>
      <off-heap size="10000000" eviction="COUNT"/>
   </memory>
</cache>
----

 11.0
[source,xml]
----
<memory storage="OFF_HEAP" max-count="10000000"/>
----

* Due to the changes above, cache configurations serialized to XML or JSON (for example, when using REST) will always be in the new format.

== Encoding in Server Caches

* Server caches should configure the MediaType for keys and values, or else a WARN will be logged.
Usage of operations that require data conversion or indexing will not be supported for caches without encoding
configuration in a future version. These operations include search, task execution, remote filters/converter/listeners,
REST/Hot Rod reading/writing in different data formats

== Security

=== Server security
The server is now secure by default. Use the `user-tool` to add users or remove the security realm attribute from the endpoint to allow anonymous connections.

=== Cache authorization roles
If you do not explicitly specify roles when enabling cache authorization, all roles declared in the global configuration apply.

== REST

* REST API calls that have the extra URL parameter `?action` to perform operations with side effects now also
support the POST method (returning 200 when the response has content or 204 otherwise).
Support for using `GET` method on those calls will be removed in a future version.

= Upgrading from 10.0 to 10.1 and 10.0 to 11.0

== Maximum Idle Timeouts with Clustered Cache Modes
Maximum idle expiration has been changed to improve data consistency with clustered cache modes when Infinispan nodes fail.

[NOTE]
====
* `Cache.get()` calls do not return until the touch commands complete. This
synchronous behavior increases latency of client requests and reduces
performance.

* Maximum idle expiration, `max-idle`, does not currently work with entries
stored in off-heap memory.

* Likewise, `max-idle` does not work if caches use cache stores as a persistence
layer.
====

See link:{../configuring/configuring.html#expiration_maxidle}[Maximum Idle Expiration] for complete details.

= Upgrading from 10.0 to 10.1

== REST Store

The following configurations were removed from the REST store: ```append-cache-name-to-path``` and ```path```.

To specify the remote server endpoint path, a single configuration ```cache-name``` should be used.

== Infinispan Lucene Directory is deprecated

The Infinispan Lucene directory is now deprecated and will be removed in a future release.
Consequently, the Infinispan Directory provider for Hibernate Search will also be discontinued, with no replacement.

Both IndexManagers that rely on the Lucene Directory are also deprecated, the InfinispanIndexManager and the AffinityIndexManager.
Users are encouraged to reconfigure their indexes as non-shared, using the Near Real Time IndexManager, with file system storage:

[source,xml]
----
<distributed-cache name="default">
    <indexing index="PRIMARY_OWNER">
        <property name="default.indexmanager">near-real-time</property>
        <property name="default.indexBase">/opt/infinispan/server/data/indexes</property>
    </indexing>
</distributed-cache>
----

Queries need to be adjusted to use the ```BROADCAST``` runtime option.

== Security role mappers and audit loggers

The security role mapper implementations have been moved from the `org.infinispan.security.impl` package to the
`org.infinispan.security.mappers` package:

* `org.infinispan.security.impl.CommonNameRoleMapper` => `org.infinispan.security.mappers.CommonNameRoleMapper`
* `org.infinispan.security.impl.ClusterRoleMapper` => `org.infinispan.security.mappers.ClusterRoleMapper`
* `org.infinispan.security.impl.IdentityRoleMapper` => `org.infinispan.security.mappers.IdentityRoleMapper`

The security audit logger implementations have been moved from the `org.infinispan.security.impl` package to the
`org.infinispan.security.audit` package:

* `org.infinispan.security.impl.LoggingAuditLogger` => `org.infinispan.security.audit.LoggingAuditLogger`
* `org.infinispan.security.impl.NullAuditLogger` => `org.infinispan.security.audit.NullAuditLogger`

== Memcached protocol server is deprecated

The Memcached protocol server is now deprecated and will be removed in a future release.
This is being done because Infinispan only implements the very dated text-only protocol instead of the binary protocol
which means no security (authentication / encryption), no support for some new Memcached features and no integration
with Infinispan features like single-port. If someone in the community wishes to implement the binary protocol, we
would revert the decision.

== Hot Rod client default mechanism changed to SCRAM-SHA-512

The default Hot Rod client authentication mechanism has been changed from `DIGEST-MD5` to `SCRAM-SHA-512`.
If you are using `property` user realms, you must make sure you are using `plain-text` storage.

== Transactions
The Map implementation `EntryVersionsMap` has been removed and replaced with a `Map<Object, IncrementalEntryVersion>`.
If the old `EntryVersionsMap#merge` logic is required, it can be replaced with `org.infinispan.transaction.impl.WriteSkewHelper#mergeEntryVersions`,
however users should not rely on this code as it could be removed in the future without notice,

= Upgrading from 9.4 to 10.0

== Marshalling
The internal marshalling capabilities of {brandname} have undergone a significant refactoring in 10.0. The marshalling of
internal {brandname} objects and user objects are now truly isolated. This means that it's now possible to configure
link:{javadocroot}/org/infinispan/commons/marshall/Marshaller.html[Marshaller] implementations in embedded mode or on the
server, without having to handle the marshalling of {brandname} internal classes. Consequently, it's possible to easily
change the marshaller implementation, in a similar manner to how users of the HotRod client are accustomed.

As a consequence of the above changes, the default marshaller used for marshalling user types is no longer based upon JBoss Marshalling. Instead
we now utilise the ProtoStream library to store user types in the language agnostic link:https://developers.google.com/protocol-buffers[Protocol Buffers]
format. It is still possible to utilise the old default, link:{javadocroot}/org/infinispan/jboss/marshalling/core/JBossUserMarshaller.html[JBossUserMarshaller],
however it's necessary to add the `org.infinispan:infinispan-jboss-marshalling` artifact to your application's classpath.

=== Externalizer Deprecations
The following interfaces/annotations have been deprecated as a consequence of the marshalling refactoring:

* link:{javadocroot}/org/infinispan/commons/marshall/Externalizer.html[Externalizer],
* link:{javadocroot}/org/infinispan/commons/marshall/AdvancedExternalizer.html[AdvancedExternalizer]
* link:{javadocroot}/org/infinispan/commons/marshall/SerializeWith.html[SerializeWith]

For cluster communication any configured link:{javadocroot}/org/infinispan/commons/marshall/Externalizer.html[Externalizer]'s
are still utilised to marshall objects, however they are ignored when persisting data to cache stores unless the
link:{javadocroot}/org/infinispan/jboss/marshalling/core/JBossUserMarshaller.html[JBossUserMarshaller] is explicitly configured
via the global link:{javadocroot}/org/infinispan/configuration/global/SerializationConfiguration.html[SerializationConfiguration].

It's highly recommended to migrate from the old Externalizer and JBoss marshalling approach to the new ProtoStream based
marshalling, as the interfaces listed above and the JBossUserMarshaller implementation will be removed in future versions.

=== Store Migration
Unfortunately, the extensive marshalling changes mean that the binary format used by Infinispan stores in `9.4.x` is no
longer compatible with `10.0.x`. Therefore, it's necessary for any existing stores to be migrated to the new format via
the StoreMigrator tool.

NOTE: Whilst we regret that 9.4.x stores are no longer binary compatible, these extensive changes should ensure binary
compatibility across future major versions.

=== Store Defaults

Stores now default to being segmented if the property is not configured. Some stores do not support
being segmented, which will result in a configuration exception being thrown at startup. The moving forward
position is to use segmented stores when possible to increase cache wide performance and reduce memory
requirements for various operations including state transfer.

The file based stores (SingleFileStore and SoftIndexFileStore) both support being segmented, but their
current implementation requires opening file descriptors based on how many segments there are. This may
cause issues in some configurations and users should be aware. Infinispan will print a single WARN message
when such a configuration is found.

== CacheContainterAdmin

Caches created through the CacheContainerAdmin API will now be `PERMANENT` by default. Use the `VOLATILE` flag to obtain the previous behaviour.

== Hot Rod 3.0

Older versions of the Hot Rod protocol treated expiration values greater than the number of milliseconds in 30 days as Unix time. Starting with Hot Rod 3.0 this adjustment no longer happens and expiration is taken literally.

== Total Order transaction protocol is deprecated

Total Order transaction protocol is going to be removed in a future release.
Use the default protocol (2PC).

== Removed the infinispan.server.hotrod.workerThreads system property

The `infinispan.server.hotrod.workerThreads` property was introduced as a hack to work around the fact that the configuration did not expose it.
The property has been removed and endpoint worker threads must now be exclusively configured using the `worker-threads` attribute.

== Removed AtomicMap and FineGrainedAtomicMap

AtomicMapLookup, AtomicMap and FineGrainedAtomicMap have been removed. Please see FunctionalMaps or Cache#Merge for
similar functionality.

== Removed Delta and DeltaAware

The previously deprecated Delta and DeltaAware interfaces have been removed.

== Removed compatibility mode

The previously deprecated Compatibility Mode has been removed.

== Removed the implicit default cache

The default cache must now be named explicitly via the link:{javadocroot}/org/infinispan/configuration/global/GlobalConfigurationBuilder.html#defaultCacheName(java.lang.String)[GlobalConfigurationBuilder#defaultCacheName()] method.

== Removed DistributedExecutor

The previously deprecated DistributedExecutor is now removed. References should be updated to use ClusterExecutor.

== Removed the Tree module

TreeCache has been unsupported for a long time and was only intended as a quick stopgap for JBossCache users. The module has now been removed
completely.

== The JDBC PooledConnectionFactory now utilises Agroal
Previously the JDBC PooledConnectionFactory provided c3p0 and HikariCP based connection pools.
From 10.0 we only provide a PooledConnectionFactory based upon the link:https://agroal.github.io/[Agroal project].
This means that it is no longer possible to utilise `c3p0.properties` and `hikari.properties` files to configure the pool,
instead an agroal compatiblet properties file can be provided.

== XML configuration changes
Several configuration elements and attributes that were deprecated since 9.0 have been removed:

* `<eviction>` - replaced with `memory`
* `<versioning>` - automatically enabled
* `<data-container>` - no longer customizable
* `deadlock-detection-spin` - always disabled
* `write-skew` - enabled automatically

The xsite state transfer chunk size (`<backup><state-transfer chunk-size="X"/></backup>`) can no longer be `&gt;= 0`,
same as the regular state transfer chunk size.
Previously a value &lt;= 0 would transfer the entire cache in a single batch, which is almost always a bad idea.

== RemoteCache Changes

=== Marshalling Changes
The default marshaller is no longer GenericJbossMarshaller. We now utilise the link:https://github.com/infinispan/protostream[ProtoStream]
library as the default. If Java Serialization is required by clients, we strongly recommend utilising the
link:link:{javadocroot}/org/infinispan/commons/marshall/JavaSerializationMarshaller[JavaSerializationMarshaller] instead.
However if the GenericJbossMarshaller must be used, it's necessary to add the `org.infinispan:infinispan-jboss-marshalling`
artifact to your client's classpath and for the `GenericJbossMarshaller` to be configured as the marshaller.

=== The getBulk methods have been removed
The getBulk method is an expensive method as it requires holding all keys in memory at once and requires a possibly very single result
to populate it. The new retrieveEntries, entrySet, keySet and values methods handle this in a much more efficient way. Therefore the
getBulk methods have been removed in favor of them.

== Persistence changes

* File-based cache stores (SingleFileStore, SoftIndexFileStore, RocksDBStore) filesystem layout has been normalized so that they will use the `GlobalStateConfiguration` persistent location as a default location. Additionally, all stores will now use the cache name as part of the data file/directory naming allowing multiple stores to avoid conflicts and ambiguity.
* The CLI loader (`infinispan-persistence-cli`) has been removed.
* The LevelDB store (`infinispan-cachestore-leveldb`) has been removed. Use the RocksDB store instead, as it is fully backwards compatible.
* The deprecated `singleton` store configuration option and the wrapper class `SingletonCacheWriter` have been removed.
+
Using `shared=true` is enough, as only the primary owner of each key will write to a shared store.

== Client/Server changes

* The Hot Rod client and server only support protocol versions 2.0 and higher. Support for Hot Rod versions 1.0 to 1.3 has been dropped.

== SKIP_LISTENER_NOTIFICATION flag

`SKIP_LISTENER_NOTIFICATION` notification flag has been added in the hotrod client.
This flag only works when the client and the server version is 9.4.15 or higher.
Spring Session integration uses this flag when a session id has changed.
If you are using Spring Session with Infinispan 9.4, consider upgrading the client and the server.

== performAsync header removed from REST

The `performAsync` header was removed from the REST server. Clients that want to perform async operations with
the REST server should manage the request and response on their side to avoid blocking.

== REST status code change

REST operations that don't return resources and are used with `PUT`, `POST` and `DELETE` methods now return status `204` (No content) instead of `200`.

== Default JGroups stacks in the XML configuration

With the introduction of inline XML JGroups stacks in the configuration, two default stacks are always enabled: `udp` and `tcp`.
If you are declaring your own stacks with the same names, an exception reporting the conflict will be thrown. Simply rename
your own configurations to avoid the conflict.

== JGroups S3_PING replaced with NATIVE_S3_PING

Because of changes in AWS's access policy regarding signatures, S3_PING will not work in newer regions and will stop working in older regions too.
For this reason, you should migrate to using NATIVE_S3_PING instead.

== Cache and Cache Manager Listeners can now be configured to be non blocking
Listeners in the past that were sync, always ran in the thread that caused the event. We now allow a Listener method to
be non-blocking in that it will still fire in the original thread, under the assumption that it will return immediately.
Please read the Listener Javadoc for information and examples on this.

== Distributed Streams operations no longer support null values
Distributed Streams has parts rewritten to utilize non blocking reactive streams based operations. As such null values
are not supported as values from operations as per the reactive streams spec. Please utilize other means to denote
a null value.

== Removed the infinispan-cloud module
The infinispan-cloud module has been removed and the `kubernetes`, `ec2`, `google` and `azure` default configurations have been included in `infinispan-core` and can be
referenced as default named JGroups configurations.

== Removed experimental flag GUARANTEED_DELIVERY
Almost as soon as GUARANTEED_DELIVERY was added, UNICAST3 and NAKACK2.resend_last_seqno removed the need for it.
It was always documented as experimental, so we removed it without deprecation and we also removed the RSVP protocol
from the default JGroups stacks.

== Cache Health
The possible statuses of the cache health are now HEALTHY, HEALTHY_REBALANCING and DEGRADED to better
reflect the fact that `rebalancing` doesn't mean a cluster is unhealthy.

== Multi-tenancy

When using multi-tenancy in the WildFly based server, it's necessary to specify the `content-path` for each of the REST connectors, to match the `prefix` element under `multi-tenancy\rest\prefix`.

== OffHeap Automatic Resizing
Off Heap memory containers now will dynamically resize based on number of entries in the container. Due to this the
address count configuration value  is now deprecated for APIs and has been removed from the xml parser.


== Deprecated methods from DataContainer removed
The deprecated methods keySet, values, entrySet and executeTask has been removed.

= Upgrading from 9.3 to 9.4

== Client/Server changes

=== Compatibility mode deprecation

Compatibility mode has been deprecated and will be removed in the next {brandname} version.

To use a cache from multiple endpoints, it is recommended to store data in binary format and to configure the MediaType for keys and values.


If storing data as unmarshalled objects is still desired, the equivalent of compatibility mode is to configure keys and values to store object content:

[source,xml]
----
<encoding>
   <key media-type="application/x-java-object"/>
   <value media-type="application/x-java-object"/>
</encoding>
----

=== Memcached storage

For better interoperability between endpoints, the Memcached server no longer stores keys as `java.lang.String`, but as UTF-8 `byte[]`.

If using memcached, it's recommended to run a rolling upgrade from 9.3 to store data in the new format, or reload the data in the cache.

=== Scripts Response

Distributed scripts with text-based data type no longer return `null` when the result from each server is null. The response is now a JSON array with each individual result, e.g. `"[null, null]"`

=== WebSocket endpoint removal
The WebSocket endpoint has been unmaintained for several years. It has been removed.

=== Hot Rod client connection pool properties
Since the Hot Rod client was overhauled in 9.2, the way the connection pool configuration is handled has changed.
Infinispan 9.4 introduces a new naming scheme for the connection pool properties which deprecates the old _commons-pool_
names. For a complete reference of the available configuration options for the properties file please refer to
link:{javadocroot}/org/infinispan/client/hotrod/configuration/package-summary.html#package.description[remote client configuration] javadoc.

=== Server thread pools
The threads that handle the child Netty event loops have been renamed from *-ServerWorker to *-ServerIO

== Persistence Changes

=== Shared and Passivation

A store cannot be configured as both shared and having passivation enabled.
Doing so can cause data inconsistencies as there is no way to synchronize
data between all the various nodes. As such this configuration will now
cause a startup exception. Please update your configuration as appropriate.

== Query changes

=== AffinityIndexManager

The default number of shards is down to `4`, it was previously equals to the number of segments in the cache.

= Upgrading from 9.2 to 9.3

== AdvancedCacheLoader changes
The AdvancedCacheLoader SPI has been enhanced to provide an alternative method to process and instead allows reactive streams based publishKeys and publishEntries methods which provide benefits in performance, threading and ease of use. Note this change will only affect you if you wish take advantage of it in any custom CacheLoaders you may have implemented.

== Partition Handling Configuration
In 9.3 the default MergePolicy is now MergePolicy.NONE, opposed to MergePolicy.PREFERRED_ALWAYS.

== Stat Changes
We have reverted the stat changes introduced in 9.1, so average values for read, write and removals are once again returned
as milliseconds.

== Event log changes
Several new event log messages have been added, and one message has been removed (ISPN100013).

== Max Idle Expiration Changes
The max idle entry expiration information is sent between owners in the cluster. However when an entry expires via max idle on a given node, this was not replicated (only removing it locally). Max idle has been enhanced to now expire an entry across the entire cluster, instead of per node. This includes ensuring that max idle expiration is applied across all owners (meaning if another node has accessed the entry within the given time it will prevent that entry from expiring on other nodes that didn't have an access).

Max idle in a transactional clustered cache does not remove expired entries on access (although it will not be returned). These entries are only removed via the expiration reaper.

Iteration in a clustered cache will still show entries that are expired via maxIdle to ensure good performance, but could be removed at any point due to expiration reaper.

== WildFly Modules
The {brandname} WildFly modules are now located in the `system/add-ons/{moduleprefix}` dir as per the
link:https://developer.jboss.org/wiki%20/LayeredDistributionsAndModulePathOrganization[WildFly module conventions].

== Deserialization Allow list

Deserialization of content sent by clients to the server are no longer allowed by default.
This applies to JSON, XML, and marshalled byte[] that, depending on the cache configuration, will cause the server
to convert it to Java Objects either to store it or to perform any operation that cannot be done on a byte[] directly.

The deserialization needs to be enabled using system properties, ether by class name or regular expressions:

[source]
----
// Comma separated list of fully qualified class names
-Dinfinispan.deserialization.allowlist.classes=java.time.Instant,com.myclass.Entity

// Regex expression
-Dinfinispan.deserialization.allowlist.regexps=.*
----

= Upgrading from 9.0 to 9.1

== Kubernetes Ping changes

The latest version of Kubernetes Ping uses unified environmental variables for both Kubernetes and OpenShift.
Some of them were shortened for example `OPENSHIFT_KUBE_PING_NAMESPACE` was changed to `KUBERNETES_NAMESPACE`.
Please refer to link:https://github.com/jgroups-extras/jgroups-kubernetes/blob/master/README.adoc[Kubernetes Ping documentation].

== Stat Changes
Average values for read, write and removals are now returned in Nanoseconds, opposed to Milliseconds.

== (FineGrained)AtomicMap reimplemented

Infinispan now contains a new implementation of both `AtomicMap` and `FineGrainedAtomicMap`, but the semantics has been preserved. The new implementation does not use `DeltaAware` interface but the Functional API instead.

There are no changes needed for `AtomicMap`, but it now supports non-transactional use case as well.

`FineGrainedAtomicMap` now uses the Grouping API and therefore you need to enable groups in configuration. Also it holds entries as regular cache entries, plus one cache entry for cached key set (the map itself). Therefore the cache size or iteration/streaming results may differ. Note that fine grained atomic maps are still supported on transactional caches only.

== RemoteCache keySet/entrySet/values

RemoteCache now implements all of the collection backed methods from `Map` interface.
Previously `keySet` was implemented, however it was a deep copy. This has now changed
and it is a backing set. That is that the set retrieves the updated values on each
invocation or updates to the backing remote cache for writes. The entrySet and values
methods are also now supported as backing variants as well.

If you wish to have a copy like was provided before it is recommended to copy the
contents into a in memory local set such as

[source,java]
----
Set<K> keysCopy = remoteCache.keySet().stream().collect(Collectors.toSet());
----

== DeltaAware deprecated

Interfaces `DeltaAware`, `Delta` and `CopyableDeltaAware` have been deprecated. Method `AdvancedCache.applyDelta()` has been deprecated and the implementation does not allow custom set of locked keys. `ApplyDeltaCommand` and its uses in interceptor stack are deprecated.

Any partial updates to an entry should be replaced using the Functional API.

== {brandname} Query Configuration

The configuration property `directory_provider` now accepts a new value `local-heap`.
This value replaces the now deprecated `ram`, and as its predecessor will cause the index to be stored in a `org.apache.lucene.store.RAMDirectory`.

The configuration value `ram` is still accepted and will have the same effect, but failing to replace `ram` with `local-heap` will cause a warning to be logged.
We suggest to perform this replacement, as the `ram` value will no longer be recognised by {brandname} in a future version.

This change was made as the team believes the `local-heap` name better expresses the storage model, especially as this storage method will not allow real-time replication of the index across multiple nodes.
This index storage option is mostly useful for single node integration testing of the query functionality.

== Store Batch Size Changes
TableManipulation::batchSize and JpaStoreConfiguration::batchSize have been deprecated and replaced by the higher level AbstractStoreConfiguration::maxBatchSize.

== Partition Handling changes
In Infinispan 9.1 partition handling has been improved to allow for automatic conflict resolution on partition merges. Consequently,
PartitionHandlingConfiguration::enabled has been deprecated in favour of PartitionHandlingConfiguration::whenSplit.
Configuring whenSplit to the DENY_READ_WRITES strategy is equivalent to setting enabled to true, whilst specifying
ALLOW_READ_WRITES is equivalent to disabling partition handling (default).

Furthermore, during a partition merge with ALLOW_READ_WRITES, the default EntryMergePolicy is
MergePolicies.PREFERRED_ALWAYS which provides a deterministic way of tie-breaking CacheEntry conflicts.
If you require the old behaviour, simply set the merge-policy to null.

= Upgrading from 8.x to 9.0

== Default transaction mode changed

The default configuration for transactional caches changed from `READ_COMMITTED` and `OPTIMISTIC` locking to `REPEATABLE_READ` and `OPTIMISTIC` locking with `write-skew` enabled.

Also, using the `REPEATABLE_READ` isolation level and `OPTIMISTIC` locking without `write-skew` enabled is no longer allowed.
To help with the upgrade, `write-skew` will be automatically enabled in this case.

The following configuration has been deprecated:

* `write-skew`: as said, it is automatically enabled.
* `<versioning>` and its attributes. It is automatically enabled and configured when needed.

== Removed eagerLocking and eagerLockingSingleNode configuration settings
Both were deprecated since version 5.1.
`eagerLocking(true)` can be replaced with `lockingMode(LockingMode.PESSIMISTIC)`,
and `eagerLockingSingleNode()` does not need a replacement because it was a no-op.

== Removed async transaction support

Asynchronous mode is no longer supported in transactional caches and it will automatically use the synchronous cache mode.
In addition, the second phase of a transaction commit is done synchronously.
The following methods (and related) are deprecated:

* `TransactionConfigurationBuilder.syncCommitPhase(boolean)`
* `TransactionConfigurationBuilder.syncRollbackPhase(boolean)`

== Deprecated all the dummy related transaction classes.
The following classes have been deprecated and they will be removed in the future:

* `DummyBaseTransactionManager`: replaced by `EmbeddedBasedTransactionManager`;
* `DummyNoXaXid` and `DummyXid`: replaced by `EmbeddedXid`;
* `DummyTransaction`: replaced by `EmbeddedTransaction`;
* `DummyTransactionManager`: replaced by `EmbeddedTransactionManager`;
* `DummyTransactionManagerLookup` and `RecoveryDummyTransactionManagerLookup`: replaced by `EmbeddedTransactionManagerLookup`;
* `DummyUserTransaction`: replaced by `EmbeddedUserTransaction`;

== Clustering configuration changes
The `mode` attribute in the XML declaration of clustered caches is no longer mandatory. It defaults to SYNC.

== Default Cache changes
Up to Infinispan 8.x, the default cache always implicitly existed, even if not declared in the XML configuration.
Additionally, the default cache configuration affected all other cache configurations, acting as some kind of base template.
Since 9.0, the default cache only exists if it has been explicitly configured. Additionally, even if it has been specified,
it will never act as base template for other caches.

== Marshalling Enhancements and Store Compatibility
Internally Infinispan 9.x has introduced many improvements to its marshalling codebase in order to improve performance
and allow for greater flexibility. Consequently, data marshalled and persisted by Infinispan 8.x is no longer compatible with Infinispan 9.0.
To aid you in migrating your existing stores to 9.0, we have provided a Store Migrator, however at present this only allows the migration of JDBC stores.

== New Cloud module for library mode
In Infinispan 8.x, cloud related configuration were added to `infinispan-core` module. Since 9.0 they were moved to `infinispan-cloud` module.

== Entry Retriever is now removed
The entry retriever feature has been removed.  Please update to use the new Streams feature detailed in the User Guide.
The `org.infinispan.filter.CacheFilters` class can be used to convert `KeyValueFilter` and `Converter` instances
into proper Stream operations that are able to be marshalled.

== Map / Reduce is now removed
Map reduce has been removed in favor of the new Streams feature which should provide more features and performance.
There are no bridge classes to convert to the new streams and all references must be rewritten.

== Spring 4 support is now removed
Spring 4 is no longer supported.

== Function classes have moved packages
The class `SerializableSupplier` has moved from the `org.infinispan.stream`
package to the `org.infinispan.util.function` package.

The class `CloseableSupplier` has moved from the `org.infinispan.util`
package to the `org.infinispan.util.function` package.

The classes `TriConsumer`, `CloseableSupplier`, `SerializableRunnable`,
`SerializableFunction` & `SerializableCallable` have all been moved from
the `org.infinispan.util` package to the `org.infinispan.util.function` package.

== SegmentCompletionListener interface has moved
The interface `SegmentCompletionListener` has moved from the interface
`org.infinispan.CacheStream` to the new `org.infinispan.BaseCacheStream`.

== Spring module dependency changes
All Infinispan, Spring and Logger dependencies are now in the `provided` scope. One can decide whether to use small jars or uber jars but they need to be added to the classpath of the application.
It also gives one freedom in choosing Spring (or Spring Boot) version.

Here is an example:
[source,xml]
----
<dependencies>
   <dependency>
      <groupId>org.infinispan</groupId>
      <artifactId>infinispan-embedded</artifactId>
   </dependency>
   <dependency>
      <groupId>org.infinispan</groupId>
      <artifactId>infinispan-spring5-embedded</artifactId>
   </dependency>
   <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
   </dependency>
   <dependency>
      <groupId>org.springframework.session</groupId>
      <artifactId>spring-session</artifactId>
   </dependency>
</dependencies>
----

Additionally there is no Logger implementation specified (since this may vary depending on use case).

== Total order executor is now removed
The total order protocol now uses the `remote-command-executor`. The attribute `total-order-executor` in `<container>` tag is removed.

== HikariCP is now the default implementation for JDBC PooledConnectionFactory
link:https://github.com/brettwooldridge/HikariCP[HikariCP] offers superior performance to c3p0 and is now the default implementation.
Additional properties for HikariCP can be provided by placing a `hikari.properties` file on the classpath or by specifying
the path to the file via `PooledConnectionFactoryConfiguration.propertyFile` or `properties-file` in the connection pool's
xml config. N.B. a properties file specified explicitly in the configuration is loaded instead of the `hikari.properties`
file on the class path and Connection pool characteristics which are explicitly set in PooledConnectionFactoryConfiguration
always override the values loaded from a properties file.

Support for c3p0 has been deprecated and will be removed in a future release. Users can force c3p0 to be utilised as before
by providing the system property `-Dinfinispan.jdbc.c3p0.force=true`.

== RocksDB in place of LevelDB
The LevelDB cache store was replaced with a link:http//rocksdb.org[RocksDB]. RocksDB is a fork of LevelDB which provides
superior performance in high concurrency scenarios. The new cache store can parse old LevelDB configurations but will always use
the RocksDB implementation.

== JDBC Mixed and Binary stores removed
The JDBC Mixed and Binary stores have been removed due to the poor performance associated with storing entries in buckets.
Storing entries in buckets is non-optimal as each read/write to the store requires an existing bucket for a given hash to be retrieved,
deserialised, updated, serialised and then re-inserted back into the db.  If you were previously using one of the removed
stores, we have provided a migrator tool to assist in migrating data from an existing binary table to a JDBC string based
store.

== @Store Annotation Introduced
A new annotation, `@Store`, has been added for persistence stores. This allows a store's properties to be
explicitly defined and validated against the provided store configuration.  Existing stores should be updated to use this
annotation and the store's configuration class should also declare the `@ConfigurationFor` annotation.  If neither of these
annotations are present on the store or configuration class, then a your store will continue to function as before, albeit
with a warning that additional store validation cannot be completed.

== Server authentication changes
The no-anonymous policy is now automatically enabled for Hot Rod authentication unless explicitly specified.

== Package org.infinispan.util.concurrent.jdk8backported has been removed
=== Moved classes
Classes regarding EntrySizeCalculator have now been moved down to the org.infinispan.util package.

=== Removed classes
The *ConcurrentHashMapV8 classes and their supporting classes have all been removed. The
CollectionFactory#makeBoundedConcurrentMap method should be used if you desire to have a
bounded ConcurrentMap.

== Store as Binary is deprecated
Store as Binary configuration is now deprecated and will be removed in a future release. This is replaced by
the new memory configuration.

== DataContainer collection methods are deprecated
The keySet, entrySet and values methods on DataContainer have been deprecated. These behavior of these methods
are very inconsistent and will be removed later. It is recommended to update references to use iterator or
iteratorIncludingExpired methods instead.

= Upgrading from 8.1 to 8.2
== Entry Retriever is deprecated
Entry Retriever is now deprecated and will be removed in Infinispan 9.  This is replaced by the new Streams feature.

== Map / Reduce is deprecated
Map reduce is now deprecated and will be removed in Infinispan 9.  This is replaced by the new Streams feature.

= Upgrading from 8.x to 8.1
== Packaging changes
=== CDI module split
CDI module (GroupId:ArtifactId `org.infinispan:infinispan-cdi`) has been split into `org.infinispan:infinispan-cdi-embedded` and `org.infinispan:infinispan-cdi-remote`. Please make sure that you use proper artifact.

=== Spring module split
Spring module (GroupId:ArtifactId `org.infinispan:infinispan-spring5`) has been split into `org.infinispan:infinispan-spring5-embedded` and `org.infinispan:infinispan-spring5-remote`. Please make sure that you use proper artifact.

== Spring 3 support is deprecated
Spring 3 support (GroupId:ArtifactId `org.infinispan:infinispan-spring`) is deprecated. Please consider migrating into Spring 4 support.

= Upgrading from 7.x to 8.0
== Configuration changes
=== Removal of Async Marshalling
Async marshalling has been entirely dropped since it was never reliable enough. The "async-marshalling" attribute has been removed from the 8.0 XML schema and will be ignored when parsing 7.x configuration files. The programmatic configuration methods related to asyncMarshalling/syncMarshalling are now deprecated and have no effect aside from producing a WARN message in the logs.

=== Reenabling of isolation level configurations in server
Because of the inability to configure write skew in the server, the isolation level attribute was ignored and defaulted to READ_COMMITTED. Now, when enabling REPEATABLE_READ together with optimistic locking, write skew is enabled by default in local and synchronous configurations.

=== Subsystem renaming in server
In order to avoid conflict and confusion with the similar subsystems in WildFly, we have renamed the following subsystems in server:
* infinispan -> datagrid-infinispan
* jgroups -> datagrid-jgroups
* endpoint -> datagrid-infinispan-endpoint

=== Server domain mode
We no longer support the use of standalone mode for running clusters of servers. Domain mode (bin/domain.sh) should be used instead.

= Upgrading from 6.0 to 7.0
== API Changes

=== Cache Loader
To be more inline with JCache and java.util.collections interfaces we have changed the first argument type for the CacheLoader.load & CacheLoader.contains methods to be Object from type K.

=== Cache Writer
To be more inline with JCache and java.util.collections interfaces we have changed the first argument type for the CacheWriter.delete method to be Object from type K.

=== Filters

Over time Infinispan added 2 interfaces with identical names and almost identical methods.  The org.infinispan.notifications.KeyFilter and org.infinispan.persistence.spi.AdvancedCacheLoader$KeyFilter interfaces.

Both of these interfaces are used for the sole purpose of filtering an entry by it's given key.  Infinispan 7.0 has also introduced the KeyValueFilter which is similar to both but also can filter on the entries value and/or metadata.

As such all of these classes have been moved into a new package org.infinispan.filter and all of their related helper classes.

The new org.infinispan.filter.KeyFilter interface has replaced both of the previous interfaces and all previous references use the new interface.

== Declarative configuration

The XML schema for the embedded configuration has changed to more closely follow the server configuration. Use the `config-converter.sh` or `config-converter.bat` scripts to convert an Infinispan 6.0 to the current format.

= Upgrading from 5.3 to 6.0
== Declarative configuration
In order to use all of the latest features, make sure you change the namespace declaration at the top of your XML configuration files as follows:

[source,xml]
----
<infinispan xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:infinispan:config:6.0 https://infinispan.org/schemas/infinispan-config-6.0.xsd" xmlns="urn:infinispan:config:6.0">
   ...
</infinispan>
----

== Deprecated API removal

* Class `org.infinispan.persistence.remote.wrapperEntryWrapper`.

* Method `ObjectOutput startObjectOutput(OutputStream os, boolean isReentrant)` from class
`org.infinispan.commons.marshall.StreamingMarshaller`.

* Method `CacheEntry getCacheEntry(Object key, EnumSet<Flag> explicitFlags, ClassLoader explicitClassLoader)` from class
`org.infinispan.AdvancedCache`.
Please use instead: `AdvanceCache.withFlags(Flag... flags).with(ClassLoader classLoader).getCacheEntry(K key)`.

* Method `AtomicMap<K, V> getAtomicMap(Cache<MK, ?> cache, MK key, FlagContainer flagContainer)` from class
`org.infinispan.atomic.AtomicMapLookup`.
Please use instead `AtomicMapLookup.getAtomicMap(cache.getAdvancedCache().withFlags(Flag... flags), MK key)`.

* Package `org.infinispan.config` (and all methods involving the old configuration classes).
All methods removed has an overloaded method which receives the new configuration classes as parameters.

NOTE: This only affects the programmatic configuration.

* Class `org.infinispan.context.FlagContainer`.

* Method `boolean isLocal(Object key)` from class `org.infinispan.distribution.DistributionManager`.
Please use instead `DistributionManager.getLocality(Object key)`.

* JMX operation `void setStatisticsEnabled(boolean enabled)` from class `org.infinispan.interceptors.TxInterceptor`
Please use instead the `statisticsEnabled` attribute.

* Method `boolean delete(boolean synchronous)` from class `org.infinispan.io.GridFile`.
Please use instead `GridFile.delete()`.

* JMX attribute `long getLocallyInterruptedTransactions()` from class
`org.infinispan.util.concurrent.locks.DeadlockDetectingLockManager`.

=  Upgrading from 5.2 to 5.3
== Declarative configuration
In order to use all of the latest features, make sure you change the namespace declaration at the top of your XML configuration files as follows:

[source,xml]
----
<infinispan xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:infinispan:config:5.2 https://infinispan.org/schemas/infinispan-config-5.2.xsd" xmlns="urn:infinispan:config:5.3">
   ...
</infinispan>
----

= Upgrading from 5.1 to 5.2
== Declarative configuration
In order to use all of the latest features, make sure you change the namespace declaration at the top of your XML configuration files as follows:

[source,xml]
----
<infinispan xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:infinispan:config:5.2 https://infinispan.org/schemas/infinispan-config-5.2.xsd" xmlns="urn:infinispan:config:5.2">
   ...
</infinispan>
----

== Transaction

The default transaction enlistment model has changed ( link:https://issues.jboss.org/browse/ISPN-1284[ISPN-1284] ) from link:{jdkdocroot}/javax/transaction/xa/XAResource.html[`XAResource`] to link:{jdkdocroot}/javax/transaction/Synchronization.html[`Synchronization`].
Also now, if the `XAResource` enlistment is used, then recovery is enabled by default.

In practical terms, if you were using the default values, this should not cause any backward compatibility issues but an increase in performance of about 5-7%. However in order to use the old configuration defaults, you need to configure the following:

[source,xml]
----
<transaction useSynchronization="false">
   <recovery enabled="false"/>
</transaction>
----

or the programmatic configuration equivalent:

[source,java]
----
ConfigurationBuilder builder = new ConfigurationBuilder();
builder.transaction().useSynchronization(false).recovery().enabled(false)
----

== Cache Loader and Store configuration

Cache Loader and Store configuration has changed greatly in Infinispan 5.2.

== Virtual Nodes and Segments

The concept of Virtual Nodes doesn't exist anymore in Infinispan 5.2 and has been replaced by Segments.

=  Upgrading from 5.0 to 5.1
== API

The cache and cache manager hierarchies have changed slightly in 5.1 with the introduction of
link:https://docs.jboss.org/infinispan/5.1/apidocs/org/infinispan/api/BasicCache.html[`BasicCache`]
and
link:https://docs.jboss.org/infinispan/5.1/apidocs/org/infinispan/api/BasicCacheContainer.html[`BasicCacheContainer`]
, which are parent classes of existing
link:https://docs.jboss.org/infinispan/5.1/apidocs/org/infinispan/Cache.html[`Cache`]
and
link:https://docs.jboss.org/infinispan/5.1/apidocs/org/infinispan/manager/CacheContainer.html[`CacheContainer`]
classes respectively. What's important is that Hot Rod clients must now code
against `BasicCache` and `BasicCacheContainer` rather than `Cache` and `CacheContainer`.
So previous code that was written like this will no longer compile.

[source,java]
.WontCompile.java
----
import org.infinispan.Cache;
import org.infinispan.manager.CacheContainer;
import org.infinispan.client.hotrod.RemoteCacheManager;
...
CacheContainer cacheContainer = new RemoteCacheManager();
Cache cache = cacheContainer.getCache();
----

Instead, if Hot Rod clients want to continue using interfaces higher up the hierarchy from the remote cache/container classes, they'll have to write:

[source,java]
.Correct.java
----
import org.infinispan.BasicCache;
import org.infinispan.manager.BasicCacheContainer;
import org.infinispan.client.hotrod.RemoteCacheManager;
...
BasicCacheContainer cacheContainer = new RemoteCacheManager();
BasicCache cache = cacheContainer.getCache();
----

However, previous code that interacted against the `RemoteCache` and `RemoteCacheManager` will work as it used to:

[source,java]
.AlsoCorrect.java
----
import org.infinispan.client.hotrod.RemoteCache;
import org.infinispan.client.hotrod.RemoteCacheManager;
...
RemoteCacheManager cacheContainer = new RemoteCacheManager();
RemoteCache cache = cacheContainer.getCache();
----

== Eviction and Expiration

* The eviction XML element no longer defines the `wakeUpInterval` attribute. This is now configured via the `expiration` element:

[source,xml]
----
<expiration wakeUpInterval="60000"... />
----

Eviction's `maxEntries` is used as guide for the entire cache, but eviction happens on a per cache segment, so when the segment is full, the segment is evicted. That's why `maxEntries` is a theoretical limit but in practical terms, it'll be a bit less than that. This is done for performance reasons.

== Transactions

* A cache marked as `TRANSACTIONAL` cannot be accessed outside of a transaction, and a `NON_TRANSACTIONAL` cache cannot be accessed within a transaction. In 5.0, a transactional cache would support non-transactional calls as well.  This change was done to be in-line with expectations set out in link:https://github.com/jsr107[JSR-107] as well as to provide more consistent behavior.

* In 5.0, commit and rollback phases were asynchronous by default. Starting with 5.1, these are now synchronous by default, to provide the guarantees required by a single lock-owner model.

== State transfer
One of the big changes we made in 5.1 was to use the same push-based state transfer we introduced in 5.0 both for rehashing in distributed mode and for state retrieval in replicated mode. We even borrow the consistent hash concept in replicated mode to transfer state from all previous cache members at once in order to speed up transfer.

As a consequence we've unified the state transfer configuration as well, there is now a `stateTransfer` element containing a simplified state transfer configuration. The corresponding attributes in the `stateRetrieval` and `hash` elements have been deprecated, as have been some attributes that are no longer used.

== Configuration
If you use XML to configure Infinispan, you shouldn't notice any change, except a much faster startup, courtesy of the link:http://en.wikipedia.org/wiki/StAX[StAX] based parser. However, if you use programmatic configuration, read on for the important differences.

Configuration is now packaged in `org.infinispan.configuration`, and you must use a fluent, builder style:

[source,java]
----

Configuration c1 = new ConfigurationBuilder()
   // Adjust any configuration defaults you want
   .clustering()
      .l1()
         .disable()
      .mode(DIST_SYNC)
      .hash()
         .numOwners(5)
   .build();

----

* The old javabean style configuration is now deprecated and will be removed in a later version.
* Configuration properties which can be safely changed at runtime are mutable, and all others are immutable.
* To copy a configuration, use the `read()` method on the builder, for example:

[source,java]
----

Configuration c2 = new ConfigurationBuilder()
   // Read in C1 to provide defaults
   .read(c1)
   .clustering()
      .l1()
         .enable()
   // This cache is DIST_SYNC, will have 5 owners, with L1 cache enabled
   .build();

----

This completely replaces the old system of defining a set of overrides on bean properties. Note that this means the behaviour of Infinispan configuration is somewhat different when used programmatically. Whilst before, you could define a default configuration, and any overrides would be applied on top of _your_ defaults when defined, now you must explicitly read in your defaults to the builder. This allows for much greater flexibility in your code (you can have a as many "default" configurations as you want), and makes your code more explicit and type safe (finding references works).

The schema is unchanged from before. Infinispan 4.0 configurations are currently not being parsed. To upgrade, just change the schema definition from:

[source,xml]
----

<infinispan
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="urn:infinispan:config:4.1 https://infinispan.org/schemas/infinispan-config-4.1.xsd"
     xmlns="urn:infinispan:config:4.1">

----

to

[source,xml]
----

<infinispan
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="urn:infinispan:config:5.1 https://infinispan.org/schemas/infinispan-config-5.1.xsd"
     xmlns="urn:infinispan:config:5.1">

----

The schema documentation has changed format, as it is now produced using the standard tool `xsddoc`. This should be a significant improvement, as better navigation is offered. Some elements and attributes are missing docs right now, we are working on adding this. As an added benefit, your IDE should now show documentation when an xsd referenced (as above)

We are in the process of adding in support for this configuration style for modules (such as cache stores). In the meantime, please use the old configuration or XML if you require support for cache store module configuration.

== Flags and ClassLoaders

The `Flags` and `ClassLoader` API has changed. In the past, the following would work:

[source,java]
----
 cache.withFlags(f1, f2); cache.withClassLoader(cl); cache.put(k, v);
----

In 5.1.0, these `withX()` methods return a new instance and not the cache itself, so thread locals are avoided and the code above will not work. If used in a fluent manner however, things still work:

[source,java]
----
cache.withFlags(f1, f2).withClassLoader(cl).put(k, v);
----

The above pattern has always been the intention of this API anyway.

== JGroups Bind Address

Since upgrading to JGroups 3.x, `-Dbind.address` is ignored. This should be replaced with `-Djgroups.bind_addr`.
