From 1d4e1593ac41b0bc192fca6bef7a15a52ab3dbcc Mon Sep 17 00:00:00 2001 From: Glenn Renfro Date: Mon, 28 Apr 2025 17:32:41 -0400 Subject: [PATCH] Add deprecation notices for features impacted by SC-Deployer --- docs/modules/ROOT/pages/batch.adoc | 2 ++ docs/modules/ROOT/pages/stream.adoc | 17 +---------------- .../partition/CommandLineArgsProvider.java | 3 +++ .../partition/DeployerPartitionHandler.java | 3 +++ .../partition/DeployerStepExecutionHandler.java | 3 +++ .../partition/EnvironmentVariablesProvider.java | 3 +++ .../NoOpEnvironmentVariablesProvider.java | 3 +++ .../PassThroughCommandLineArgsProvider.java | 3 +++ .../SimpleCommandLineArgsProvider.java | 3 +++ .../SimpleEnvironmentVariablesProvider.java | 3 +++ .../batch/partition/TaskLauncherHandler.java | 3 +++ .../listener/TaskExecutionListenerSupport.java | 3 ++- .../cloud/task/launcher/TaskLaunchRequest.java | 3 +++ .../cloud/task/launcher/TaskLauncherSink.java | 4 +++- .../launcher/annotation/EnableTaskLauncher.java | 3 +++ 15 files changed, 41 insertions(+), 18 deletions(-) diff --git a/docs/modules/ROOT/pages/batch.adoc b/docs/modules/ROOT/pages/batch.adoc index 5a72b00b..3c576c45 100644 --- a/docs/modules/ROOT/pages/batch.adoc +++ b/docs/modules/ROOT/pages/batch.adoc @@ -8,6 +8,8 @@ This section goes into more detail about Spring Cloud Task's integration with Sp Batch. Tracking the association between a job execution and the task in which it was executed as well as remote partitioning through Spring Cloud Deployer are covered in this section. + +NOTE: This feature is now end-of-life and will be removed in a future release. -- [[batch-association]] diff --git a/docs/modules/ROOT/pages/stream.adoc b/docs/modules/ROOT/pages/stream.adoc index 41c96358..38901520 100644 --- a/docs/modules/ROOT/pages/stream.adoc +++ b/docs/modules/ROOT/pages/stream.adoc @@ -57,23 +57,8 @@ NOTE: The `maven.remoteRepositories.springRepo.url` property must be set to the of the remote repository in which the Spring Boot Uber-jar is located. If not set, there is no remote repository, so it relies upon the local repository only. -[[stream-integration-launching-sink-dataflow]] -=== Spring Cloud Data Flow +NOTE: This feature is now end-of-life and will be removed in a future release. -To create a stream in Spring Cloud Data Flow, you must first register the Task Sink -Application we created. In the following example, we are registering the Processor and -Sink sample applications by using the Spring Cloud Data Flow shell: - -[source,bash] ----- -app register --name taskSink --type sink --uri maven://io.spring.cloud:tasksink: -app register --name taskProcessor --type processor --uri maven:io.spring.cloud:taskprocessor: ----- - -The following example shows how to create a stream from the Spring Cloud Data Flow shell: - -[source,bash] -stream create foo --definition "http --server.port=9000|taskProcessor|taskSink" --deploy [[stream-integration-events]] == Spring Cloud Task Events diff --git a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/CommandLineArgsProvider.java b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/CommandLineArgsProvider.java index d5e12e4f..7d8c922f 100644 --- a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/CommandLineArgsProvider.java +++ b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/CommandLineArgsProvider.java @@ -26,7 +26,10 @@ import org.springframework.batch.item.ExecutionContext; * * @author Michael Minella * @since 1.1.0 + * @deprecated This feature is now end-of-life and will be removed in a future release. No + * replacement is planned. Please migrate away from using this functionality. */ +@Deprecated public interface CommandLineArgsProvider { /** diff --git a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/DeployerPartitionHandler.java b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/DeployerPartitionHandler.java index c40a3d5d..c4bd07fd 100644 --- a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/DeployerPartitionHandler.java +++ b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/DeployerPartitionHandler.java @@ -73,7 +73,10 @@ import org.springframework.util.CollectionUtils; * * @author Michael Minella * @author Glenn Renfro + * @deprecated This feature is now end-of-life and will be removed in a future release. No + * replacement is planned. Please migrate away from using this functionality. */ +@Deprecated public class DeployerPartitionHandler implements PartitionHandler, EnvironmentAware, InitializingBean { /** diff --git a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/DeployerStepExecutionHandler.java b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/DeployerStepExecutionHandler.java index c6edf1ec..71dbf29b 100644 --- a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/DeployerStepExecutionHandler.java +++ b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/DeployerStepExecutionHandler.java @@ -56,7 +56,10 @@ import org.springframework.util.Assert; * * * @author Michael Minella + * @deprecated This feature is now end-of-life and will be removed in a future release. No + * replacement is planned. Please migrate away from using this functionality. */ +@Deprecated public class DeployerStepExecutionHandler implements CommandLineRunner { private JobExplorer jobExplorer; diff --git a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/EnvironmentVariablesProvider.java b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/EnvironmentVariablesProvider.java index c3cf8c51..6825b0fa 100644 --- a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/EnvironmentVariablesProvider.java +++ b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/EnvironmentVariablesProvider.java @@ -26,7 +26,10 @@ import org.springframework.batch.item.ExecutionContext; * * @author Michael Minella * @since 1.0.2 + * @deprecated This feature is now end-of-life and will be removed in a future release. No + * replacement is planned. Please migrate away from using this functionality. */ +@Deprecated public interface EnvironmentVariablesProvider { /** diff --git a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/NoOpEnvironmentVariablesProvider.java b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/NoOpEnvironmentVariablesProvider.java index bdc696b3..cd00e3b9 100644 --- a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/NoOpEnvironmentVariablesProvider.java +++ b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/NoOpEnvironmentVariablesProvider.java @@ -27,7 +27,10 @@ import org.springframework.batch.item.ExecutionContext; * * @author Michael Minella * @since 1.0.2 + * @deprecated This feature is now end-of-life and will be removed in a future release. No + * replacement is planned. Please migrate away from using this functionality. */ +@Deprecated public class NoOpEnvironmentVariablesProvider implements EnvironmentVariablesProvider { /** diff --git a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/PassThroughCommandLineArgsProvider.java b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/PassThroughCommandLineArgsProvider.java index 5380ce54..2afc6e80 100644 --- a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/PassThroughCommandLineArgsProvider.java +++ b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/PassThroughCommandLineArgsProvider.java @@ -26,7 +26,10 @@ import org.springframework.util.Assert; * * @author Michael Minella * @since 1.1.0 + * @deprecated This feature is now end-of-life and will be removed in a future release. No + * replacement is planned. Please migrate away from using this functionality. */ +@Deprecated public class PassThroughCommandLineArgsProvider implements CommandLineArgsProvider { private final List commandLineArgs; diff --git a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/SimpleCommandLineArgsProvider.java b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/SimpleCommandLineArgsProvider.java index 83dc8e98..9801b89e 100644 --- a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/SimpleCommandLineArgsProvider.java +++ b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/SimpleCommandLineArgsProvider.java @@ -31,7 +31,10 @@ import org.springframework.util.Assert; * @author Michael Minella * @author Glenn Renfro * @since 1.1.0 + * @deprecated This feature is now end-of-life and will be removed in a future release. No + * replacement is planned. Please migrate away from using this functionality. */ +@Deprecated public class SimpleCommandLineArgsProvider implements CommandLineArgsProvider, TaskExecutionListener { private TaskExecution taskExecution; diff --git a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/SimpleEnvironmentVariablesProvider.java b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/SimpleEnvironmentVariablesProvider.java index b5f34b85..8c8dde1d 100644 --- a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/SimpleEnvironmentVariablesProvider.java +++ b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/SimpleEnvironmentVariablesProvider.java @@ -36,7 +36,10 @@ import org.springframework.core.env.PropertySource; * * @author Michael Minella * @since 1.0.2 + * @deprecated This feature is now end-of-life and will be removed in a future release. No + * replacement is planned. Please migrate away from using this functionality. */ +@Deprecated public class SimpleEnvironmentVariablesProvider implements EnvironmentVariablesProvider { private Environment environment; diff --git a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/TaskLauncherHandler.java b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/TaskLauncherHandler.java index 2d0375d6..7bdd2716 100644 --- a/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/TaskLauncherHandler.java +++ b/spring-cloud-task-batch/src/main/java/org/springframework/cloud/task/batch/partition/TaskLauncherHandler.java @@ -36,7 +36,10 @@ import org.springframework.util.StringUtils; * Supports the launching of partitions. * * @author Glenn Renfro + * @deprecated This feature is now end-of-life and will be removed in a future release. No + * replacement is planned. Please migrate away from using this functionality. */ +@Deprecated public class TaskLauncherHandler implements Runnable { private CommandLineArgsProvider commandLineArgsProvider; diff --git a/spring-cloud-task-core/src/main/java/org/springframework/cloud/task/listener/TaskExecutionListenerSupport.java b/spring-cloud-task-core/src/main/java/org/springframework/cloud/task/listener/TaskExecutionListenerSupport.java index 08286955..68d53c03 100644 --- a/spring-cloud-task-core/src/main/java/org/springframework/cloud/task/listener/TaskExecutionListenerSupport.java +++ b/spring-cloud-task-core/src/main/java/org/springframework/cloud/task/listener/TaskExecutionListenerSupport.java @@ -22,8 +22,9 @@ package org.springframework.cloud.task.listener; * * @author Michael Minella * @since 1.2 - * @deprecated since 3.0 in favor of the default implementations of + * * {@link TaskExecutionListener} + * @deprecated since 3.0 in favor of the default implementations of */ @Deprecated public class TaskExecutionListenerSupport implements TaskExecutionListener { diff --git a/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/TaskLaunchRequest.java b/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/TaskLaunchRequest.java index e3535c6e..c30df8fb 100644 --- a/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/TaskLaunchRequest.java +++ b/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/TaskLaunchRequest.java @@ -32,7 +32,10 @@ import org.springframework.util.StringUtils; * TaskLauncherSink to launch the task. * * @author Glenn Renfro + * @deprecated This feature is now end-of-life and will be removed in a future release. No + * replacement is planned. Please migrate away from using this functionality. */ +@Deprecated public class TaskLaunchRequest implements Serializable { private static final long serialVersionUID = 1L; diff --git a/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/TaskLauncherSink.java b/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/TaskLauncherSink.java index 34981875..519bd886 100644 --- a/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/TaskLauncherSink.java +++ b/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/TaskLauncherSink.java @@ -35,8 +35,10 @@ import org.springframework.util.Assert; * A sink stream application that launches a tasks. * * @author Glenn Renfro + * @deprecated This feature is now end-of-life and will be removed in a future release. No + * replacement is planned. Please migrate away from using this functionality. */ - +@Deprecated public class TaskLauncherSink { private final static Logger logger = LoggerFactory.getLogger(TaskLauncherSink.class); diff --git a/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/annotation/EnableTaskLauncher.java b/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/annotation/EnableTaskLauncher.java index c6f612ef..5366569b 100644 --- a/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/annotation/EnableTaskLauncher.java +++ b/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/annotation/EnableTaskLauncher.java @@ -50,12 +50,15 @@ import org.springframework.context.annotation.Import; * @EnableTaskLauncher annotation. * * @author Glenn Renfro + * @deprecated This feature is now end-of-life and will be removed in a future release. No + * replacement is planned. Please migrate away from using this functionality. */ @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited @Import({ TaskLauncherSink.class }) +@Deprecated public @interface EnableTaskLauncher { }