Apply Nullability to the SMB module

artembilan · artembilan · commit 45b4338c180b · 2025-07-01T15:27:53.000-04:00
Related to: #10083 Remove usage of deprecated URL ctor The `jcifs` library should come up with other algorithm how to handler URLs. Right now there is a bit of mess with just raw URLs and encoded
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/config/package-info.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/config/package-info.java
@@ -1,4 +1,5 @@
 /**
  * SMB-specific file list filter classes.
  */
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.smb.config;
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/dsl/Smb.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/dsl/Smb.java
@@ -20,6 +20,7 @@
 import java.util.Comparator;
 
 import jcifs.smb.SmbFile;
+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.smb.outbound.SmbOutboundGateway;
 import org.springframework.integration.smb.session.SmbRemoteFileTemplate;
-import org.springframework.lang.Nullable;
 
 /**
  * The factory for SMB components.
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/dsl/SmbInboundChannelAdapterSpec.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/dsl/SmbInboundChannelAdapterSpec.java
@@ -20,6 +20,7 @@
 import java.util.Comparator;
 
 import jcifs.smb.SmbFile;
+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.smb.filters.SmbSimplePatternFileListFilter;
 import org.springframework.integration.smb.inbound.SmbInboundFileSynchronizer;
 import org.springframework.integration.smb.inbound.SmbInboundFileSynchronizingMessageSource;
-import org.springframework.lang.Nullable;
 
 /**
  * A {@link RemoteFileInboundChannelAdapterSpec} for an {@link SmbInboundFileSynchronizingMessageSource}.
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/dsl/SmbStreamingInboundChannelAdapterSpec.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/dsl/SmbStreamingInboundChannelAdapterSpec.java
@@ -19,6 +19,7 @@
 import java.util.Comparator;
 
 import jcifs.smb.SmbFile;
+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.smb.filters.SmbRegexPatternFileListFilter;
 import org.springframework.integration.smb.filters.SmbSimplePatternFileListFilter;
 import org.springframework.integration.smb.inbound.SmbStreamingMessageSource;
-import org.springframework.lang.Nullable;
 
 /**
  * A {@link RemoteFileStreamingInboundChannelAdapterSpec} for a {@link SmbStreamingMessageSource}.
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/dsl/package-info.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/dsl/package-info.java
@@ -1,6 +1,5 @@
 /**
  * Provides SMB Components for the Java DSL.
  */
-@org.springframework.lang.NonNullApi
-@org.springframework.lang.NonNullFields
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.smb.dsl;
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/filters/SmbRegexPatternFileListFilter.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/filters/SmbRegexPatternFileListFilter.java
@@ -50,7 +50,7 @@ public SmbRegexPatternFileListFilter(Pattern pattern) {
 	 */
 	@Override
 	protected String getFilename(SmbFile file) {
-		return (file != null ? file.getName() : null);
+		return file.getName();
 	}
 
 	@Override
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/filters/SmbSimplePatternFileListFilter.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/filters/SmbSimplePatternFileListFilter.java
@@ -45,7 +45,7 @@ public SmbSimplePatternFileListFilter(String pathPattern) {
 	 */
 	@Override
 	protected String getFilename(SmbFile file) {
-		return (file != null) ? file.getName() : null;
+		return file.getName();
 	}
 
 	@Override
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/filters/package-info.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/filters/package-info.java
@@ -1,4 +1,5 @@
 /**
  * SMB Namespace support classes.
  */
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.smb.filters;
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/inbound/SmbInboundFileSynchronizer.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/inbound/SmbInboundFileSynchronizer.java
@@ -43,7 +43,7 @@ public SmbInboundFileSynchronizer(SessionFactory<SmbFile> sessionFactory) {
 	@Override
 	protected boolean isFile(SmbFile _file) {
 		try {
-			return _file != null && _file.isFile();
+			return _file.isFile();
 		}
 		catch (Exception _ex) {
 			logger.warn("Unable to get resource status [" + _file + "].", _ex);
@@ -53,7 +53,7 @@ protected boolean isFile(SmbFile _file) {
 
 	@Override
 	protected String getFilename(SmbFile _file) {
-		return _file != null ? _file.getName() : null;
+		return _file.getName();
 	}
 
 	@Override
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/inbound/SmbInboundFileSynchronizingMessageSource.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/inbound/SmbInboundFileSynchronizingMessageSource.java
@@ -20,6 +20,7 @@
 import java.util.Comparator;
 
 import jcifs.smb.SmbFile;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizer;
 import org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizingMessageSource;
@@ -38,7 +39,8 @@ public SmbInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<
 	}
 
 	public SmbInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<SmbFile> _synchronizer,
-			Comparator<File> _comparator) {
+			@Nullable Comparator<File> _comparator) {
+
 		super(_synchronizer, _comparator);
 	}
 
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/inbound/SmbStreamingMessageSource.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/inbound/SmbStreamingMessageSource.java
@@ -23,8 +23,7 @@
 
 import jcifs.smb.SmbException;
 import jcifs.smb.SmbFile;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.remote.AbstractFileInfo;
 import org.springframework.integration.file.remote.AbstractRemoteFileStreamingMessageSource;
@@ -37,14 +36,13 @@
  * Message source for streaming SMB remote file contents.
  *
  * @author Gregory Bragg
+ * @author Artem Bilan
  *
  * @since 6.0
  *
  */
 public class SmbStreamingMessageSource extends AbstractRemoteFileStreamingMessageSource<SmbFile> {
 
-	private static final Log logger = LogFactory.getLog(SmbStreamingMessageSource.class);
-
 	/**
 	 * Construct an instance with the supplied template.
 	 * @param template the template.
@@ -61,7 +59,7 @@ public SmbStreamingMessageSource(RemoteFileTemplate<SmbFile> template) {
 	 * @param comparator the comparator.
 	 */
 	@SuppressWarnings("this-escape")
-	public SmbStreamingMessageSource(RemoteFileTemplate<SmbFile> template, Comparator<SmbFile> comparator) {
+	public SmbStreamingMessageSource(RemoteFileTemplate<SmbFile> template, @Nullable Comparator<SmbFile> comparator) {
 		super(template, comparator);
 		doSetFilter(new SmbPersistentAcceptOnceFileListFilter(new SimpleMetadataStore(), "smbStreamingMessageSource"));
 	}
@@ -83,10 +81,10 @@ protected List<AbstractFileInfo<SmbFile>> asFileInfoList(Collection<SmbFile> fil
 	@Override
 	protected boolean isDirectory(SmbFile file) {
 		try {
-			return file != null && file.isDirectory();
+			return file.isDirectory();
 		}
 		catch (SmbException se) {
-			logger.error("Unable to determine if this SmbFile represents a directory", se);
+			logger.error(se, "Unable to determine if this SmbFile represents a directory");
 			return false;
 		}
 	}
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/inbound/package-info.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/inbound/package-info.java
@@ -1,4 +1,5 @@
 /**
  * Inbound Channel Adapters implementations for SMB protocol.
  */
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.smb.inbound;
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/outbound/SmbOutboundGateway.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/outbound/SmbOutboundGateway.java
@@ -22,6 +22,7 @@
 
 import jcifs.smb.SmbException;
 import jcifs.smb.SmbFile;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.remote.AbstractFileInfo;
 import org.springframework.integration.file.remote.MessageSessionCallback;
@@ -30,7 +31,6 @@
 import org.springframework.integration.file.remote.session.SessionFactory;
 import org.springframework.integration.smb.session.SmbFileInfo;
 import org.springframework.integration.smb.session.SmbRemoteFileTemplate;
-import org.springframework.lang.Nullable;
 
 /**
  * Outbound Gateway for performing remote file operations via SMB.
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/outbound/package-info.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/outbound/package-info.java
@@ -1,4 +1,5 @@
 /**
  * Outbound Channel Adapter implementations for SMB protocol.
  */
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.smb.outbound;
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/session/SmbConfig.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/session/SmbConfig.java
@@ -42,16 +42,21 @@
  */
 public class SmbConfig {
 
+	@SuppressWarnings("NullAway.Init")
 	private String host;
 
 	private int port;
 
+	@SuppressWarnings("NullAway.Init")
 	private String domain;
 
+	@SuppressWarnings("NullAway.Init")
 	private String username;
 
+	@SuppressWarnings("NullAway.Init")
 	private String password;
 
+	@SuppressWarnings("NullAway.Init")
 	private String shareAndDir;
 
 	/**
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/session/SmbFileInfo.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/session/SmbFileInfo.java
@@ -23,6 +23,7 @@
 import jcifs.smb.SmbFile;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.remote.AbstractFileInfo;
 import org.springframework.util.Assert;
@@ -94,21 +95,19 @@ public String getFilename() {
 	 * users have the necessary permissions to access objects based on these entries.
 	 * A readable, formatted list of security descriptor entries and associated
 	 * permissions will be returned by this implementation.
-	 *
 	 * <pre>
 	 * WNET\alice - Deny Write, Deny Modify, Direct - This folder only
 	 * SYSTEM - Allow Read, Allow Write, Allow Modify, Allow Execute, Allow Delete, Inherited - This folder only
 	 * WNET\alice - Allow Read, Allow Write, Allow Modify, Allow Execute, Allow Delete, Inherited - This folder only
 	 * Administrators - Allow Read, Allow Write, Allow Modify, Allow Execute, Allow Delete, Inherited - This folder only
 	 * </pre>
-	 *
 	 * @return a list of Access Control Entry (ACE) objects representing the security
 	 * descriptor entry and permissions associated with this file or directory.
 	 * @see jcifs.ACE
 	 * @see jcifs.SID
 	 */
 	@Override
-	public String getPermissions() {
+	public @Nullable String getPermissions() {
 		ACE[] aces;
 		try {
 			aces = this.smbFile.getSecurity(true);
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/session/SmbRemoteFileTemplate.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/session/SmbRemoteFileTemplate.java
@@ -21,10 +21,10 @@
 import jcifs.smb.NtStatus;
 import jcifs.smb.SmbException;
 import jcifs.smb.SmbFile;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.remote.RemoteFileTemplate;
 import org.springframework.integration.file.remote.session.SessionFactory;
-import org.springframework.lang.Nullable;
 
 /**
  * The SMB-specific {@link RemoteFileTemplate} implementation.
@@ -83,8 +83,7 @@ protected boolean isStatusDirty(int status) {
 		return !NOT_DIRTY_STATUSES.contains(status);
 	}
 
-	@Nullable
-	private static SmbException findSmbException(Throwable ex) {
+	private static @Nullable SmbException findSmbException(@Nullable Throwable ex) {
 		if (ex == null || ex instanceof SmbException) {
 			return (SmbException) ex;
 		}
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/session/SmbSession.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/session/SmbSession.java
@@ -28,6 +28,7 @@
 import jcifs.smb.SmbException;
 import jcifs.smb.SmbFile;
 import jcifs.smb.SmbFileOutputStream;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.core.log.LogAccessor;
 import org.springframework.integration.file.remote.session.Session;
@@ -335,7 +336,7 @@ public boolean isDirectory(String _path) throws IOException {
 	 * @return the path created or null
 	 * @throws IOException on error conditions returned by a CIFS server
 	 */
-	String mkdirs(String _path) throws IOException {
+	@Nullable String mkdirs(String _path) throws IOException {
 		int idxPath = _path.lastIndexOf(SMB_FILE_SEPARATOR);
 		if (idxPath > -1) {
 			String path = _path.substring(0, idxPath + 1);
@@ -448,7 +449,7 @@ SmbFile writeAndClose(InputStream _inputStream, String _path) throws IOException
 	 * @return SmbFile object for path
 	 * @throws IOException in case of I/O errors
 	 */
-	private SmbFile createSmbFileObject(String path, Boolean isDirectory) throws IOException {
+	private SmbFile createSmbFileObject(String path, @Nullable Boolean isDirectory) throws IOException {
 
 		final String cleanedPath = StringUtils.cleanPath(path);
 
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/session/SmbSessionFactory.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/session/SmbSessionFactory.java
@@ -23,6 +23,7 @@
 import jcifs.smb.SmbFile;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.jspecify.annotations.Nullable;
 
 import org.springframework.integration.file.remote.session.SessionFactory;
 import org.springframework.util.Assert;
@@ -40,7 +41,7 @@ public class SmbSessionFactory extends SmbConfig implements SessionFactory<SmbFi
 
 	private static final Log logger = LogFactory.getLog(SmbSessionFactory.class);
 
-	private CIFSContext context = null;
+	private @Nullable CIFSContext context;
 
 	public SmbSessionFactory() {
 		logger.debug("New " + getClass().getName() + " created.");
diff --git a/spring-integration-smb/src/main/java/org/springframework/integration/smb/session/package-info.java b/spring-integration-smb/src/main/java/org/springframework/integration/smb/session/package-info.java
@@ -1,4 +1,5 @@
 /**
  * SMB Remote Session abstraction support classes.
  */
+@org.jspecify.annotations.NullMarked
 package org.springframework.integration.smb.session;
diff --git a/spring-integration-smb/src/test/java/org/springframework/integration/smb/SmbMessageHistoryTests.java b/spring-integration-smb/src/test/java/org/springframework/integration/smb/SmbMessageHistoryTests.java
@@ -17,12 +17,7 @@
 package org.springframework.integration.smb;
 
 import java.net.URI;
-import java.net.URL;
-import java.util.Properties;
 
-import jcifs.CIFSContext;
-import jcifs.config.PropertyConfiguration;
-import jcifs.context.BaseContext;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.context.support.ClassPathXmlApplicationContext;
@@ -56,12 +51,6 @@ public void testMessageHistory() throws Exception {
 			assertThat(uri.getUserInfo()).isEqualTo("sambagu@est:sambag%uest");
 			assertThat(uri.getPath()).isEqualTo("/smb share/");
 			assertThat(uri.getRawPath()).isEqualTo("/smb%20share/");
-
-			CIFSContext context = new BaseContext(new PropertyConfiguration(new Properties()));
-			URL rawUrl = new URL(null, smbSessionFactory.rawUrl(true), context.getUrlHandler());
-			assertThat(rawUrl.getHost()).isEqualTo("localhost");
-			assertThat(rawUrl.getUserInfo()).isEqualTo("sambagu%40est:sambag%25uest");
-			assertThat(rawUrl.getPath()).isEqualTo("/smb share/");
 		}
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public SmbRegexPatternFileListFilter(Pattern pattern) {`
`50`	`50`	`*/`
`51`	`51`	`@Override`
`52`	`52`	`protected String getFilename(SmbFile file) {`
`53`		`- return (file != null ? file.getName() : null);`
	`53`	`+ return file.getName();`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public SmbSimplePatternFileListFilter(String pathPattern) {`
`45`	`45`	`*/`
`46`	`46`	`@Override`
`47`	`47`	`protected String getFilename(SmbFile file) {`
`48`		`- return (file != null) ? file.getName() : null;`
	`48`	`+ return file.getName();`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`import java.util.Comparator;`
`21`	`21`
`22`	`22`	`import jcifs.smb.SmbFile;`
	`23`	`+import org.jspecify.annotations.Nullable;`
`23`	`24`
`24`	`25`	`import org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizer;`
`25`	`26`	`import org.springframework.integration.file.remote.synchronizer.AbstractInboundFileSynchronizingMessageSource;`
`@@ -38,7 +39,8 @@ public SmbInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<`
`38`	`39`	`}`
`39`	`40`
`40`	`41`	`public SmbInboundFileSynchronizingMessageSource(AbstractInboundFileSynchronizer<SmbFile> _synchronizer,`
`41`		`- Comparator<File> _comparator) {`
	`42`	`+ @Nullable Comparator<File> _comparator) {`
	`43`	`+`
`42`	`44`	`super(_synchronizer, _comparator);`
`43`	`45`	`}`
`44`	`46`