Fixed #689 (remove "request payload" functionality)

Author: cowtowncoder

release-notes/VERSION

@@ -35,6 +35,7 @@ JSON library.
   (replaced by `StreamWriteCapability` equivalents)
 #680: Allow use of `java.nio.file.Path` as parser source, generator target
  (contributed by Sven D)
+#689: Remove existing "request payload" functionality
 - Rename `JsonGenerator.Feature.AUTO_CLOSE_JSON_CONTENT` as `AUTO_CLOSE_CONTENT`
 - Add `TreeCodec.nullNode()`, `TreeNode.isNull()` methods
 - Change the way `JsonLocation.NA` is included in exception messages

src/main/java/com/fasterxml/jackson/core/JsonParser.java

@@ -8,7 +8,6 @@
 import java.io.*;
 import java.math.BigDecimal;
 import java.math.BigInteger;
-import java.nio.charset.Charset;
 
 import com.fasterxml.jackson.core.async.NonBlockingInputFeeder;
 import com.fasterxml.jackson.core.exc.InputCoercionException;
@@ -19,7 +18,6 @@
 import com.fasterxml.jackson.core.type.ResolvedType;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.core.util.JacksonFeatureSet;
-import com.fasterxml.jackson.core.util.RequestPayload;
 
 /**
  * Base class that defines public API for reading JSON content.
@@ -46,17 +44,6 @@ public enum NumberType {
     protected final static JacksonFeatureSet<StreamReadCapability> DEFAULT_READ_CAPABILITIES
         = JacksonFeatureSet.fromDefaults(StreamReadCapability.values());
 
-    /*
-    /**********************************************************************
-    /* Minimal configuration state
-    /**********************************************************************
-     */
-
-    /**
-     * Optional container that holds the request payload which will be displayed on JSON parsing error.
-     */
-    protected transient RequestPayload _requestPayload;
-
     /*
     /**********************************************************************
     /* Life-cycle
@@ -203,40 +190,6 @@ protected JsonParser() { }
      */
     public abstract void assignCurrentValue(Object v);
 
-    /*
-    /**********************************************************************
-    /* Attaching additional metadata: request payload
-    /**********************************************************************
-     */
-
-    /**
-     * Sets the payload to be passed if {@link StreamReadException} is thrown.
-     *
-     * @param payload to assign
-     */
-    public void setRequestPayloadOnError(RequestPayload payload) {
-        _requestPayload = payload;
-    }
-
-    /**
-     * Sets the {@code byte[]} request payload and the charset needed to decode it
-     *
-     * @param payload Payload to pass
-     * @param charset Character encoding for (lazily) decoding payload
-     */
-    public void setRequestPayloadOnError(byte[] payload, Charset charset) {
-        _requestPayload = (payload == null) ? null : new RequestPayload(payload, charset);
-    }
-
-    /**
-     * Sets the String request payload
-     *
-     * @param payload to assign
-     */
-    public void setRequestPayloadOnError(String payload) {
-        _requestPayload = (payload == null) ? null : new RequestPayload(payload);
-    }
-
     /*
     /**********************************************************************
     /* Optional support for non-blocking parsing
@@ -1661,8 +1614,7 @@ protected void _reportUnsupportedOperation() {
      * @return {@link StreamReadException} constructed
      */
     protected StreamReadException _constructReadException(String msg) {
-        return new StreamReadException(this, msg)
-            .withRequestPayload(_requestPayload);
+        return new StreamReadException(this, msg);
     }
 
     protected StreamReadException _constructReadException(String msg, Object arg) {
@@ -1674,7 +1626,6 @@ protected StreamReadException _constructReadException(String msg, Object arg1, O
     }
 
     protected final StreamReadException _constructReadException(String msg, Throwable t) {
-        return new StreamReadException(this, msg, t)
-                .withRequestPayload(_requestPayload);
+        return new StreamReadException(this, msg, t);
     }
 }

src/main/java/com/fasterxml/jackson/core/base/ParserMinimalBase.java

@@ -980,10 +980,9 @@ protected InputCoercionException _constructNotNumericType(JsonToken actualToken,
     }
 
     protected InputCoercionException _constructInputCoercion(String msg, JsonToken inputType, Class<?> targetType) {
-        return new InputCoercionException(this, msg, inputType, targetType)
-            .withRequestPayload(_requestPayload);
+        return new InputCoercionException(this, msg, inputType, targetType);
     }
-    
+
     /*
     /**********************************************************************
     /* Error reporting, generic

src/main/java/com/fasterxml/jackson/core/exc/InputCoercionException.java

@@ -1,7 +1,6 @@
 package com.fasterxml.jackson.core.exc;
 
 import com.fasterxml.jackson.core.*;
-import com.fasterxml.jackson.core.util.RequestPayload;
 
 /**
  * Exception type for read-side problems that are not direct decoding ("parsing")
@@ -54,12 +53,6 @@ public InputCoercionException withParser(JsonParser p) {
         return this;
     }
 
-    @Override
-    public InputCoercionException withRequestPayload(RequestPayload p) {
-        _requestPayload = p;
-        return this;
-    }
-
     /**
      * Accessor for getting information about input type (in form of token, giving "shape"
      * of input) for which coercion failed.

src/main/java/com/fasterxml/jackson/core/exc/StreamReadException.java

@@ -1,7 +1,6 @@
 package com.fasterxml.jackson.core.exc;
 
 import com.fasterxml.jackson.core.*;
-import com.fasterxml.jackson.core.util.RequestPayload;
 
 /**
  * Intermediate base class for all read-side streaming processing problems, including
@@ -14,14 +13,6 @@ public class StreamReadException
 
     protected transient JsonParser _processor;
 
-    /**
-     * Optional payload that can be assigned to pass along for error reporting
-     * or handling purposes. Core streaming parser implementations DO NOT
-     * initialize this; it is up to using applications and frameworks to
-     * populate it.
-     */
-    protected RequestPayload _requestPayload;
-
     public StreamReadException(JsonParser p, String msg) {
         super(msg, (p == null) ? null : p.currentLocation(), null);
         _processor = p;
@@ -60,55 +51,8 @@ public StreamReadException withParser(JsonParser p) {
         return this;
     }
 
-    /**
-     * Fluent method that may be used to assign payload to this exception,
-     * to let recipient access it for diagnostics purposes.
-     *<p>
-     * NOTE: `this` instance is modified and no new instance is constructed.
-     *
-     * @param payload Payload to assign to this exception
-     *
-     * @return This exception instance to allow call chaining
-     */
-    public StreamReadException withRequestPayload(RequestPayload payload) {
-        _requestPayload = payload;
-        return this;
-    }
-
     @Override
     public JsonParser processor() {
         return _processor;
     }
-
-    /**
-     * Method that may be called to find payload that was being parsed, if
-     * one was specified for parser that threw this Exception.
-     *
-     * @return request body, if payload was specified; `null` otherwise
-     */
-    public RequestPayload getRequestPayload() {
-        return _requestPayload;
-    }
-
-    /**
-     * The method returns the String representation of the request payload if
-     * one was specified for parser that threw this Exception.
-     * 
-     * @return request body as String, if payload was specified; `null` otherwise
-     */
-    public String getRequestPayloadAsString() {
-        return (_requestPayload != null) ? _requestPayload.toString() : null;
-    }
-
-    /**
-     * Overriding the getMessage() to include the request body
-     */
-    @Override 
-    public String getMessage() {
-        String msg = super.getMessage();
-        if (_requestPayload != null) {
-            msg += "\nRequest payload: " + _requestPayload.toString();
-        }
-        return msg;
-    }
 }

src/main/java/com/fasterxml/jackson/core/sym/ByteQuadsCanonicalizer.java

@@ -3,7 +3,6 @@
 import java.util.Arrays;
 import java.util.concurrent.atomic.AtomicReference;
 
-import com.fasterxml.jackson.core.JacksonException;
 import com.fasterxml.jackson.core.exc.StreamReadException;
 import com.fasterxml.jackson.core.json.JsonFactory;
 import com.fasterxml.jackson.core.util.InternCache;