Consistent declaration and use of UTF-8 Charset constants, plus related polishing

Author: jhoeller

spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompDecoder.java

@@ -67,21 +67,20 @@ public void setHeaderInitializer(MessageHeaderInitializer headerInitializer) {
 	}
 
 	/**
-	 * @return the configured {@code MessageHeaderInitializer} if any.
+	 * Return the configured {@code MessageHeaderInitializer}, if any.
 	 */
 	public MessageHeaderInitializer getHeaderInitializer() {
 		return this.headerInitializer;
 	}
 
+
 	/**
 	 * Decodes one or more STOMP frames from the given {@code ByteBuffer} into a
-	 * list of {@link Message}s. If the input buffer contains any incplcontains partial STOMP frame content, or additional
-	 * content with a partial STOMP frame, the buffer is reset and {@code null} is
-	 * returned.
-	 *
+	 * list of {@link Message}s. If the input buffer contains partial STOMP frame
+	 * content, or additional content with a partial STOMP frame, the buffer is
+	 * reset and {@code null} is returned.
 	 * @param buffer The buffer to decode the STOMP frame from
-	 *
-	 * @return the decoded messages or an empty list
+	 * @return the decoded messages, or an empty list if none
 	 */
 	public List<Message<byte[]>> decode(ByteBuffer buffer) {
 		return decode(buffer, null);
@@ -90,33 +89,28 @@ public List<Message<byte[]>> decode(ByteBuffer buffer) {
 	/**
 	 * Decodes one or more STOMP frames from the given {@code buffer} and returns
 	 * a list of {@link Message}s.
-	 *
 	 * <p>If the given ByteBuffer contains only partial STOMP frame content and no
 	 * complete STOMP frames, an empty list is returned, and the buffer is reset to
 	 * to where it was.
-	 *
 	 * <p>If the buffer contains one ore more STOMP frames, those are returned and
 	 * the buffer reset to point to the beginning of the unused partial content.
-	 *
 	 * <p>The output partialMessageHeaders map is used to store successfully parsed
 	 * headers in case of partial content. The caller can then check if a
 	 * "content-length" header was read, which helps to determine how much more
 	 * content is needed before the next attempt to decode.
-	 *
 	 * @param buffer The buffer to decode the STOMP frame from
 	 * @param partialMessageHeaders an empty output map that will store the last
 	 * successfully parsed partialMessageHeaders in case of partial message content
 	 * in cases where the partial buffer ended with a partial STOMP frame
-	 *
 	 * @return decoded messages or an empty list
 	 * @throws StompConversionException raised in case of decoding issues
 	 */
 	public List<Message<byte[]>> decode(ByteBuffer buffer, MultiValueMap<String, String> partialMessageHeaders) {
 		List<Message<byte[]>> messages = new ArrayList<Message<byte[]>>();
 		while (buffer.hasRemaining()) {
-			Message<byte[]> m = decodeMessage(buffer, partialMessageHeaders);
-			if (m != null) {
-				messages.add(m);
+			Message<byte[]> message = decodeMessage(buffer, partialMessageHeaders);
+			if (message != null) {
+				messages.add(message);
 			}
 			else {
 				break;
@@ -129,28 +123,23 @@ public List<Message<byte[]>> decode(ByteBuffer buffer, MultiValueMap<String, Str
 	 * Decode a single STOMP frame from the given {@code buffer} into a {@link Message}.
 	 */
 	private Message<byte[]> decodeMessage(ByteBuffer buffer, MultiValueMap<String, String> headers) {
-
 		Message<byte[]> decodedMessage = null;
 		skipLeadingEol(buffer);
 		buffer.mark();
 
 		String command = readCommand(buffer);
 		if (command.length() > 0) {
-
 			StompHeaderAccessor headerAccessor = null;
 			byte[] payload = null;
-
 			if (buffer.remaining() > 0) {
 				StompCommand stompCommand = StompCommand.valueOf(command);
 				headerAccessor = StompHeaderAccessor.create(stompCommand);
 				initHeaders(headerAccessor);
-
 				readHeaders(buffer, headerAccessor);
 				payload = readPayload(buffer, headerAccessor);
 			}
-
 			if (payload != null) {
-				if ((payload.length > 0) && (!headerAccessor.getCommand().isBodyAllowed())) {
+				if (payload.length > 0 && !headerAccessor.getCommand().isBodyAllowed()) {
 					throw new StompConversionException(headerAccessor.getCommand() +
 							" shouldn't have a payload: length=" + payload.length + ", headers=" + headers);
 				}
@@ -185,12 +174,14 @@ private Message<byte[]> decodeMessage(ByteBuffer buffer, MultiValueMap<String, S
 				logger.trace("Decoded " + headerAccessor.getDetailedLogMessage(null));
 			}
 		}
+
 		return decodedMessage;
 	}
 
 	private void initHeaders(StompHeaderAccessor headerAccessor) {
-		if (getHeaderInitializer() != null) {
-			getHeaderInitializer().initHeaders(headerAccessor);
+		MessageHeaderInitializer initializer = getHeaderInitializer();
+		if (initializer != null) {
+			initializer.initHeaders(headerAccessor);
 		}
 	}
 
@@ -253,14 +244,13 @@ private void readHeaders(ByteBuffer buffer, StompHeaderAccessor headerAccessor)
 	 * <a href="http://stomp.github.io/stomp-specification-1.2.html#Value_Encoding">"Value Encoding"</a>.
 	 */
 	private String unescape(String inString) {
-
-		StringBuilder sb = new StringBuilder();
-		int pos = 0; // position in the old string
+		StringBuilder sb = new StringBuilder(inString.length());
+		int pos = 0;  // position in the old string
 		int index = inString.indexOf("\\");
 
 		while (index >= 0) {
 			sb.append(inString.substring(pos, index));
-			if((index + 1) >= inString.length()) {
+			if (index + 1 >= inString.length()) {
 				throw new StompConversionException("Illegal escape sequence at index " + index + ": " + inString);
 			}
 			Character c = inString.charAt(index + 1);
@@ -289,7 +279,6 @@ else if (c == '\\') {
 	}
 
 	private byte[] readPayload(ByteBuffer buffer, StompHeaderAccessor headerAccessor) {
-
 		Integer contentLength;
 		try {
 			contentLength = headerAccessor.getContentLength();
@@ -329,7 +318,6 @@ private byte[] readPayload(ByteBuffer buffer, StompHeaderAccessor headerAccessor
 
 	/**
 	 * Try to read an EOL incrementing the buffer position if successful.
-	 *
 	 * @return whether an EOL was consumed
 	 */
 	private boolean tryConsumeEndOfLine(ByteBuffer buffer) {

spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompEncoder.java

@@ -51,7 +51,6 @@ public final class StompEncoder  {
 
 	/**
 	 * Encodes the given STOMP {@code message} into a {@code byte[]}
-	 *
 	 * @param message the message to encode
 	 * @return the encoded message
 	 */
@@ -61,14 +60,14 @@ public byte[] encode(Message<byte[]> message) {
 
 	/**
 	 * Encodes the given payload and headers into a {@code byte[]}.
-	 *
 	 * @param headers the headers
 	 * @param payload the payload
 	 * @return the encoded message
 	 */
 	public byte[] encode(Map<String, Object> headers, byte[] payload) {
 		Assert.notNull(headers, "'headers' is required");
 		Assert.notNull(payload, "'payload' is required");
+
 		try {
 			ByteArrayOutputStream baos = new ByteArrayOutputStream(128 + payload.length);
 			DataOutputStream output = new DataOutputStream(baos);
@@ -89,8 +88,8 @@ public byte[] encode(Map<String, Object> headers, byte[] payload) {
 
 			return baos.toByteArray();
 		}
-		catch (IOException e) {
-			throw new StompConversionException("Failed to encode STOMP frame, headers=" + headers + ".",  e);
+		catch (IOException ex) {
+			throw new StompConversionException("Failed to encode STOMP frame, headers=" + headers,  ex);
 		}
 	}
 
@@ -102,7 +101,7 @@ private void writeHeaders(StompCommand command, Map<String, Object> headers, byt
 				(Map<String, List<String>>) headers.get(NativeMessageHeaderAccessor.NATIVE_HEADERS);
 
 		if (logger.isTraceEnabled()) {
-			logger.trace("Encoding STOMP " + command + ", headers=" + nativeHeaders + ".");
+			logger.trace("Encoding STOMP " + command + ", headers=" + nativeHeaders);
 		}
 
 		if (nativeHeaders == null) {
@@ -137,8 +136,8 @@ private void writeHeaders(StompCommand command, Map<String, Object> headers, byt
 	}
 
 	private byte[] encodeHeaderString(String input, boolean escape) {
-		input = escape ? escape(input) : input;
-		return input.getBytes(StompDecoder.UTF8_CHARSET);
+		String inputToUse = (escape ? escape(input) : input);
+		return inputToUse.getBytes(StompDecoder.UTF8_CHARSET);
 	}
 
 	/**

spring-web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java

@@ -86,14 +86,16 @@
  */
 public class FormHttpMessageConverter implements HttpMessageConverter<MultiValueMap<String, ?>> {
 
+	public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
+
 	private static final byte[] BOUNDARY_CHARS =
 			new byte[] {'-', '_', '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', 'a', 'b', 'c', 'd', 'e', 'f', 'g',
 					'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', 'A',
 					'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U',
 					'V', 'W', 'X', 'Y', 'Z'};
 
 
-	private Charset charset = Charset.forName("UTF-8");
+	private Charset charset = DEFAULT_CHARSET;
 
 	private Charset multipartCharset;
 

spring-web/src/main/java/org/springframework/http/converter/StringHttpMessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2014 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.
@@ -41,6 +41,7 @@ public class StringHttpMessageConverter extends AbstractHttpMessageConverter<Str
 
 	public static final Charset DEFAULT_CHARSET = Charset.forName("ISO-8859-1");
 
+
 	private final Charset defaultCharset;
 
 	private final List<Charset> availableCharsets;
@@ -66,6 +67,7 @@ public StringHttpMessageConverter(Charset defaultCharset) {
 		this.availableCharsets = new ArrayList<Charset>(Charset.availableCharsets().values());
 	}
 
+
 	/**
 	 * Indicates whether the {@code Accept-Charset} should be written to any outgoing request.
 	 * <p>Default is {@code true}.
@@ -74,6 +76,7 @@ public void setWriteAcceptCharset(boolean writeAcceptCharset) {
 		this.writeAcceptCharset = writeAcceptCharset;
 	}
 
+
 	@Override
 	public boolean supports(Class<?> clazz) {
 		return String.class.equals(clazz);
@@ -86,10 +89,10 @@ protected String readInternal(Class<? extends String> clazz, HttpInputMessage in
 	}
 
 	@Override
-	protected Long getContentLength(String s, MediaType contentType) {
+	protected Long getContentLength(String str, MediaType contentType) {
 		Charset charset = getContentTypeCharset(contentType);
 		try {
-			return (long) s.getBytes(charset.name()).length;
+			return (long) str.getBytes(charset.name()).length;
 		}
 		catch (UnsupportedEncodingException ex) {
 			// should not occur
@@ -98,17 +101,19 @@ protected Long getContentLength(String s, MediaType contentType) {
 	}
 
 	@Override
-	protected void writeInternal(String s, HttpOutputMessage outputMessage) throws IOException {
+	protected void writeInternal(String str, HttpOutputMessage outputMessage) throws IOException {
 		if (this.writeAcceptCharset) {
 			outputMessage.getHeaders().setAcceptCharset(getAcceptedCharsets());
 		}
 		Charset charset = getContentTypeCharset(outputMessage.getHeaders().getContentType());
-		StreamUtils.copy(s, charset, outputMessage.getBody());
+		StreamUtils.copy(str, charset, outputMessage.getBody());
 	}
 
+
 	/**
-	 * Return the list of supported {@link Charset}.
-	 * <p>By default, returns {@link Charset#availableCharsets()}. Can be overridden in subclasses.
+	 * Return the list of supported {@link Charset}s.
+	 * <p>By default, returns {@link Charset#availableCharsets()}.
+	 * Can be overridden in subclasses.
 	 * @return the list of accepted charsets
 	 */
 	protected List<Charset> getAcceptedCharsets() {
@@ -123,4 +128,5 @@ private Charset getContentTypeCharset(MediaType contentType) {
 			return this.defaultCharset;
 		}
 	}
+
 }

spring-websocket/src/main/java/org/springframework/web/socket/TextMessage.java

@@ -26,7 +26,7 @@
  */
 public final class TextMessage extends AbstractWebSocketMessage<String> {
 
-	private static final Charset UTF_8 = Charset.forName("UTF-8");
+	private static final Charset UTF8_CHARSET = Charset.forName("UTF-8");
 
 	private final byte[] bytes;
 
@@ -46,7 +46,7 @@ public TextMessage(CharSequence payload) {
 	 * @param payload the non-null payload
 	 */
 	public TextMessage(byte[] payload) {
-		super(new String(payload, UTF_8));
+		super(new String(payload, UTF8_CHARSET));
 		this.bytes = payload;
 	}
 
@@ -70,7 +70,7 @@ public int getPayloadLength() {
 	}
 
 	public byte[] asBytes() {
-		return (this.bytes != null ? this.bytes : getPayload().getBytes(UTF_8));
+		return (this.bytes != null ? this.bytes : getPayload().getBytes(UTF8_CHARSET));
 	}
 
 	@Override

spring-websocket/src/main/java/org/springframework/web/socket/server/support/DefaultHandshakeHandler.java

@@ -17,6 +17,7 @@
 package org.springframework.web.socket.server.support;
 
 import java.io.IOException;
+import java.nio.charset.Charset;
 import java.security.Principal;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -60,6 +61,9 @@
  */
 public class DefaultHandshakeHandler implements HandshakeHandler {
 
+	private static final Charset UTF8_CHARSET = Charset.forName("UTF-8");
+
+
 	private static final boolean jettyWsPresent = ClassUtils.isPresent(
 			"org.eclipse.jetty.websocket.server.WebSocketServerFactory", DefaultHandshakeHandler.class.getClassLoader());
 
@@ -223,15 +227,15 @@ protected void handleInvalidUpgradeHeader(ServerHttpRequest request, ServerHttpR
 			logger.error("Handshake failed due to invalid Upgrade header: " + request.getHeaders().getUpgrade());
 		}
 		response.setStatusCode(HttpStatus.BAD_REQUEST);
-		response.getBody().write("Can \"Upgrade\" only to \"WebSocket\".".getBytes("UTF-8"));
+		response.getBody().write("Can \"Upgrade\" only to \"WebSocket\".".getBytes(UTF8_CHARSET));
 	}
 
 	protected void handleInvalidConnectHeader(ServerHttpRequest request, ServerHttpResponse response) throws IOException {
 		if (logger.isErrorEnabled()) {
 			logger.error("Handshake failed due to invalid Connection header " + request.getHeaders().getConnection());
 		}
 		response.setStatusCode(HttpStatus.BAD_REQUEST);
-		response.getBody().write("\"Connection\" must be \"upgrade\".".getBytes("UTF-8"));
+		response.getBody().write("\"Connection\" must be \"upgrade\".".getBytes(UTF8_CHARSET));
 	}
 
 	protected boolean isWebSocketVersionSupported(WebSocketHttpHeaders httpHeaders) {

spring-websocket/src/main/java/org/springframework/web/socket/sockjs/support/AbstractSockJsService.java

@@ -337,8 +337,8 @@ public final void handleRequest(ServerHttpRequest request, ServerHttpResponse re
 		try {
 			if (sockJsPath.equals("") || sockJsPath.equals("/")) {
 				logger.debug(requestInfo);
-				response.getHeaders().setContentType(new MediaType("text", "plain", Charset.forName("UTF-8")));
-				response.getBody().write("Welcome to SockJS!\n".getBytes("UTF-8"));
+				response.getHeaders().setContentType(new MediaType("text", "plain", UTF8_CHARSET));
+				response.getBody().write("Welcome to SockJS!\n".getBytes(UTF8_CHARSET));
 			}
 			else if (sockJsPath.equals("/info")) {
 				logger.debug(requestInfo);

spring-websocket/src/main/java/org/springframework/web/socket/sockjs/transport/handler/AbstractHttpReceivingTransportHandler.java

@@ -87,7 +87,7 @@ protected void handleRequestInternal(ServerHttpRequest request, ServerHttpRespon
 	private void handleReadError(ServerHttpResponse response, String error, String sessionId) {
 		try {
 			response.setStatusCode(HttpStatus.INTERNAL_SERVER_ERROR);
-			response.getBody().write(error.getBytes("UTF-8"));
+			response.getBody().write(error.getBytes(UTF8_CHARSET));
 		}
 		catch (IOException ex) {
 			throw new SockJsException("Failed to send error: " + error, sessionId, ex);