Revise encoding steps towards use of JDK Charset and StandardCharsets

Issue: SPR-14492

Author: jhoeller

spring-beans/src/main/java/org/springframework/beans/propertyeditors/PropertiesEditor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -19,6 +19,7 @@
 import java.beans.PropertyEditorSupport;
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 import java.util.Map;
 import java.util.Properties;
 
@@ -49,7 +50,7 @@ public void setAsText(String text) throws IllegalArgumentException {
 		if (text != null) {
 			try {
 				// Must use the ISO-8859-1 encoding because Properties.load(stream) expects it.
-				props.load(new ByteArrayInputStream(text.getBytes("ISO-8859-1")));
+				props.load(new ByteArrayInputStream(text.getBytes(StandardCharsets.ISO_8859_1)));
 			}
 			catch (IOException ex) {
 				// Should never happen.

spring-core/src/main/java/org/springframework/core/convert/support/StringToPropertiesConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -17,6 +17,7 @@
 package org.springframework.core.convert.support;
 
 import java.io.ByteArrayInputStream;
+import java.nio.charset.StandardCharsets;
 import java.util.Properties;
 
 import org.springframework.core.convert.converter.Converter;
@@ -35,7 +36,7 @@ public Properties convert(String source) {
 		try {
 			Properties props = new Properties();
 			// Must use the ISO-8859-1 encoding because Properties.load(stream) expects it.
-			props.load(new ByteArrayInputStream(source.getBytes("ISO-8859-1")));
+			props.load(new ByteArrayInputStream(source.getBytes(StandardCharsets.ISO_8859_1)));
 			return props;
 		}
 		catch (Exception ex) {

spring-core/src/main/java/org/springframework/util/Base64Utils.java

@@ -17,6 +17,7 @@
 package org.springframework.util;
 
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.Base64;
 
 /**
@@ -31,7 +32,7 @@
  */
 public abstract class Base64Utils {
 
-	private static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
+	private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
 
 
 	/**

spring-core/src/test/java/org/springframework/core/convert/support/DefaultConversionServiceTests.java

@@ -21,6 +21,7 @@
 import java.math.BigDecimal;
 import java.math.BigInteger;
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.time.ZoneId;
 import java.util.AbstractList;
 import java.util.ArrayList;
@@ -277,12 +278,12 @@ public void testStringToLocale() {
 
 	@Test
 	public void testStringToCharset() {
-		assertEquals(Charset.forName("UTF-8"), conversionService.convert("UTF-8", Charset.class));
+		assertEquals(StandardCharsets.UTF_8, conversionService.convert("UTF-8", Charset.class));
 	}
 
 	@Test
 	public void testCharsetToString() {
-		assertEquals("UTF-8", conversionService.convert(Charset.forName("UTF-8"), String.class));
+		assertEquals("UTF-8", conversionService.convert(StandardCharsets.UTF_8, String.class));
 	}
 
 	@Test

spring-core/src/test/java/org/springframework/util/MimeTypeTests.java

@@ -17,6 +17,7 @@
 package org.springframework.util;
 
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
@@ -27,7 +28,7 @@
 import org.springframework.core.convert.ConversionService;
 import org.springframework.core.convert.support.DefaultConversionService;
 
-import static java.util.Collections.singletonMap;
+import static java.util.Collections.*;
 import static org.junit.Assert.*;
 
 /**
@@ -84,7 +85,7 @@ public void parseQuotedCharset() {
 		MimeType mimeType = MimeType.valueOf(s);
 		assertEquals("Invalid type", "application", mimeType.getType());
 		assertEquals("Invalid subtype", "xml", mimeType.getSubtype());
-		assertEquals("Invalid charset", Charset.forName("UTF-8"), mimeType.getCharset());
+		assertEquals("Invalid charset", StandardCharsets.UTF_8, mimeType.getCharset());
 	}
 
 	@Test

spring-expression/src/test/java/org/springframework/expression/spel/SpelReproTests.java

@@ -19,7 +19,7 @@
 import java.lang.reflect.Array;
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
-import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -2091,7 +2091,7 @@ public void SPR13918() {
 
 		Expression ex = parser.parseExpression("T(java.nio.charset.Charset).forName(#encoding)");
 		Object result = ex.getValue(context);
-		assertEquals(Charset.forName("UTF-8"), result);
+		assertEquals(StandardCharsets.UTF_8, result);
 	}
 
 

spring-jdbc/src/main/java/org/springframework/jdbc/support/lob/PassThroughClob.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2016 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 java.io.StringReader;
 import java.io.UnsupportedEncodingException;
 import java.io.Writer;
+import java.nio.charset.StandardCharsets;
 import java.sql.Clob;
 import java.sql.SQLException;
 
@@ -91,11 +92,11 @@ else if (this.characterStream != null) {
 	public InputStream getAsciiStream() throws SQLException {
 		try {
 			if (this.content != null) {
-				return new ByteArrayInputStream(this.content.getBytes("US-ASCII"));
+				return new ByteArrayInputStream(this.content.getBytes(StandardCharsets.US_ASCII));
 			}
 			else if (this.characterStream != null) {
 				String tempContent = FileCopyUtils.copyToString(this.characterStream);
-				return new ByteArrayInputStream(tempContent.getBytes("US-ASCII"));
+				return new ByteArrayInputStream(tempContent.getBytes(StandardCharsets.US_ASCII));
 			}
 			else {
 				return this.asciiStream;

spring-messaging/src/main/java/org/springframework/messaging/converter/MappingJackson2MessageConverter.java

@@ -22,6 +22,7 @@
 import java.io.Writer;
 import java.lang.reflect.Type;
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.concurrent.atomic.AtomicReference;
 
@@ -70,7 +71,7 @@ public class MappingJackson2MessageConverter extends AbstractMessageConverter {
 	 * the {@code application/json} MIME type with {@code UTF-8} character set.
 	 */
 	public MappingJackson2MessageConverter() {
-		super(new MimeType("application", "json", Charset.forName("UTF-8")));
+		super(new MimeType("application", "json", StandardCharsets.UTF_8));
 		initObjectMapper();
 	}
 

spring-messaging/src/main/java/org/springframework/messaging/converter/StringMessageConverter.java

@@ -17,6 +17,7 @@
 package org.springframework.messaging.converter;
 
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessageHeaders;
@@ -35,7 +36,7 @@ public class StringMessageConverter extends AbstractMessageConverter {
 
 
 	public StringMessageConverter() {
-		this(Charset.forName("UTF-8"));
+		this(StandardCharsets.UTF_8);
 	}
 
 	public StringMessageConverter(Charset defaultCharset) {

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

@@ -19,6 +19,7 @@
 import java.io.ByteArrayOutputStream;
 import java.nio.ByteBuffer;
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -47,13 +48,10 @@
  */
 public class StompDecoder {
 
-	static final Charset UTF8_CHARSET = Charset.forName("UTF-8");
-
 	static final byte[] HEARTBEAT_PAYLOAD = new byte[] {'\n'};
 
 	private static final Log logger = LogFactory.getLog(StompDecoder.class);
 
-
 	private MessageHeaderInitializer headerInitializer;
 
 
@@ -202,7 +200,7 @@ private String readCommand(ByteBuffer buffer) {
 		while (buffer.remaining() > 0 && !tryConsumeEndOfLine(buffer)) {
 			command.write(buffer.get());
 		}
-		return new String(command.toByteArray(), UTF8_CHARSET);
+		return new String(command.toByteArray(), StandardCharsets.UTF_8);
 	}
 
 	private void readHeaders(ByteBuffer buffer, StompHeaderAccessor headerAccessor) {
@@ -217,7 +215,7 @@ private void readHeaders(ByteBuffer buffer, StompHeaderAccessor headerAccessor)
 				headerStream.write(buffer.get());
 			}
 			if (headerStream.size() > 0 && headerComplete) {
-				String header = new String(headerStream.toByteArray(), UTF8_CHARSET);
+				String header = new String(headerStream.toByteArray(), StandardCharsets.UTF_8);
 				int colonIndex = header.indexOf(':');
 				if (colonIndex <= 0) {
 					if (buffer.remaining() > 0) {

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

@@ -19,6 +19,7 @@
 import java.io.ByteArrayOutputStream;
 import java.io.DataOutputStream;
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
@@ -81,7 +82,7 @@ public byte[] encode(Map<String, Object> headers, byte[] payload) {
 			else {
 				StompCommand command = StompHeaderAccessor.getCommand(headers);
 				Assert.notNull(command, "Missing STOMP command: " + headers);
-				output.write(command.toString().getBytes(StompDecoder.UTF8_CHARSET));
+				output.write(command.toString().getBytes(StandardCharsets.UTF_8));
 				output.write(LF);
 				writeHeaders(command, headers, payload, output);
 				output.write(LF);
@@ -132,15 +133,15 @@ private void writeHeaders(StompCommand command, Map<String, Object> headers, byt
 		}
 		if (command.requiresContentLength()) {
 			int contentLength = payload.length;
-			output.write("content-length:".getBytes(StompDecoder.UTF8_CHARSET));
-			output.write(Integer.toString(contentLength).getBytes(StompDecoder.UTF8_CHARSET));
+			output.write("content-length:".getBytes(StandardCharsets.UTF_8));
+			output.write(Integer.toString(contentLength).getBytes(StandardCharsets.UTF_8));
 			output.write(LF);
 		}
 	}
 
 	private byte[] encodeHeaderString(String input, boolean escape) {
 		String inputToUse = (escape ? escape(input) : input);
-		return inputToUse.getBytes(StompDecoder.UTF8_CHARSET);
+		return inputToUse.getBytes(StandardCharsets.UTF_8);
 	}
 
 	/**

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

@@ -17,6 +17,7 @@
 package org.springframework.messaging.simp.stomp;
 
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
@@ -441,7 +442,7 @@ private String appendPayload(Object payload) {
 			return contentType;
 		}
 		Charset charset = getContentType().getCharset();
-		charset = (charset != null ? charset : StompDecoder.UTF8_CHARSET);
+		charset = (charset != null ? charset : StandardCharsets.UTF_8);
 		return (bytes.length < 80) ?
 				contentType + " payload=" + new String(bytes, charset) :
 				contentType + " payload=" + new String(Arrays.copyOf(bytes, 80), charset) + "...(truncated)";

spring-messaging/src/main/java/org/springframework/messaging/support/MessageHeaderAccessor.java

@@ -17,6 +17,7 @@
 package org.springframework.messaging.support;
 
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
@@ -115,7 +116,7 @@
  */
 public class MessageHeaderAccessor {
 
-	public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
+	public static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
 
 	private static final MimeType[] READABLE_MIME_TYPES = new MimeType[] {
 			MimeTypeUtils.APPLICATION_JSON, MimeTypeUtils.APPLICATION_XML,