HttpStatusCodeException cannot be serialized [SPR-9273]

[spring-projects-issues]

Ronald Dauster opened SPR-9273 and commented

Being a Throwable, org.springframework.web.client.HttpStatusCodeException should be serializable.
However, it references a java.nio.charset.Charset, which is not java.io.Serializable, causing an NotSerializableException.

---

Affects: 3.1.1

Issue Links:

• HttpStatusCodeException not serializable [SPR-9370] #13976 HttpStatusCodeException not serializable ("is duplicated by")
• HttpStatusCodeException should contain response body [SPR-7591] #12247 HttpStatusCodeException should contain response body

Referenced from: commits 2ff4372

[spring-projects-issues]

Chris Beams commented

@Arjen, here is the commit that introduced the dependency on Charset:

70cb81b

@Ronald, could you explain your use case a bit? It would help us in evaluating this to understand why you're needing to serialize HttpStatusCodeException in the first place.

Thanks.

[spring-projects-issues]

Ronald Dauster commented

The obvious use case are all RPC frameworks that use serialization to marshal arguments, return values, and exceptions.
I encountered the problem using haszelcast's distributed executor service, but it should be no different with RMI.

[spring-projects-issues]

Chris Beams commented

Thanks, Ronald

commit 2ff43726be693f32b7bf2a6d237ab65f8ce84ba6
Author: Chris Beams <cbeams@vmware.com>
Date:   Mon May 14 14:47:11 2012 +0300

    Restore serializability of HttpStatusCodeException
    
    SPR-7591 introduced a java.nio.charset.Charset field within
    HttpStatusCodeException. The former is non-serializable, thus by
    extension the latter also became non-serializable.
    
    Because the Charset field is only used for outputting the charset name
    in HttpStatusCodeException#getResponseBodyAsString, it is reasonable to
    store the value returned by Charset#name() instead of the actual Charset
    object itself.
    
    This commit refactors HttpStatusCodeException's responseCharset field to
    be of type String instead of Charset and adds tests to prove that
    HttpStatusCodeException objects are once again serializable as expected.
    
    Issue: SPR-9273, SPR-7591