Polishing

Author: jhoeller

spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractSubscriptionRegistry.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -38,8 +38,7 @@
 public abstract class AbstractSubscriptionRegistry implements SubscriptionRegistry {
 
 	private static MultiValueMap<String, String> EMPTY_MAP =
-			CollectionUtils.unmodifiableMultiValueMap(new LinkedMultiValueMap<String, String>(0));
-
+			CollectionUtils.unmodifiableMultiValueMap(new LinkedMultiValueMap<>(0));
 
 	protected final Log logger = LogFactory.getLog(getClass());
 
@@ -55,19 +54,25 @@ public final void registerSubscription(Message<?> message) {
 
 		String sessionId = SimpMessageHeaderAccessor.getSessionId(headers);
 		if (sessionId == null) {
-			logger.error("No sessionId in  " + message);
+			if (logger.isErrorEnabled()) {
+				logger.error("No sessionId in  " + message);
+			}
 			return;
 		}
 
 		String subscriptionId = SimpMessageHeaderAccessor.getSubscriptionId(headers);
 		if (subscriptionId == null) {
-			logger.error("No subscriptionId in " + message);
+			if (logger.isErrorEnabled()) {
+				logger.error("No subscriptionId in " + message);
+			}
 			return;
 		}
 
 		String destination = SimpMessageHeaderAccessor.getDestination(headers);
 		if (destination == null) {
-			logger.error("No destination in " + message);
+			if (logger.isErrorEnabled()) {
+				logger.error("No destination in " + message);
+			}
 			return;
 		}
 
@@ -85,13 +90,17 @@ public final void unregisterSubscription(Message<?> message) {
 
 		String sessionId = SimpMessageHeaderAccessor.getSessionId(headers);
 		if (sessionId == null) {
-			logger.error("No sessionId in " + message);
+			if (logger.isErrorEnabled()) {
+				logger.error("No sessionId in " + message);
+			}
 			return;
 		}
 
 		String subscriptionId = SimpMessageHeaderAccessor.getSubscriptionId(headers);
 		if (subscriptionId == null) {
-			logger.error("No subscriptionId " + message);
+			if (logger.isErrorEnabled()) {
+				logger.error("No subscriptionId " + message);
+			}
 			return;
 		}
 
@@ -109,22 +118,23 @@ public final MultiValueMap<String, String> findSubscriptions(Message<?> message)
 
 		String destination = SimpMessageHeaderAccessor.getDestination(headers);
 		if (destination == null) {
-			logger.error("No destination in " + message);
+			if (logger.isErrorEnabled()) {
+				logger.error("No destination in " + message);
+			}
 			return EMPTY_MAP;
 		}
 
 		return findSubscriptionsInternal(destination, message);
 	}
 
 
-	protected abstract void addSubscriptionInternal(String sessionId, String subscriptionId,
-			String destination, Message<?> message);
+	protected abstract void addSubscriptionInternal(
+			String sessionId, String subscriptionId, String destination, Message<?> message);
 
-	protected abstract void removeSubscriptionInternal(String sessionId, String subscriptionId, Message<?> message);
+	protected abstract void removeSubscriptionInternal(
+			String sessionId, String subscriptionId, Message<?> message);
 
-	@Override
-	public abstract void unregisterAllSubscriptions(String sessionId);
-
-	protected abstract MultiValueMap<String, String> findSubscriptionsInternal(String destination, Message<?> message);
+	protected abstract MultiValueMap<String, String> findSubscriptionsInternal(
+			String destination, Message<?> message);
 
 }

spring-messaging/src/main/java/org/springframework/messaging/simp/broker/DefaultSubscriptionRegistry.java

@@ -136,8 +136,8 @@ public String getSelectorHeaderName() {
 
 
 	@Override
-	protected void addSubscriptionInternal(String sessionId, String subsId, String destination,
-			Message<?> message) {
+	protected void addSubscriptionInternal(
+			String sessionId, String subsId, String destination, Message<?> message) {
 
 		Expression expression = null;
 		MessageHeaders headers = message.getHeaders();
@@ -478,13 +478,14 @@ public String toString() {
 	}
 
 
-	private static class Subscription {
+	private static final class Subscription {
 
 		private final String id;
 
 		private final Expression selectorExpression;
 
 		public Subscription(String id, Expression selector) {
+			Assert.notNull(id, "Subscription id must not be null");
 			this.id = id;
 			this.selectorExpression = selector;
 		}
@@ -499,19 +500,12 @@ public Expression getSelectorExpression() {
 
 		@Override
 		public boolean equals(Object other) {
-			if (this == other) {
-				return true;
-			}
-			if (other == null || getClass() != other.getClass()) {
-				return false;
-			}
-			return getId().equals(((Subscription) other).getId());
-
+			return (this == other || (other instanceof Subscription && this.id.equals(((Subscription) other).id)));
 		}
 
 		@Override
 		public int hashCode() {
-			return getId().hashCode();
+			return this.id.hashCode();
 		}
 
 		@Override

spring-messaging/src/main/java/org/springframework/messaging/tcp/ReconnectStrategy.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -16,7 +16,6 @@
 
 package org.springframework.messaging.tcp;
 
-
 /**
  * A contract to determine the frequency of reconnect attempts after connection failure.
  *

spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/AbstractNioBufferReactorNettyCodec.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.messaging.tcp.reactor;
 
 import java.nio.ByteBuffer;
@@ -41,13 +42,14 @@ public Collection<Message<P>> decode(ByteBuf inputBuffer) {
 		return messages;
 	}
 
-	protected abstract List<Message<P>> decodeInternal(ByteBuffer nioBuffer);
-
 	@Override
 	public void encode(Message<P> message, ByteBuf outputBuffer) {
 		outputBuffer.writeBytes(encodeInternal(message));
 	}
 
+
+	protected abstract List<Message<P>> decodeInternal(ByteBuffer nioBuffer);
+
 	protected abstract ByteBuffer encodeInternal(Message<P> message);
 
 }

spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/MonoToListenableFutureAdapter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -28,12 +28,10 @@
  */
 class MonoToListenableFutureAdapter<T> extends AbstractMonoToListenableFutureAdapter<T, T> {
 
-
 	public MonoToListenableFutureAdapter(Mono<T> mono) {
 		super(mono);
 	}
 
-
 	@Override
 	protected T adapt(T result) {
 		return result;

spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/ReactorNettyTcpClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -115,6 +115,7 @@ public ReactorNettyTcpClient(Consumer<ClientOptions> optionsConsumer, ReactorNet
 	@Override
 	public ListenableFuture<Void> connect(final TcpConnectionHandler<P> handler) {
 		Assert.notNull(handler, "TcpConnectionHandler is required");
+
 		if (this.stopping) {
 			return handleShuttingDownConnectFailure(handler);
 		}
@@ -131,6 +132,7 @@ public ListenableFuture<Void> connect(final TcpConnectionHandler<P> handler) {
 	public ListenableFuture<Void> connect(TcpConnectionHandler<P> handler, ReconnectStrategy strategy) {
 		Assert.notNull(handler, "TcpConnectionHandler is required");
 		Assert.notNull(strategy, "ReconnectStrategy is required");
+
 		if (this.stopping) {
 			return handleShuttingDownConnectFailure(handler);
 		}
@@ -189,7 +191,6 @@ public ListenableFuture<Void> shutdown() {
 		ChannelGroupFuture close = this.channelGroup.close();
 		Mono<Void> completion = FutureMono.from(close)
 				.doAfterTerminate((x, e) -> {
-
 					// TODO: https://github.com/reactor/reactor-netty/issues/24
 					shutdownGlobalResources();
 
@@ -211,14 +212,14 @@ public ListenableFuture<Void> shutdown() {
 		return new MonoToListenableFutureAdapter<>(completion);
 	}
 
-	private static void shutdownGlobalResources() {
+	private void shutdownGlobalResources() {
 		try {
 			Method method = TcpResources.class.getDeclaredMethod("_dispose");
 			ReflectionUtils.makeAccessible(method);
 			ReflectionUtils.invokeMethod(method, TcpResources.get());
 		}
 		catch (NoSuchMethodException ex) {
-			ex.printStackTrace();
+			// ignore
 		}
 	}
 
@@ -227,15 +228,13 @@ private class ReactorNettyHandler implements BiFunction<NettyInbound, NettyOutbo
 
 		private final TcpConnectionHandler<P> connectionHandler;
 
-
 		ReactorNettyHandler(TcpConnectionHandler<P> handler) {
 			this.connectionHandler = handler;
 		}
 
-		@SuppressWarnings("unchecked")
 		@Override
+		@SuppressWarnings("unchecked")
 		public Publisher<Void> apply(NettyInbound inbound, NettyOutbound outbound) {
-
 			DirectProcessor<Void> completion = DirectProcessor.create();
 			TcpConnection<P> connection = new ReactorNettyTcpConnection<>(inbound, outbound,  codec, completion);
 			scheduler.schedule(() -> connectionHandler.afterConnected(connection));
@@ -254,6 +253,7 @@ public Publisher<Void> apply(NettyInbound inbound, NettyOutbound outbound) {
 		}
 	}
 
+
 	private static class StompMessageDecoder<P> extends ByteToMessageDecoder {
 
 		private final ReactorNettyCodec<P> codec;

spring-messaging/src/main/java/org/springframework/messaging/tcp/reactor/ReactorNettyTcpConnection.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -66,7 +66,6 @@ public ListenableFuture<Void> send(Message<P> message) {
 	@Override
 	@SuppressWarnings("deprecation")
 	public void onReadInactivity(Runnable runnable, long inactivityDuration) {
-
 		// TODO: workaround for https://github.com/reactor/reactor-netty/issues/22
 		ChannelPipeline pipeline = this.inbound.context().channel().pipeline();
 		String name = NettyPipeline.OnChannelReadIdle;

spring-web/src/main/java/org/springframework/web/cors/CorsConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -112,7 +112,7 @@ public void setAllowedOrigins(List<String> allowedOrigins) {
 	}
 
 	/**
-	 * Return the configured origins to allow, possibly {@code null}.
+	 * Return the configured origins to allow, or {@code null} if none.
 	 * @see #addAllowedOrigin(String)
 	 * @see #setAllowedOrigins(List)
 	 */
@@ -155,7 +155,7 @@ public void setAllowedMethods(List<String> allowedMethods) {
 	}
 
 	/**
-	 * Return the allowed HTTP methods, possibly {@code null} in which case
+	 * Return the allowed HTTP methods, or {@code null} in which case
 	 * only {@code "GET"} and {@code "HEAD"} allowed.
 	 * @see #addAllowedMethod(HttpMethod)
 	 * @see #addAllowedMethod(String)
@@ -208,7 +208,7 @@ public void setAllowedHeaders(List<String> allowedHeaders) {
 	}
 
 	/**
-	 * Return the allowed actual request headers, possibly {@code null}.
+	 * Return the allowed actual request headers, or {@code null} if none.
 	 * @see #addAllowedHeader(String)
 	 * @see #setAllowedHeaders(List)
 	 */
@@ -242,7 +242,7 @@ public void setExposedHeaders(List<String> exposedHeaders) {
 	}
 
 	/**
-	 * Return the configured response headers to expose, possibly {@code null}.
+	 * Return the configured response headers to expose, or {@code null} if none.
 	 * @see #addExposedHeader(String)
 	 * @see #setExposedHeaders(List)
 	 */
@@ -273,7 +273,7 @@ public void setAllowCredentials(Boolean allowCredentials) {
 	}
 
 	/**
-	 * Return the configured {@code allowCredentials} flag, possibly {@code null}.
+	 * Return the configured {@code allowCredentials} flag, or {@code null} if none.
 	 * @see #setAllowCredentials(Boolean)
 	 */
 	public Boolean getAllowCredentials() {
@@ -290,7 +290,7 @@ public void setMaxAge(Long maxAge) {
 	}
 
 	/**
-	 * Return the configured {@code maxAge} value, possibly {@code null}.
+	 * Return the configured {@code maxAge} value, or {@code null} if none.
 	 * @see #setMaxAge(Long)
 	 */
 	public Long getMaxAge() {
@@ -378,7 +378,7 @@ private List<String> combine(List<String> source, List<String> other) {
 	/**
 	 * Check the origin of the request against the configured allowed origins.
 	 * @param requestOrigin the origin to check
-	 * @return the origin to use for the response, possibly {@code null} which
+	 * @return the origin to use for the response, or {@code null} which
 	 * means the request origin is not allowed
 	 */
 	public String checkOrigin(String requestOrigin) {

spring-webflux/src/main/java/org/springframework/web/reactive/function/BodyExtractor.java

@@ -26,11 +26,10 @@
 /**
  * A function that can extract data from a {@link ReactiveHttpInputMessage} body.
  *
- * @param <T> the type of data to extract
- * @param <M> the type of {@link ReactiveHttpInputMessage} this extractor can be applied to
- *
  * @author Arjen Poutsma
  * @since 5.0
+ * @param <T> the type of data to extract
+ * @param <M> the type of {@link ReactiveHttpInputMessage} this extractor can be applied to
  * @see BodyExtractors
  */
 @FunctionalInterface

spring-webflux/src/main/java/org/springframework/web/reactive/function/BodyInserter.java

@@ -28,11 +28,10 @@
 /**
  * A combination of functions that can populate a {@link ReactiveHttpOutputMessage} body.
  *
- * @param <T> the type of data to insert
- * @param <M> the type of {@link ReactiveHttpOutputMessage} this inserter can be applied to
- *
  * @author Arjen Poutsma
  * @since 5.0
+ * @param <T> the type of data to insert
+ * @param <M> the type of {@link ReactiveHttpOutputMessage} this inserter can be applied to
  * @see BodyInserters
  */
 @FunctionalInterface