GH-10083: Apply NullAbility to sftp module

ngocnhan-tran1996 · ngocnhan-tran1996 · commit b92963d7dd2d · 2025-08-09T03:07:44.000+07:00
Related to: #10083 Signed-off-by: Tran Ngoc Nhan <ngocnhan.tran1996@gmail.com>
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/package-info.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/config/package-info.java
@@ -1,4 +1,5 @@
 /**
  * Provides classes for configuration - parsers, namespace handlers.
  */
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.sftp.config;
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/dsl/Sftp.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/dsl/Sftp.java
@@ -20,6 +20,7 @@
 import java.util.Comparator;
 
 import org.apache.sshd.sftp.client.SftpClient;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.remote.MessageSessionCallback;
 import org.springframework.integration.file.remote.RemoteFileTemplate;
@@ -28,7 +29,6 @@
 import org.springframework.integration.file.support.FileExistsMode;
 import org.springframework.integration.sftp.gateway.SftpOutboundGateway;
 import org.springframework.integration.sftp.session.SftpRemoteFileTemplate;
-import org.springframework.lang.Nullable;
 
 /**
  * The factory for SFTP components.
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/dsl/SftpInboundChannelAdapterSpec.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/dsl/SftpInboundChannelAdapterSpec.java
@@ -20,6 +20,7 @@
 import java.util.Comparator;
 
 import org.apache.sshd.sftp.client.SftpClient;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.dsl.RemoteFileInboundChannelAdapterSpec;
 import org.springframework.integration.file.filters.CompositeFileListFilter;
@@ -31,7 +32,6 @@
 import org.springframework.integration.sftp.filters.SftpSimplePatternFileListFilter;
 import org.springframework.integration.sftp.inbound.SftpInboundFileSynchronizer;
 import org.springframework.integration.sftp.inbound.SftpInboundFileSynchronizingMessageSource;
-import org.springframework.lang.Nullable;
 
 /**
  * A {@link RemoteFileInboundChannelAdapterSpec} for an {@link SftpInboundFileSynchronizingMessageSource}.
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/dsl/SftpStreamingInboundChannelAdapterSpec.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/dsl/SftpStreamingInboundChannelAdapterSpec.java
@@ -19,6 +19,7 @@
 import java.util.Comparator;
 
 import org.apache.sshd.sftp.client.SftpClient;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.dsl.RemoteFileStreamingInboundChannelAdapterSpec;
 import org.springframework.integration.file.filters.CompositeFileListFilter;
@@ -29,7 +30,6 @@
 import org.springframework.integration.sftp.filters.SftpRegexPatternFileListFilter;
 import org.springframework.integration.sftp.filters.SftpSimplePatternFileListFilter;
 import org.springframework.integration.sftp.inbound.SftpStreamingMessageSource;
-import org.springframework.lang.Nullable;
 
 /**
  * @author Gary Russell
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/dsl/package-info.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/dsl/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Provides SFTP Components for the Java DSL.
  */
-@org.springframework.lang.NonNullApi
-@org.springframework.lang.NonNullFields
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.sftp.dsl;
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/filters/SftpRegexPatternFileListFilter.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/filters/SftpRegexPatternFileListFilter.java
@@ -43,7 +43,7 @@ public SftpRegexPatternFileListFilter(Pattern pattern) {
 
 	@Override
 	protected String getFilename(SftpClient.DirEntry entry) {
-		return (entry != null) ? entry.getFilename() : null;
+		return entry.getFilename();
 	}
 
 	@Override
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/filters/SftpSimplePatternFileListFilter.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/filters/SftpSimplePatternFileListFilter.java
@@ -37,7 +37,7 @@ public SftpSimplePatternFileListFilter(String pattern) {
 
 	@Override
 	protected String getFilename(SftpClient.DirEntry entry) {
-		return (entry != null) ? entry.getFilename() : null;
+		return entry.getFilename();
 	}
 
 	@Override
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/filters/package-info.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/filters/package-info.java
@@ -1,4 +1,5 @@
 /**
  * Provides classes supporting SFTP file filtering.
  */
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.sftp.filters;
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/gateway/SftpOutboundGateway.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/gateway/SftpOutboundGateway.java
@@ -23,6 +23,7 @@
 import java.util.stream.Collectors;
 
 import org.apache.sshd.sftp.client.SftpClient;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.remote.AbstractFileInfo;
 import org.springframework.integration.file.remote.ClientCallbackWithoutResult;
@@ -33,7 +34,6 @@
 import org.springframework.integration.file.remote.session.SessionFactory;
 import org.springframework.integration.sftp.session.SftpFileInfo;
 import org.springframework.integration.sftp.session.SftpRemoteFileTemplate;
-import org.springframework.lang.Nullable;
 
 /**
  * Outbound Gateway for performing remote file operations via SFTP.
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/gateway/package-info.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/gateway/package-info.java
@@ -1,4 +1,5 @@
 /**
  * Provides classes supporting SFTP gateways.
  */
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.sftp.gateway;
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/inbound/SftpInboundFileSynchronizer.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/inbound/SftpInboundFileSynchronizer.java
@@ -17,6 +17,7 @@
 package org.springframework.integration.sftp.inbound;
 
 import org.apache.sshd.sftp.client.SftpClient;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.remote.session.SessionFactory;
 import org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizer;
@@ -46,13 +47,13 @@ public SftpInboundFileSynchronizer(SessionFactory<SftpClient.DirEntry> sessionFa
 	}
 
 	@Override
-	protected boolean isFile(SftpClient.DirEntry file) {
+	protected boolean isFile(SftpClient.@Nullable DirEntry file) {
 		return file != null && file.getAttributes().isRegularFile();
 	}
 
 	@Override
 	protected String getFilename(SftpClient.DirEntry file) {
-		return file != null ? file.getFilename() : null;
+		return file.getFilename();
 	}
 
 	@Override
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/inbound/SftpInboundFileSynchronizingMessageSource.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/inbound/SftpInboundFileSynchronizingMessageSource.java
@@ -20,6 +20,7 @@
 import java.util.Comparator;
 
 import org.apache.sshd.sftp.client.SftpClient;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizer;
 import org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizingMessageSource;
@@ -42,7 +43,7 @@ public SftpInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer
 	}
 
 	public SftpInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<SftpClient.DirEntry> synchronizer,
-			Comparator<File> comparator) {
+			@Nullable Comparator<File> comparator) {
 
 		super(synchronizer, comparator);
 	}
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/inbound/SftpStreamingMessageSource.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/inbound/SftpStreamingMessageSource.java
@@ -22,6 +22,7 @@
 import java.util.List;
 
 import org.apache.sshd.sftp.client.SftpClient;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.remote.AbstractFileInfo;
 import org.springframework.integration.file.remote.AbstractRemoteFileStreamingMessageSource;
@@ -58,7 +59,7 @@ public SftpStreamingMessageSource(RemoteFileTemplate<SftpClient.DirEntry> templa
 	 */
 	@SuppressWarnings("this-escape")
 	public SftpStreamingMessageSource(RemoteFileTemplate<SftpClient.DirEntry> template,
-			Comparator<SftpClient.DirEntry> comparator) {
+			@Nullable Comparator<SftpClient.DirEntry> comparator) {
 
 		super(template, comparator);
 		doSetFilter(new SftpPersistentAcceptOnceFileListFilter(new SimpleMetadataStore(), "sftpStreamingMessageSource"));
@@ -79,7 +80,7 @@ protected List<AbstractFileInfo<SftpClient.DirEntry>> asFileInfoList(Collection<
 	}
 
 	@Override
-	protected boolean isDirectory(SftpClient.DirEntry file) {
+	protected boolean isDirectory(SftpClient.@Nullable DirEntry file) {
 		return file != null && file.getAttributes().isDirectory();
 	}
 
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/inbound/package-info.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/inbound/package-info.java
@@ -1,4 +1,5 @@
 /**
  * Provides classes supporting inbound endpoints.
  */
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.sftp.inbound;
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/outbound/package-info.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/outbound/package-info.java
@@ -1,4 +1,5 @@
 /**
  * Provides classes for the SFTP outbound channel adapter.
  */
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.sftp.outbound;
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/ApacheMinaSftpEvent.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/ApacheMinaSftpEvent.java
@@ -17,6 +17,7 @@
 package org.springframework.integration.sftp.server;
 
 import org.apache.sshd.server.session.ServerSession;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.remote.server.FileServerEvent;
 
@@ -35,7 +36,8 @@ public ApacheMinaSftpEvent(Object source) {
 		super(source);
 	}
 
-	public ApacheMinaSftpEvent(Object source, Throwable cause) {
+	@SuppressWarnings("NullAway") // Overridden method does not define nullability
+	public ApacheMinaSftpEvent(Object source, @Nullable Throwable cause) {
 		super(source, cause);
 	}
 
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/ApacheMinaSftpEventListener.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/ApacheMinaSftpEventListener.java
@@ -24,6 +24,7 @@
 import org.apache.sshd.server.session.ServerSession;
 import org.apache.sshd.sftp.server.FileHandle;
 import org.apache.sshd.sftp.server.SftpEventListener;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.beans.factory.BeanNameAware;
 import org.springframework.beans.factory.InitializingBean;
@@ -45,9 +46,10 @@
 public class ApacheMinaSftpEventListener
 		implements SftpEventListener, ApplicationEventPublisherAware, BeanNameAware, InitializingBean {
 
+	@SuppressWarnings("NullAway.Init")
 	private ApplicationEventPublisher applicationEventPublisher;
 
-	private String beanName;
+	private @Nullable String beanName;
 
 	@Override
 	public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
@@ -63,7 +65,7 @@ public void setBeanName(String name) {
 		this.beanName = name;
 	}
 
-	public String getBeanName() {
+	public @Nullable String getBeanName() {
 		return this.beanName;
 	}
 
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/DirectoryCreatedEvent.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/DirectoryCreatedEvent.java
@@ -19,7 +19,7 @@
 import java.nio.file.Path;
 import java.util.Map;
 
-import org.springframework.lang.Nullable;
+import org.jspecify.annotations.Nullable;
 
 /**
  * An event emitted when a directory is created.
@@ -43,8 +43,7 @@ public DirectoryCreatedEvent(Object source, Path path, Map<String, ?> attrs) {
 		this.attrs = attrs;
 	}
 
-	@Nullable
-	public Path getPath() {
+	public @Nullable Path getPath() {
 		return this.path;
 	}
 
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/FileWrittenEvent.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/FileWrittenEvent.java
@@ -18,7 +18,7 @@
 
 import java.nio.file.Path;
 
-import org.springframework.lang.Nullable;
+import org.jspecify.annotations.Nullable;
 
 /**
  * An event that is emitted when a file is written.
@@ -48,8 +48,7 @@ public String getRemoteHandle() {
 		return this.remoteHandle;
 	}
 
-	@Nullable
-	public Path getFile() {
+	public @Nullable Path getFile() {
 		return this.file;
 	}
 
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/PathMovedEvent.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/PathMovedEvent.java
@@ -18,7 +18,7 @@
 
 import java.nio.file.Path;
 
-import org.springframework.lang.Nullable;
+import org.jspecify.annotations.Nullable;
 
 /**
  * An event emitted when a path is moved.
@@ -41,13 +41,11 @@ public PathMovedEvent(Object source, Path srcPath, Path dstPath, @Nullable Throw
 		this.dstPath = dstPath;
 	}
 
-	@Nullable
-	public Path getSrcPath() {
+	public @Nullable Path getSrcPath() {
 		return this.srcPath;
 	}
 
-	@Nullable
-	public Path getDstPath() {
+	public @Nullable Path getDstPath() {
 		return this.dstPath;
 	}
 
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/PathRemovedEvent.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/PathRemovedEvent.java
@@ -18,7 +18,7 @@
 
 import java.nio.file.Path;
 
-import org.springframework.lang.Nullable;
+import org.jspecify.annotations.Nullable;
 
 /**
  * An event emitted when a file or directory is removed.
@@ -41,8 +41,7 @@ public PathRemovedEvent(Object source, Path path, boolean isDirectory, @Nullable
 		this.isDirectory = isDirectory;
 	}
 
-	@Nullable
-	public Path getPath() {
+	public @Nullable Path getPath() {
 		return this.path;
 	}
 
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/package-info.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/server/package-info.java
@@ -1,4 +1,5 @@
 /**
  * Provides classes related to SFTP servers.
  */
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.sftp.server;
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/DefaultSftpSessionFactory.java
@@ -51,6 +51,7 @@
 import org.apache.sshd.sftp.client.SftpVersionSelector;
 import org.apache.sshd.sftp.client.impl.AbstractSftpClient;
 import org.apache.sshd.sftp.client.impl.DefaultSftpClient;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.beans.factory.DisposableBean;
 import org.springframework.core.io.Resource;
@@ -94,35 +95,37 @@ public class DefaultSftpSessionFactory
 
 	private final boolean isSharedSession;
 
-	private final Lock sharedSessionLock;
+	private final @Nullable Lock sharedSessionLock;
 
 	private boolean isInnerClient = false;
 
+	@SuppressWarnings("NullAway.Init")
 	private String host;
 
 	private int port = SshConstants.DEFAULT_PORT;
 
+	@SuppressWarnings("NullAway.Init")
 	private String user;
 
-	private String password;
+	private @Nullable String password;
 
-	private HostConfigEntry hostConfig;
+	private @Nullable HostConfigEntry hostConfig;
 
-	private Resource knownHosts;
+	private @Nullable Resource knownHosts;
 
-	private Resource privateKey;
+	private @Nullable Resource privateKey;
 
-	private String privateKeyPassphrase;
+	private @Nullable String privateKeyPassphrase;
 
-	private UserInteraction userInteraction;
+	private @Nullable UserInteraction userInteraction;
 
 	private boolean allowUnknownKeys = false;
 
 	private Integer timeout = (int) IntegrationContextUtils.DEFAULT_TIMEOUT;
 
 	private SftpVersionSelector sftpVersionSelector = SftpVersionSelector.CURRENT;
 
-	private volatile SftpClient sharedSftpClient;
+	private volatile @Nullable SftpClient sharedSftpClient;
 
 	private Consumer<SshClient> sshClientConfigurer = (sshClient) -> {
 	};
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/SftpRemoteFileTemplate.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/SftpRemoteFileTemplate.java
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/SftpSession.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/SftpSession.java
diff --git a/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/package-info.java b/spring-integration-sftp/src/main/java/org/springframework/integration/sftp/session/package-info.java

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public SftpRegexPatternFileListFilter(Pattern pattern) {`
`43`	`43`
`44`	`44`	`@Override`
`45`	`45`	`protected String getFilename(SftpClient.DirEntry entry) {`
`46`		`- return (entry != null) ? entry.getFilename() : null;`
	`46`	`+ return entry.getFilename();`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public SftpSimplePatternFileListFilter(String pattern) {`
`37`	`37`
`38`	`38`	`@Override`
`39`	`39`	`protected String getFilename(SftpClient.DirEntry entry) {`
`40`		`- return (entry != null) ? entry.getFilename() : null;`
	`40`	`+ return entry.getFilename();`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`@Override`