Add upgrade notes for latest changes
Project: http://git-wip-us.apache.org/repos/asf/cayenne/repo Commit: http://git-wip-us.apache.org/repos/asf/cayenne/commit/cd41bec9 Tree: http://git-wip-us.apache.org/repos/asf/cayenne/tree/cd41bec9 Diff: http://git-wip-us.apache.org/repos/asf/cayenne/diff/cd41bec9 Branch: refs/heads/master Commit: cd41bec98aea90b71dc5eb1fb0a7a7319960839b Parents: a416533 Author: Nikita Timofeev <stari...@gmail.com> Authored: Tue May 30 17:54:58 2017 +0300 Committer: Nikita Timofeev <stari...@gmail.com> Committed: Tue May 30 17:54:58 2017 +0300 ---------------------------------------------------------------------- docs/doc/src/main/resources/UPGRADE.txt | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cayenne/blob/cd41bec9/docs/doc/src/main/resources/UPGRADE.txt ---------------------------------------------------------------------- diff --git a/docs/doc/src/main/resources/UPGRADE.txt b/docs/doc/src/main/resources/UPGRADE.txt index a1f08f9..f241f00 100644 --- a/docs/doc/src/main/resources/UPGRADE.txt +++ b/docs/doc/src/main/resources/UPGRADE.txt @@ -19,11 +19,13 @@ UPGRADING TO 4.0.M6 - switch usages of @Auditable to @CommitLog - change usages of renamed classes, here is two classes most likely used by your code: PostCommitListener -> CommitLogListener - PostCommitModuleBuilder -> CommitLogModuleBuilder + PostCommitModuleBuilder -> CommitLogModuleExtender - fix all imports for renamed packages: org.apache.cayenne.lifecycle.postcommit -> org.apache.cayenne.commitlog org.apache.cayenne.lifecycle.changemap -> org.apache.cayenne.commitlog.model - - change CommitLogModuleBuilder method auditableEntitiesOnly() to commitLogAnnotationEntitiesOnly() + - change CommitLogModuleExtender methods: + auditableEntitiesOnly() -> commitLogAnnotationEntitiesOnly() + build() -> module() * Per CAY-2280 Cayenne migrated from commons-logging to SLF4J. Here is options you have to upgrade your project accordingly: @@ -39,11 +41,14 @@ UPGRADING TO 4.0.M6 were renamed to Slf4jJdbcEventLogger and FormattedSlf4jJdbcEventLogger respectively. Internally they are using now org.apache.cayenne.log.JdbcEventLogger interface as a logger name. -* Per CAY-2278 The org.apache.cayenne.lifecycle.audit package (with the exception of Auditable and - AuditableChild annotations) and the org.apache.cayenne.lifecycle.changeset package where deprecated. +* Per CAY-2278 Packages org.apache.cayenne.lifecycle.audit and org.apache.cayenne.lifecycle.changeset where deprecated. + Please use instead cayenne-commitlog module and its new @CommitLog annotation. + Weighted graph sorter moved to cayenne-server into org.apache.cayenne.ashwood package. - Packages org.apache.cayenne.lifecycle.changemap, org.apache.cayenne.lifecycle.postcommit + + Packages org.apache.cayenne.lifecycle.changemap and org.apache.cayenne.lifecycle.postcommit where moved to the new cayenne-commitlog module. + Please change your code accordingly (see also notes above for CAY-2302). * Per CAY-2277 ClientRuntime created with ClientRuntimeBuilder, direct instantiation of @@ -63,8 +68,13 @@ UPGRADING TO 4.0.M6 - cayenne-cache-invalidation (was part of cayenne-lifecycle) - cayenne-commitlog (was part of cayenne-lifecycle) -* Per CAY-2259 InvalidationFunction returns CacheGroupDescriptor instead of simple String with cache group name, - change your custom functions accordingly. +* Per CAY-2259 Cache invalidation module refactored to provide new functionality and better align with + new module autoloading functionality. Here is list of changes: + - Package org.apache.cayenne.lifecycle.cache renamed to org.apache.cayenne.cache.invalidation. + - CacheInvalidationModuleBuilder renamed to CacheInvalidationModuleExtender and its method build() + renamed to module(). + - InvalidationFunction returns CacheGroupDescriptor instead of simple String with cache group name, + so you need to change your custom functions accordingly. * Per CAY-2268 DI methods for binding ordered lists, introduced in 4.0.M3 where changed: - method after() replaced by explicit addAfter(), addAllAfter()