Skip to content

Update property defaults and deprecate old properties #2495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
agoerler merged 21 commits into from
Jun 19, 2026
Merged

Update property defaults and deprecate old properties #2495

Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
b6bced6
Update migration.md with property and API changes
StefanHenke Mar 31, 2026
14b60f0
Update property defaults and deprecate old properties
StefanHenke Apr 8, 2026
d71ef57
Adjust property defaults and update deprecations
StefanHenke Apr 8, 2026
a135512
Update migration.md
agoerler Apr 20, 2026
e828ced
Update migration.md
StefanHenke Apr 22, 2026
32be825
Update migration.md
StefanHenke Apr 29, 2026
3050e51
Update migration.md
StefanHenke Apr 29, 2026
763985e
Update migration.md
StefanHenke Apr 29, 2026
8b63344
docs(java): merge property changes from java-migration-4.9-to-5.0-pro…
rjayasinghe Jun 2, 2026
c99e2e9
Update java/migration.md
agoerler Jun 3, 2026
f7dadf0
Update java/migration.md
agoerler Jun 5, 2026
2a0bb30
Update migration.md
agoerler Jun 9, 2026
eeaf348
Align migration table with cds-services main (post 5.0.0-SNAPSHOT rev…
rjayasinghe Jun 16, 2026
9451017
Merge remote-tracking branch 'origin/main' into StefanHenke-patch-3
rjayasinghe Jun 16, 2026
07c2f49
add links to properties
agoerler Jun 19, 2026
92966e7
Update migration.md
agoerler Jun 19, 2026
954becd
Update migration.md
agoerler Jun 19, 2026
e6766ca
Merge branch 'main' into StefanHenke-patch-3
agoerler Jun 19, 2026
3513de5
Update migration.md
agoerler Jun 19, 2026
692ff44
Update java/migration.md
agoerler Jun 19, 2026
29d2c03
Apply suggestions from code review
agoerler Jun 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 41 additions & 17 deletions java/migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,47 +72,71 @@ CAP Java 5.0 increased some minimum required versions:
| XSUAA (BTP Security Library) | 4.0.0 |
| Maven | 3.9.14 |

<!-- ### Adjusted Property Defaults
### Adjusted Property Defaults
<div id="adjusted-defaults-4-to-5" />

Some property defaults have been adjusted:

| Property | Old Value | New Value | Explanation |
| --- | --- | --- | --- |
| `abc` | false | true | Any description. |
| [cds.errors.preferServiceException](../developing-applications/properties#cds-errors-preferServiceException) | `false` | `true` | `ServiceException` is now preferred over generic exceptions when mapping errors to HTTP responses. |
| [cacheRefreshInterval](../developing-applications/properties#cds-multiTenancy-serviceManager-cacheRefreshInterval) | `PT20M` (20 min) | `PT60M` (60 min) | The service manager cache is now refreshed less frequently to reduce overhead. |
| [cds.outbox.services.&lt;key&gt;.ordered](../developing-applications/properties#cds-outbox-services-%3Ckey%3E-ordered) | `true` | `false` | Outbox instances now process entries in parallel by default. Set to `true` to restore ordered, single-threaded processing. |
| [enforceTransactional](../developing-applications/properties#cds-persistence-changeSet-enforceTransactional) | `true` | `false` | Transactional enforcement for change sets is now opt-in. |
| `cds.query.deepEntityReadonly` | `false` | `true` | Readonly handling is now enforced for deep entity reads by default. |
| [cds.query.restrictions.enabled](../developing-applications/properties#cds-query-restrictions) | `false` | `true` | |
| [cds.security.authentication.mode](../developing-applications/properties#cds-security-authentication) | `model-strict` | `model-relaxed` | Authentication mode now defaults to `model-relaxed`, which only enforces authentication for endpoints protected via `@requires` or `@restrict`. |
| [cds.sql.hana.search.fuzzy](../developing-applications/properties#cds-sql-hana-search-fuzzy) | `false` | `true` | Fuzzy search is now enabled on HANA by default |
| [cds.sql.toOnePath.mode](../developing-applications/properties#cds-sql-toOnePath-mode) | `always-join` | `optimize` | SQL generation now avoids joins for to-one path expressions when a FK column can be selected directly, improving query performance. |


### Deprecated Properties
<div id="deprecated-properties-4-to-5 " />

The following properties have been deprecated and might be removed in a future major version:

- `abd`

The functionality provided by these properties is enabled by default. This reflects its intended behavior once the properties are deleted in future releases.
| Deprecated Property | Explanation |
| --- | --- |
| `cds.dashboard.*` | The entire `cds.dashboard` configuration namespace is deprecated and may be removed in a future major version. |
| [cds.outbox.inMemory.emitDuringChangeSetContext](../developing-applications/properties#cds-outbox-inMemory-emitDuringChangeSetContext) | The functionality provided by this property is enabled by default and there is no reason to switch it off. |
| [cds.outbox.inMemory.enabled](../developing-applications/properties#cds-outbox-inMemory-enabled) | The functionality provided by this property is enabled by default and there is no reason to switch it off. |

### Removed Properties
<div id="removed-properties-4-to-5 " />

The following table gives an overview about the removed properties:

| Removed Property | Replacement / Explanation |
| --- | --- |
| `abc` | Any description about replacement | -->
| `cds.errors.combined` | Was deprecated since CAP Java 4.0. The property had no effect anymore and has been removed. |
| `cds.mcp.autoConfig` | Replaced by `cds.mcp.autoWired`. |
| `cds.multiTenancy.serviceManager` `.acceptInstancesWithoutTenant` | Removed. No replacement — silent breaking change. |
| `cds.multiTenancy.serviceManager` `.ignoreDuplicateTenantInstances` | Removed. No replacement — silent breaking change. |
| `cds.odataV2.searchMode` | Removed. The runtime now behaves as if `pass-through` was set (the search string is passed through to the data store). The property has no effect anymore. Remove any configured value. |
| `cds.odataV4.searchMode` | Removed. The runtime now behaves as if `pass-through` was set (the search string is passed through to the data store). The property has no effect anymore. Remove any configured value. |
| `cds.sql.collate` | Removed. The property had no documented effect and was never exposed. Remove any configured value. |
| `cds.sql.hana.optimizationMode` | Was deprecated since CAP Java 4.0. SAP HANA's HEX engine is used ever since. |
| `cds.sql.search.mode`| Replaced by `cds.sql.search.localized` with value `view` to change the default. `generic` is not supported anymore. |
| `cds.taskScheduler.enabled` | Replaced by `cds.outbox.persistent.scheduler.enabled`. |

### Removed Java APIs { #removed-java-apis-4-to-5 }

Removed deprecated methods:

| Removed method | Replacement / Explanation |
|--------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| `c.s.c.feature.ucl.services.AssignEventContext.setUclResult(SpiiResult)` | `setResult(SpiiResult)` |
| `c.s.c.feature.ucl.services.AssignEventContext.getUclResult()` | `getResult()` |
| `c.s.c.services.mt.SaaSRegistryDependency.getAppId()` | `getXsappname()` |
| `c.s.c.services.mt.SaaSRegistryDependency.setAppId(String appId)` | `setXsappname(appId)` |
| `c.s.c.services.mt.SaaSRegistryDependency.getAppName()` | `getXsappname()` |
| `c.s.c.services.mt.SaaSRegistryDependency.setAppName(String appName)` | `setXsappname(appName)` |
| `c.s.c.services.ServiceExceptionUtils.getLocalizedMessage (String code, Object[] args, Locale locale)` | `getLocalizedMessage(code, args, locale, true)` (pass `true` for `errorStatusFallback` to keep the previous behavior) |
| `c.s.c.services.ServiceExceptionUtils.getMessageTarget(Path path, CdsElement element)` | `MessageTarget.create(path, element)` |
| `c.s.c.services.ServiceExceptionUtils.getMessageTarget(String target)` | `MessageTarget.create(target)` |
| `c.s.c.services.ServiceExceptionUtils.getMessageTarget(String parameter, Class type, Function path)` | `MessageTarget.create(parameter, type, path)` |
| `c.s.c.services.ServiceExceptionUtils.getMessageTarget(String parameter, Function path)` | `MessageTarget.create(parameter, path)` |
| `c.s.c.feature.ucl.services.AssignEventContext` `.getUclResult()` | `getResult()` |
| `c.s.c.feature.ucl.services.AssignEventContext` `.setUclResult(SpiiResult)` | `setResult(SpiiResult)` |
| `c.s.c.reflect.CdsEntity.isAbstract()` | always `false` |
| `c.s.c.services.mt.SaaSRegistryDependency` `.getAppId()` | `getXsappname()` |
| `c.s.c.services.mt.SaaSRegistryDependency` `.setAppId(String appId)` | `setXsappname(appId)` |
| `c.s.c.services.mt.SaaSRegistryDependency` `.getAppName()` | `getXsappname()` |
| `c.s.c.services.mt.SaaSRegistryDependency` `.setAppName(String appName)` | `setXsappname(appName)` |
| `c.s.c.services.ServiceExceptionUtils` `.getLocalizedMessage (String code, Object[] args, Locale locale)` | `getLocalizedMessage(code, args, locale, true)` (pass `true` for `errorStatusFallback` to keep the previous behavior) |
| `c.s.c.services.ServiceExceptionUtils` `.getMessageTarget(Path path, CdsElement element)` | `MessageTarget.create(path, element)` |
| `c.s.c.services.ServiceExceptionUtils` `.getMessageTarget(String target)` | `MessageTarget.create(target)` |
| `c.s.c.services.ServiceExceptionUtils` `.getMessageTarget(String parameter, Class type, Function path)` | `MessageTarget.create(parameter, type, path)` |
| `c.s.c.services.ServiceExceptionUtils` `.getMessageTarget(String parameter, Function path)` | `MessageTarget.create(parameter, path)` |

### Changes in the `cds-maven-plugin`

Expand Down
Loading