Skip to content

Commit a293f3e

Browse files
committed
Deprecate public APIs related to LobHandler
Resolves #4588
1 parent 461ae65 commit a293f3e

File tree

6 files changed

+16
-4
lines changed

6 files changed

+16
-4
lines changed

Diff for: spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/EnableBatchProcessing.java

+2
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,9 @@
241241
/**
242242
* The large object handler to use in job repository and job explorer.
243243
* @return the bean name of the lob handler to use. Defaults to {@literal lobHandler}.
244+
* @deprecated Since 5.2 with no replacement. Scheduled for removal in v6
244245
*/
246+
@Deprecated(since = "5.2.0", forRemoval = true)
245247
String lobHandlerRef() default "lobHandler";
246248

247249
/**

Diff for: spring-batch-core/src/main/java/org/springframework/batch/core/configuration/support/DefaultBatchConfiguration.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -392,8 +392,9 @@ protected Charset getCharset() {
392392
* A special handler for large objects. The default is usually fine, except for some
393393
* (usually older) versions of Oracle.
394394
* @return the {@link LobHandler} to use
395-
*
395+
* @deprecated Since 5.2 with no replacement. Scheduled for removal in v6
396396
*/
397+
@Deprecated(since = "5.2.0", forRemoval = true)
397398
protected LobHandler getLobHandler() {
398399
return new DefaultLobHandler();
399400
}

Diff for: spring-batch-core/src/main/java/org/springframework/batch/core/explore/support/JobExplorerFactoryBean.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2023 the original author or authors.
2+
* Copyright 2002-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -143,7 +143,9 @@ public void setJobKeyGenerator(JobKeyGenerator jobKeyGenerator) {
143143
* {@code null}, which works for most databases.
144144
* @param lobHandler Large object handler for saving an
145145
* {@link org.springframework.batch.item.ExecutionContext}.
146+
* @deprecated Since 5.2 with no replacement. Scheduled for removal in v6
146147
*/
148+
@Deprecated(since = "5.2.0", forRemoval = true)
147149
public void setLobHandler(LobHandler lobHandler) {
148150
this.lobHandler = lobHandler;
149151
}

Diff for: spring-batch-core/src/main/java/org/springframework/batch/core/repository/dao/JdbcExecutionContextDao.java

+5
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,11 @@ public void deleteExecutionContext(StepExecution stepExecution) {
268268
getJdbcTemplate().update(getQuery(DELETE_STEP_EXECUTION_CONTEXT), stepExecution.getId());
269269
}
270270

271+
/**
272+
* @deprecated Since 5.2 with no replacement. Scheduled for removal in v6
273+
* @param lobHandler the lob handler to use
274+
*/
275+
@Deprecated(since = "5.2.0", forRemoval = true)
271276
public void setLobHandler(LobHandler lobHandler) {
272277
this.lobHandler = lobHandler;
273278
}

Diff for: spring-batch-core/src/main/java/org/springframework/batch/core/repository/support/JobRepositoryFactoryBean.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2023 the original author or authors.
2+
* Copyright 2002-2024 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -129,9 +129,10 @@ public void setSerializer(ExecutionContextSerializer serializer) {
129129
* (usually older) versions of Oracle. The default is determined from the data base
130130
* type.
131131
* @param lobHandler the {@link LobHandler} to set
132-
*
132+
* @deprecated Since 5.2 with no replacement. Scheduled for removal in v6
133133
* @see LobHandler
134134
*/
135+
@Deprecated(since = "5.2.0", forRemoval = true)
135136
public void setLobHandler(LobHandler lobHandler) {
136137
this.lobHandler = lobHandler;
137138
}

Diff for: spring-batch-core/src/main/resources/org/springframework/batch/core/configuration/xml/spring-batch.xsd

+1
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,7 @@
270270
<xsd:documentation><![CDATA[
271271
A reference to the lob handler (optional). Only override if using Oracle and
272272
the database type is not being detected for some reason.
273+
This attribute is deprecated Since 5.2 with no replacement. Scheduled for removal in v6.
273274
]]></xsd:documentation>
274275
<xsd:appinfo>
275276
<tool:annotation kind="ref">

0 commit comments

Comments
 (0)