File, FTP, IP Sonar Fixes

garyrussell · garyrussell · commit 12bc24dd0295 · 2018-10-26T13:53:54.000-04:00
diff --git a/spring-integration-core/src/main/java/org/springframework/integration/mapping/InboundMessageMapper.java b/spring-integration-core/src/main/java/org/springframework/integration/mapping/InboundMessageMapper.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -49,6 +49,7 @@ default Message<?> toMessage(T object) throws Exception {
 	 * @throws Exception the exception thrown by the underlying mapper implementation
 	 * @since 5.0
 	 */
+	@Nullable
 	Message<?> toMessage(T object, @Nullable Map<String, Object> headers) throws Exception;
 
 }
diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/FileWritingMessageHandler.java b/spring-integration-file/src/main/java/org/springframework/integration/file/FileWritingMessageHandler.java
@@ -449,7 +449,7 @@ protected void doInit() {
 
 		if (this.destinationDirectoryExpression instanceof LiteralExpression) {
 			final File directory =
-					new File(this.destinationDirectoryExpression.getValue(this.evaluationContext, null, String.class));
+					new File(this.destinationDirectoryExpression.getValue(this.evaluationContext, String.class));
 
 			validateDestinationDirectory(directory, this.autoCreateDirectory);
 		}
diff --git a/spring-integration-ftp/src/main/java/org/springframework/integration/ftp/inbound/FtpInboundFileSynchronizer.java b/spring-integration-ftp/src/main/java/org/springframework/integration/ftp/inbound/FtpInboundFileSynchronizer.java
@@ -42,7 +42,7 @@ public class FtpInboundFileSynchronizer extends AbstractInboundFileSynchronizer<
 	 */
 	public FtpInboundFileSynchronizer(SessionFactory<FTPFile> sessionFactory) {
 		super(sessionFactory);
-		doSetRemoteDirectoryExpression(new LiteralExpression(null));
+		doSetRemoteDirectoryExpression(new LiteralExpression(null)); // NOSONAR - LE can actually handle null ok
 		doSetFilter(new FtpPersistentAcceptOnceFileListFilter(new SimpleMetadataStore(), "ftpMessageSource"));
 	}
 
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractClientConnectionFactory.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractClientConnectionFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@
 import java.util.concurrent.locks.ReentrantReadWriteLock;
 
 import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.lang.Nullable;
 
 /**
  * Abstract class for client connection factories; client connection factories
@@ -79,6 +80,7 @@ protected TcpConnectionSupport obtainConnection() throws Exception {
 		return obtainNewConnection();
 	}
 
+	@Nullable
 	protected final TcpConnectionSupport obtainSharedConnection() throws InterruptedException {
 		this.theConnectionLock.readLock().lockInterruptibly();
 		try {
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractConnectionFactory.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractConnectionFactory.java
@@ -48,6 +48,7 @@
 import org.springframework.core.serializer.Serializer;
 import org.springframework.integration.context.IntegrationObjectSupport;
 import org.springframework.integration.ip.tcp.serializer.ByteArrayCrLfSerializer;
+import org.springframework.lang.Nullable;
 import org.springframework.messaging.MessagingException;
 import org.springframework.util.Assert;
 
@@ -610,8 +611,10 @@ protected TcpConnectionSupport wrapConnection(TcpConnectionSupport connection) t
 	 * @param connections Map of connections.
 	 * @throws IOException Any IOException.
 	 */
-	protected void processNioSelections(int selectionCount, final Selector selector, ServerSocketChannel server,
+	protected void processNioSelections(int selectionCount, final Selector selector,
+			@Nullable ServerSocketChannel server,
 			Map<SocketChannel, TcpNioConnection> connections) throws IOException {
+
 		final long now = System.currentTimeMillis();
 		rescheduleDelayedReads(selector, now);
 		if (this.soTimeout > 0 ||
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractServerConnectionFactory.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/AbstractServerConnectionFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2001-2016 the original author or authors.
+ * Copyright 2001-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.core.task.TaskRejectedException;
 import org.springframework.integration.context.OrderlyShutdownCapable;
+import org.springframework.lang.Nullable;
 import org.springframework.scheduling.SchedulingAwareRunnable;
 import org.springframework.scheduling.TaskScheduler;
 import org.springframework.util.Assert;
@@ -66,6 +67,7 @@ public boolean isLongLived() {
 	}
 
 	@Override
+	@Nullable
 	public SocketAddress getServerSocketAddress() {
 		return null;
 	}
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpConnection.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpConnection.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2001-2016 the original author or authors.
+ * Copyright 2001-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@
 
 import org.springframework.core.serializer.Deserializer;
 import org.springframework.core.serializer.Serializer;
+import org.springframework.lang.Nullable;
 import org.springframework.messaging.Message;
 
 /**
@@ -116,13 +117,15 @@ public interface TcpConnection extends Runnable {
 	 * associated with the connection, but the object should be treated as opaque
 	 * and ONLY used as a key.
 	 */
+	@Nullable
 	Object getDeserializerStateKey();
 
 	/**
 	 * @return the {@link SSLSession} associated with this connection, if SSL is in use,
 	 * null otherwise.
 	 * @since 4.2
 	 */
+	@Nullable
 	SSLSession getSslSession();
 
 	/**
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpConnectionSupport.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpConnectionSupport.java
@@ -34,6 +34,7 @@
 import org.springframework.core.serializer.Serializer;
 import org.springframework.integration.ip.IpHeaders;
 import org.springframework.integration.ip.tcp.serializer.AbstractByteArraySerializer;
+import org.springframework.lang.Nullable;
 import org.springframework.messaging.MessagingException;
 import org.springframework.messaging.support.ErrorMessage;
 import org.springframework.util.Assert;
@@ -93,7 +94,7 @@ public TcpConnectionSupport() {
 		this(null);
 	}
 
-	public TcpConnectionSupport(ApplicationEventPublisher applicationEventPublisher) {
+	public TcpConnectionSupport(@Nullable ApplicationEventPublisher applicationEventPublisher) {
 		this.server = false;
 		this.applicationEventPublisher = applicationEventPublisher;
 		this.socketInfo = null;
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpMessageMapper.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpMessageMapper.java
@@ -238,6 +238,7 @@ protected final void addCustomHeaders(TcpConnection connection, MessageHeaders m
 	 * @param connection the connection.
 	 * @return A Map of {@code <String, ?>} headers to be added to the message.
 	 */
+	@Nullable
 	protected Map<String, ?> supplyCustomHeaders(TcpConnection connection) {
 		return null;
 	}
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNetConnection.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNetConnection.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2001-2017 the original author or authors.
+ * Copyright 2001-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -31,6 +31,7 @@
 import org.springframework.core.serializer.Deserializer;
 import org.springframework.core.serializer.Serializer;
 import org.springframework.integration.ip.tcp.serializer.SoftEndOfStreamException;
+import org.springframework.lang.Nullable;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessagingException;
 import org.springframework.scheduling.SchedulingAwareRunnable;
@@ -129,6 +130,7 @@ public int getPort() {
 	}
 
 	@Override
+	@Nullable
 	public Object getDeserializerStateKey() {
 		try {
 			return inputStream();
@@ -139,6 +141,7 @@ public Object getDeserializerStateKey() {
 	}
 
 	@Override
+	@Nullable
 	public SSLSession getSslSession() {
 		if (this.socket instanceof SSLSocket) {
 			return ((SSLSocket) this.socket).getSession();
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNetServerConnectionFactory.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNetServerConnectionFactory.java
@@ -26,6 +26,7 @@
 
 import javax.net.ServerSocketFactory;
 
+import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
@@ -70,6 +71,7 @@ public int getPort() {
 	}
 
 	@Override
+	@Nullable
 	public SocketAddress getServerSocketAddress() {
 		if (this.serverSocket != null) {
 			return this.serverSocket.getLocalSocketAddress();
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNioClientConnectionFactory.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNioClientConnectionFactory.java
@@ -180,7 +180,7 @@ public void run() {
 						}
 					}
 				}
-				this.processNioSelections(selectionCount, this.selector, null, this.channelMap);
+				processNioSelections(selectionCount, this.selector, null, this.channelMap);
 			}
 		}
 		catch (ClosedSelectorException cse) {
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNioConnection.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNioConnection.java
@@ -42,6 +42,7 @@
 import org.springframework.core.serializer.Serializer;
 import org.springframework.integration.ip.tcp.serializer.SoftEndOfStreamException;
 import org.springframework.integration.util.CompositeExecutor;
+import org.springframework.lang.Nullable;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessagingException;
 import org.springframework.util.Assert;
@@ -183,6 +184,7 @@ public Object getDeserializerStateKey() {
 	}
 
 	@Override
+	@Nullable
 	public SSLSession getSslSession() {
 		return null;
 	}
@@ -332,6 +334,7 @@ private boolean dataAvailable() throws IOException {
 	 * @return The Message or null if no data is available.
 	 * @throws IOException
 	 */
+	@Nullable
 	private synchronized Message<?> convert() throws Exception {
 		if (logger.isTraceEnabled()) {
 			logger.trace(getConnectionId() + " checking data avail (convert): " + this.channelInputStream.available() +
@@ -711,6 +714,7 @@ public synchronized int read() throws IOException {
 			return bite;
 		}
 
+		@Nullable
 		private byte[] getNextBuffer() throws IOException {
 			byte[] buffer = null;
 			while (buffer == null) {
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNioServerConnectionFactory.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/tcp/connection/TcpNioServerConnectionFactory.java
@@ -30,6 +30,7 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
@@ -85,6 +86,7 @@ public int getPort() {
 	}
 
 	@Override
+	@Nullable
 	public SocketAddress getServerSocketAddress() {
 		if (this.serverChannel != null) {
 			try {
@@ -235,6 +237,7 @@ protected void doAccept(final Selector selector, ServerSocketChannel server, lon
 		}
 	}
 
+	@Nullable
 	private TcpNioConnection createTcpNioConnection(SocketChannel socketChannel) {
 		try {
 			TcpNioConnection connection = this.tcpNioConnectionSupport.createNewConnection(socketChannel, true,
diff --git a/spring-integration-ip/src/main/java/org/springframework/integration/ip/udp/DatagramPacketMessageMapper.java b/spring-integration-ip/src/main/java/org/springframework/integration/ip/udp/DatagramPacketMessageMapper.java
@@ -204,6 +204,7 @@ public Message<byte[]> toMessage(DatagramPacket object) throws Exception {
 	}
 
 	@Override
+	@Nullable
 	public Message<byte[]> toMessage(DatagramPacket packet, @Nullable Map<String, Object> headers) throws Exception {
 		int offset = packet.getOffset();
 		int length = packet.getLength();

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2002-2017 the original author or authors.`
	`2`	`+ * Copyright 2002-2018 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -49,6 +49,7 @@ default Message<?> toMessage(T object) throws Exception {`
`49`	`49`	`* @throws Exception the exception thrown by the underlying mapper implementation`
`50`	`50`	`* @since 5.0`
`51`	`51`	`*/`
	`52`	`+ @Nullable`
`52`	`53`	`Message<?> toMessage(T object, @Nullable Map<String, Object> headers) throws Exception;`
`53`	`54`
`54`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -449,7 +449,7 @@ protected void doInit() {`
`449`	`449`
`450`	`450`	`if (this.destinationDirectoryExpression instanceof LiteralExpression) {`
`451`	`451`	`final File directory =`
`452`		`- new File(this.destinationDirectoryExpression.getValue(this.evaluationContext, null, String.class));`
	`452`	`+ new File(this.destinationDirectoryExpression.getValue(this.evaluationContext, String.class));`
`453`	`453`
`454`	`454`	`validateDestinationDirectory(directory, this.autoCreateDirectory);`
`455`	`455`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public class FtpInboundFileSynchronizer extends AbstractInboundFileSynchronizer<`
`42`	`42`	`*/`
`43`	`43`	`public FtpInboundFileSynchronizer(SessionFactory<FTPFile> sessionFactory) {`
`44`	`44`	`super(sessionFactory);`
`45`		`- doSetRemoteDirectoryExpression(new LiteralExpression(null));`
	`45`	`+ doSetRemoteDirectoryExpression(new LiteralExpression(null)); // NOSONAR - LE can actually handle null ok`
`46`	`46`	`doSetFilter(new FtpPersistentAcceptOnceFileListFilter(new SimpleMetadataStore(), "ftpMessageSource"));`
`47`	`47`	`}`
`48`	`48`
Original file line number	Diff line number	Diff line change
`@@ -238,6 +238,7 @@ protected final void addCustomHeaders(TcpConnection connection, MessageHeaders m`
`238`	`238`	`* @param connection the connection.`
`239`	`239`	`* @return A Map of {@code <String, ?>} headers to be added to the message.`
`240`	`240`	`*/`
	`241`	`+ @Nullable`
`241`	`242`	`protected Map<String, ?> supplyCustomHeaders(TcpConnection connection) {`
`242`	`243`	`return null;`
`243`	`244`	`}`