mediaType: clean up charset handle

- fix #3755

Author: jknack

jooby/src/main/java/io/jooby/Context.java

@@ -571,7 +571,8 @@ default Locale locale() {
    * Recreates full/entire url of the current request using the <code>Host</code> header.
    *
    * <p>If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header,
-   * please consider to set {@link Router#setTrustProxy(boolean)} option.
+   * please consider to set {@link Router#setRouterOptions(RouterOptions)} {@link
+   * RouterOptions#setTrustProxy(boolean)} option.
    *
    * @return Full/entire request url using the <code>Host</code> header.
    */
@@ -581,7 +582,8 @@ default Locale locale() {
    * Recreates full/entire request url using the <code>Host</code> header with a custom path/suffix.
    *
    * <p>If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header,
-   * please consider to set {@link Router#setTrustProxy(boolean)} option.
+   * please consider to set {@link Router#setRouterOptions(RouterOptions)} {@link
+   * RouterOptions#setTrustProxy(boolean)} option.
    *
    * @param path Path or suffix to use, can also include query string parameters.
    * @return Full/entire request url using the <code>Host</code> header.
@@ -592,7 +594,8 @@ default Locale locale() {
    * The IP address of the client or last proxy that sent the request.
    *
    * <p>If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header,
-   * please consider to set {@link Router#setTrustProxy(boolean)} option.
+   * please consider to set {@link Router#setRouterOptions(RouterOptions)} {@link
+   * RouterOptions#setTrustProxy(boolean)} option.
    *
    * @return The IP address of the client or last proxy that sent the request or <code>empty string
    *     </code> for interrupted requests.
@@ -613,7 +616,8 @@ default Locale locale() {
    * method.
    *
    * <p>If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header,
-   * please consider to set {@link Router#setTrustProxy(boolean)} option.
+   * please consider to set {@link Router#setRouterOptions(RouterOptions)} {@link
+   * RouterOptions#setTrustProxy(boolean)} option.
    *
    * @return Return the host that this request was sent to, in general this will be the value of the
    *     Host header, minus the port specifier.
@@ -635,7 +639,8 @@ default Locale locale() {
    * the Host.
    *
    * <p>If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header,
-   * please consider to set {@link Router#setTrustProxy(boolean)} option.
+   * please consider to set {@link Router#setRouterOptions(RouterOptions)} {@link
+   * RouterOptions#setTrustProxy(boolean)} option.
    *
    * @return Return the host that this request was sent to, in general this will be the value of the
    *     Host header.
@@ -1086,15 +1091,6 @@ default Value lookup(String name) {
    */
   Context setResponseType(@NonNull MediaType contentType);
 
-  /**
-   * Set response content type header.
-   *
-   * @param contentType Content type.
-   * @param charset Charset.
-   * @return This context.
-   */
-  Context setResponseType(@NonNull MediaType contentType, @Nullable Charset charset);
-
   /**
    * Set the default response content type header. It is used if the response content type header
    * was not set yet.
@@ -1200,15 +1196,6 @@ Context responseStream(
    */
   PrintWriter responseWriter(@NonNull MediaType contentType);
 
-  /**
-   * HTTP response channel as response writer.
-   *
-   * @param contentType Content type.
-   * @param charset Charset.
-   * @return HTTP channel as response writer. Usually for chunked response.
-   */
-  PrintWriter responseWriter(@NonNull MediaType contentType, @Nullable Charset charset);
-
   /**
    * HTTP response channel as response writer.
    *
@@ -1229,19 +1216,6 @@ Context responseStream(
   Context responseWriter(
       MediaType contentType, @NonNull SneakyThrows.Consumer<PrintWriter> consumer) throws Exception;
 
-  /**
-   * HTTP response channel as response writer.
-   *
-   * @param contentType Content type.
-   * @param charset Charset.
-   * @param consumer Writer consumer.
-   * @return This context.
-   * @throws Exception Is something goes wrong.
-   */
-  Context responseWriter(
-      MediaType contentType, @Nullable Charset charset, SneakyThrows.Consumer<PrintWriter> consumer)
-      throws Exception;
-
   /**
    * Send a <code>302</code> response.
    *
@@ -1390,10 +1364,12 @@ Context responseWriter(
 
   /**
    * True if response headers are cleared on application error. If none set it uses the
-   * default/global value specified by {@link RouterOptions#RESET_HEADERS_ON_ERROR}.
+   * default/global value specified by {@link Router#setRouterOptions(RouterOptions)} {@link
+   * RouterOptions#setResetHeadersOnError(boolean)} option.
    *
    * @return True if response headers are cleared on application error. If none set it uses the
-   *     default/global value specified by {@link RouterOptions#RESET_HEADERS_ON_ERROR}.
+   *     default/global value specified by {@link Router#setRouterOptions(RouterOptions)} {@link
+   *     RouterOptions#setResetHeadersOnError(boolean)} option.
    */
   boolean getResetHeadersOnError();
 

jooby/src/main/java/io/jooby/DefaultContext.java

@@ -16,7 +16,6 @@
 import java.lang.reflect.Type;
 import java.nio.ByteBuffer;
 import java.nio.channels.FileChannel;
-import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
 import java.time.Instant;
@@ -503,11 +502,6 @@ default Context setResponseHeader(@NonNull String name, @NonNull Object value) {
     return setResponseHeader(name, value.toString());
   }
 
-  @Override
-  default Context setResponseType(@NonNull MediaType contentType) {
-    return setResponseType(contentType, contentType.getCharset());
-  }
-
   @Override
   default Context setResponseCode(@NonNull StatusCode statusCode) {
     return setResponseCode(statusCode.value());
@@ -560,11 +554,6 @@ default PrintWriter responseWriter() {
     return responseWriter(MediaType.text);
   }
 
-  @Override
-  default PrintWriter responseWriter(@NonNull MediaType contentType) {
-    return responseWriter(contentType, contentType.getCharset());
-  }
-
   @Override
   default Context responseWriter(@NonNull SneakyThrows.Consumer<PrintWriter> consumer)
       throws Exception {
@@ -575,16 +564,7 @@ default Context responseWriter(@NonNull SneakyThrows.Consumer<PrintWriter> consu
   default Context responseWriter(
       @NonNull MediaType contentType, @NonNull SneakyThrows.Consumer<PrintWriter> consumer)
       throws Exception {
-    return responseWriter(contentType, contentType.getCharset(), consumer);
-  }
-
-  @Override
-  default Context responseWriter(
-      @NonNull MediaType contentType,
-      @Nullable Charset charset,
-      @NonNull SneakyThrows.Consumer<PrintWriter> consumer)
-      throws Exception {
-    try (PrintWriter writer = responseWriter(contentType, charset)) {
+    try (PrintWriter writer = responseWriter(contentType)) {
       consumer.accept(writer);
     }
     return this;

jooby/src/main/java/io/jooby/ForwardingContext.java

@@ -1097,12 +1097,6 @@ public Context setResponseType(@NonNull MediaType contentType) {
     return this;
   }
 
-  @Override
-  public Context setResponseType(@NonNull MediaType contentType, @Nullable Charset charset) {
-    ctx.setResponseType(contentType, charset);
-    return this;
-  }
-
   @Override
   public Context setDefaultResponseType(@NonNull MediaType contentType) {
     ctx.setResponseType(contentType);
@@ -1175,11 +1169,6 @@ public PrintWriter responseWriter(@NonNull MediaType contentType) {
     return ctx.responseWriter(contentType);
   }
 
-  @Override
-  public PrintWriter responseWriter(@NonNull MediaType contentType, @Nullable Charset charset) {
-    return ctx.responseWriter(contentType, charset);
-  }
-
   @Override
   public Context responseWriter(@NonNull SneakyThrows.Consumer<PrintWriter> consumer)
       throws Exception {
@@ -1193,15 +1182,6 @@ public Context responseWriter(
     return ctx.responseWriter(contentType, consumer);
   }
 
-  @Override
-  public Context responseWriter(
-      @NonNull MediaType contentType,
-      @Nullable Charset charset,
-      @NonNull SneakyThrows.Consumer<PrintWriter> consumer)
-      throws Exception {
-    return ctx.responseWriter(contentType, charset, consumer);
-  }
-
   @Override
   public Context sendRedirect(@NonNull String location) {
     ctx.sendRedirect(location);

jooby/src/main/java/io/jooby/MediaType.java

@@ -13,7 +13,6 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
-import java.util.function.BinaryOperator;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
@@ -25,14 +24,6 @@
  */
 public final class MediaType implements Comparable<MediaType> {
 
-  /** Computes and returns the most specific media type of both. */
-  public static final BinaryOperator<MediaType> MOST_SPECIFIC =
-      (a, b) -> {
-        int aScore = a.getScore();
-        int bScore = b.getScore();
-        return aScore >= bScore ? a : b;
-      };
-
   /** APPLICATION_JSON. */
   public static final String JSON = "application/json";
 
@@ -72,8 +63,12 @@ public final class MediaType implements Comparable<MediaType> {
   /** ALL. */
   public static final String ALL = "*/*";
 
-  /** APPLICATION_JSON. */
-  public static final MediaType json = new MediaType(JSON, UTF_8);
+  /**
+   * APPLICATION_JSON. The application/json content type, as defined by RFC 8259, does not require a
+   * charset parameter. This is because JSON text is typically expected to be encoded in UTF-8, and
+   * the specification does not define other encodings or a charset parameter for this media type.
+   */
+  public static final MediaType json = new MediaType(JSON, null);
 
   /** YAML. */
   public static final MediaType yaml = new MediaType(YAML, UTF_8);
@@ -115,6 +110,8 @@ public final class MediaType implements Comparable<MediaType> {
 
   private final String value;
 
+  private final String contentTypeHeader;
+
   private MediaType(@NonNull String value, Charset charset) {
     this.raw = value;
     this.subtypeStart = value.indexOf('/');
@@ -130,6 +127,7 @@ private MediaType(@NonNull String value, Charset charset) {
       this.subtypeEnd = subtypeEnd;
     }
     this.charset = charset;
+    this.contentTypeHeader = this.charset == null ? value : value + ";charset=" + charset.name();
   }
 
   @Override
@@ -187,18 +185,10 @@ public int hashCode() {
   /**
    * Render a content type header and add the charset parameter (when present).
    *
-   * @param charset Charset.
    * @return Content type header.
    */
-  public @NonNull String toContentTypeHeader(@Nullable Charset charset) {
-    if (charset == null) {
-      Charset paramCharset = getCharset();
-      if (paramCharset == null) {
-        return value;
-      }
-      charset = paramCharset;
-    }
-    return value + ";charset=" + charset.name();
+  public @NonNull String toContentTypeHeader() {
+    return contentTypeHeader;
   }
 
   /**

jooby/src/main/java/io/jooby/internal/ReadOnlyContext.java

@@ -17,7 +17,6 @@
 import java.util.Date;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
 import io.jooby.Context;
 import io.jooby.Cookie;
 import io.jooby.FileDownload;
@@ -140,15 +139,6 @@ public Context responseWriter(@NonNull SneakyThrows.Consumer<PrintWriter> consum
     throw new IllegalStateException(MESSAGE);
   }
 
-  @NonNull @Override
-  public Context responseWriter(
-      @NonNull MediaType contentType,
-      @Nullable Charset charset,
-      @NonNull SneakyThrows.Consumer<PrintWriter> consumer)
-      throws Exception {
-    throw new IllegalStateException(MESSAGE);
-  }
-
   @NonNull @Override
   public OutputStream responseStream() {
     throw new IllegalStateException(MESSAGE);
@@ -169,11 +159,6 @@ public PrintWriter responseWriter(@NonNull MediaType contentType) {
     throw new IllegalStateException(MESSAGE);
   }
 
-  @NonNull @Override
-  public PrintWriter responseWriter(@NonNull MediaType contentType, @Nullable Charset charset) {
-    throw new IllegalStateException(MESSAGE);
-  }
-
   @NonNull @Override
   public Sender responseSender() {
     throw new IllegalStateException(MESSAGE);
@@ -234,11 +219,6 @@ public Context setResponseType(@NonNull MediaType contentType) {
     throw new IllegalStateException(MESSAGE);
   }
 
-  @NonNull @Override
-  public Context setResponseType(@NonNull MediaType contentType, @Nullable Charset charset) {
-    throw new IllegalStateException(MESSAGE);
-  }
-
   @NonNull @Override
   public Context setDefaultResponseType(@NonNull MediaType contentType) {
     throw new IllegalStateException(MESSAGE);

jooby/src/main/java/io/jooby/internal/WebSocketSender.java

@@ -11,7 +11,6 @@
 import java.util.Date;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
-import edu.umd.cs.findbugs.annotations.Nullable;
 import io.jooby.Context;
 import io.jooby.Cookie;
 import io.jooby.DefaultContext;
@@ -150,12 +149,6 @@ public Context setResponseType(@NonNull String contentType) {
     return this;
   }
 
-  @NonNull @Override
-  public Context setResponseType(@NonNull MediaType contentType, @Nullable Charset charset) {
-    // NOOP
-    return this;
-  }
-
   @NonNull @Override
   public Context setResponseType(@NonNull MediaType contentType) {
     // NOOP