Skip to main content
Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Flag deprecated ChunkListener callbacks for manual migration to ChunkListener<I, O>

Recipe IDio.moderne.java.spring.batch.FlagChunkListenerForManualMigration
Artifactio.moderne.recipe:rewrite-spring

Spring Batch 6 made ChunkListener generic (ChunkListener<I, O>) and deprecated the three ChunkContext-based callbacks for removal in Spring Batch 7. Their replacements accept the chunk of items (beforeChunk(Chunk<I>), afterChunk(Chunk<O>), onChunkError(Exception, Chunk<O>)), which is a disjoint API from ChunkContext and fires at a different point in the chunk lifecycle, so the change cannot be performed mechanically. This recipe adds a comment to each deprecated callback naming its exact replacement so the remaining body changes can be done by hand. It does not add type parameters or rewrite method bodies.

Composite recipeOpenRewritespringbatchsearchModerne Proprietary License
Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Definition​

Preconditions1
Recipes3

Examples​

java
Before
import org.springframework.batch.core.listener.ChunkListener;
import org.springframework.batch.core.scope.context.ChunkContext;

class MyChunkListener implements ChunkListener {
    public void beforeChunk(ChunkContext context) {
    }

    public void afterChunk(ChunkContext context) {
    }

    public void afterChunkError(ChunkContext context) {
    }
}
After
import org.springframework.batch.core.listener.ChunkListener;
import org.springframework.batch.core.scope.context.ChunkContext;

class MyChunkListener implements ChunkListener {
    /* Spring Batch 6: `ChunkListener` is now `ChunkListener<I, O>` and this `ChunkContext`-based method is deprecated for removal (Spring Batch 7), invoked only under the legacy `chunk(int, PlatformTransactionManager)` step builder. Migrate to `beforeChunk(Chunk<I>)` -- note it is now called after the chunk is read, not before. See https://github.com/spring-projects/spring-batch/issues/5226 */
    public void beforeChunk(ChunkContext context) {
    }

    /* Spring Batch 6: `ChunkListener` is now `ChunkListener<I, O>` and this `ChunkContext`-based method is deprecated for removal (Spring Batch 7), invoked only under the legacy `chunk(int, PlatformTransactionManager)` step builder. Migrate to `afterChunk(Chunk<O>)`, which receives the chunk of items instead of a `ChunkContext`. See https://github.com/spring-projects/spring-batch/issues/5226 */

    public void afterChunk(ChunkContext context) {
    }

    /* Spring Batch 6: `ChunkListener` is now `ChunkListener<I, O>` and this `ChunkContext`-based method is deprecated for removal (Spring Batch 7), invoked only under the legacy `chunk(int, PlatformTransactionManager)` step builder. Migrate to `onChunkError(Exception, Chunk<O>)` (renamed) -- the rollback exception is now a parameter instead of `context.getAttribute(ChunkListener.ROLLBACK_EXCEPTION_KEY)`. See https://github.com/spring-projects/spring-batch/issues/5226 */

    public void afterChunkError(ChunkContext context) {
    }
}
java
Before
import org.springframework.batch.core.listener.ChunkListener;
import org.springframework.batch.core.scope.context.ChunkContext;

class MyChunkListener implements ChunkListener {
    public void beforeChunk(ChunkContext context) {
    }

    public void afterChunk(ChunkContext context) {
    }

    public void afterChunkError(ChunkContext context) {
    }
}
After
import org.springframework.batch.core.listener.ChunkListener;
import org.springframework.batch.core.scope.context.ChunkContext;

class MyChunkListener implements ChunkListener {
    /* Spring Batch 6: `ChunkListener` is now `ChunkListener<I, O>` and this `ChunkContext`-based method is deprecated for removal (Spring Batch 7), invoked only under the legacy `chunk(int, PlatformTransactionManager)` step builder. Migrate to `beforeChunk(Chunk<I>)` -- note it is now called after the chunk is read, not before. See https://github.com/spring-projects/spring-batch/issues/5226 */
    public void beforeChunk(ChunkContext context) {
    }

    /* Spring Batch 6: `ChunkListener` is now `ChunkListener<I, O>` and this `ChunkContext`-based method is deprecated for removal (Spring Batch 7), invoked only under the legacy `chunk(int, PlatformTransactionManager)` step builder. Migrate to `afterChunk(Chunk<O>)`, which receives the chunk of items instead of a `ChunkContext`. See https://github.com/spring-projects/spring-batch/issues/5226 */

    public void afterChunk(ChunkContext context) {
    }

    /* Spring Batch 6: `ChunkListener` is now `ChunkListener<I, O>` and this `ChunkContext`-based method is deprecated for removal (Spring Batch 7), invoked only under the legacy `chunk(int, PlatformTransactionManager)` step builder. Migrate to `onChunkError(Exception, Chunk<O>)` (renamed) -- the rollback exception is now a parameter instead of `context.getAttribute(ChunkListener.ROLLBACK_EXCEPTION_KEY)`. See https://github.com/spring-projects/spring-batch/issues/5226 */

    public void afterChunkError(ChunkContext context) {
    }
}

Usage​

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe FlagChunkListenerForManualMigration

If the recipe is not available locally, then you can install it using:

mod config recipes jar install io.moderne.recipe:rewrite-spring:0.39.1

Data tables​

Source files that had results
org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

ColumnDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.
Source files that had search results
org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

ColumnDescription
Source path of search result before the runThe source path of the file with the search result markers present.
Source path of search result after run the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
ResultThe trimmed printed tree of the LST element that the marker is attached to.
DescriptionThe content of the description of the marker.
Recipe that added the search markerThe specific recipe that added the Search marker.
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

ColumnDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe stack trace of the failure.
Recipe performance
org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

ColumnDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)The total time spent across the scanning phase of this recipe.
Max scanning time (ns)The max time scanning any one source file.
Cumulative edit time (ns)The total time spent across the editing phase of this recipe.
Max edit time (ns)The max time editing any one source file.