org.springframework.http.converter.json

Class GsonHttpMessageConverterForSpring3

java.lang.Object

org.springframework.http.converter.AbstractHttpMessageConverter<Object>

org.springframework.http.converter.json.GsonHttpMessageConverterForSpring3

All Implemented Interfaces:

org.springframework.http.converter.HttpMessageConverter<Object>

public class GsonHttpMessageConverterForSpring3
extends org.springframework.http.converter.AbstractHttpMessageConverter<Object>

CHRISTIAN KLOCK, 2014.09.16 Class is left as obtained from http://grepcode.com/file_/repo1.maven.org/maven2/org.springframework.android/spring-android-rest-template/1.0.1.RELEASE/org/springframework/http/converter/json/GsonHttpMessageConverter.java/?v=source ERKO HANSAR, 2015.04.29 Renamed the file from GsonHttpMessageConverter to GsonHttpMessageConverterForSpring3 to avoid name clashing with Spring 4, which now includes a GsonHttpMessageConverter. TODO: When TWE upgrades to Spring 4, start using the Spring included version.

Since:

1.0

Author:

Roy Clarkson

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_CHARSET

Fields inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

logger

Constructor Summary

Constructors

Constructor and Description
GsonHttpMessageConverterForSpring3() Construct a new GsonHttpMessageConverter with a default Gson.
GsonHttpMessageConverterForSpring3(boolean serializeNulls) Construct a new GsonHttpMessageConverter.
GsonHttpMessageConverterForSpring3(com.google.gson.Gson gson) Construct a new GsonHttpMessageConverter.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRead(Class<?> clazz, org.springframework.http.MediaType mediaType)
boolean	canWrite(Class<?> clazz, org.springframework.http.MediaType mediaType)
Type	getType()
protected Object	readInternal(Class<?> clazz, org.springframework.http.HttpInputMessage inputMessage)
void	setGson(com.google.gson.Gson gson) Sets the Gson for this view.
void	setPrefixJson(boolean prefixJson) Indicates whether the JSON output by this view should be prefixed with "{} &&".
void	setType(Type type)
protected boolean	supports(Class<?> clazz)
protected void	writeInternal(Object o, org.springframework.http.HttpOutputMessage outputMessage)

Methods inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

canRead, canWrite, getContentLength, getDefaultContentType, getSupportedMediaTypes, read, setSupportedMediaTypes, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

Constructor Detail

GsonHttpMessageConverterForSpring3

public GsonHttpMessageConverterForSpring3()

Construct a new GsonHttpMessageConverter with a default Gson.

GsonHttpMessageConverterForSpring3

public GsonHttpMessageConverterForSpring3(boolean serializeNulls)

Construct a new GsonHttpMessageConverter.

Parameters:

serializeNulls - true to generate json for null values

GsonHttpMessageConverterForSpring3

public GsonHttpMessageConverterForSpring3(com.google.gson.Gson gson)

Construct a new GsonHttpMessageConverter.

Parameters:

gson - a customized Gson

Method Detail

setGson

public void setGson(com.google.gson.Gson gson)

Sets the Gson for this view. If not set, a default Gson is used.

Setting a custom-configured Gson is one way to take further control of the JSON serialization process.

Throws:

IllegalArgumentException - if gson is null

setType

public void setType(Type type)

getType

public Type getType()

setPrefixJson

public void setPrefixJson(boolean prefixJson)

Indicates whether the JSON output by this view should be prefixed with "{} &&". Default is false.

Prefixing the JSON string in this manner is used to help prevent JSON Hijacking. The prefix renders the string syntactically invalid as a script so that it cannot be hijacked. This prefix does not affect the evaluation of JSON, but if JSON validation is performed on the string, the prefix would need to be ignored.

canRead

public boolean canRead(Class<?> clazz,
              org.springframework.http.MediaType mediaType)

Specified by:

canRead in interface org.springframework.http.converter.HttpMessageConverter<Object>

Overrides:

canRead in class org.springframework.http.converter.AbstractHttpMessageConverter<Object>

canWrite

public boolean canWrite(Class<?> clazz,
               org.springframework.http.MediaType mediaType)

Specified by:

canWrite in interface org.springframework.http.converter.HttpMessageConverter<Object>

Overrides:

canWrite in class org.springframework.http.converter.AbstractHttpMessageConverter<Object>

supports

protected boolean supports(Class<?> clazz)

Specified by:

supports in class org.springframework.http.converter.AbstractHttpMessageConverter<Object>

readInternal

protected Object readInternal(Class<?> clazz,
                  org.springframework.http.HttpInputMessage inputMessage)
                       throws IOException,
                              org.springframework.http.converter.HttpMessageNotReadableException

Specified by:

readInternal in class org.springframework.http.converter.AbstractHttpMessageConverter<Object>

Throws:

IOException

org.springframework.http.converter.HttpMessageNotReadableException

writeInternal

protected void writeInternal(Object o,
                 org.springframework.http.HttpOutputMessage outputMessage)
                      throws IOException,
                             org.springframework.http.converter.HttpMessageNotWritableException

Specified by:

writeInternal in class org.springframework.http.converter.AbstractHttpMessageConverter<Object>

Throws:

IOException

org.springframework.http.converter.HttpMessageNotWritableException