org.molgenis.util

Class GsonHttpMessageConverter

java.lang.Object

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

org.molgenis.util.BaseHttpMessageConverter<Object>

org.molgenis.util.GsonHttpMessageConverter

All Implemented Interfaces:

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

public class GsonHttpMessageConverter
extends BaseHttpMessageConverter<Object>

Converts objects to json string and vica versa If logging is set to debug it will print the incoming and outgoing json strings

Since:

1.0

Author:

Roy Clarkson

Field Summary

Fields inherited from class org.molgenis.util.BaseHttpMessageConverter

DEFAULT_CHARSET

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

logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	canRead(Class<?> clazz, org.springframework.http.MediaType mediaType)
boolean	canWrite(Class<?> clazz, org.springframework.http.MediaType mediaType)
com.google.gson.Gson	getGson()
Type	getType()
protected Object	readInternal(Class<?> clazz, org.springframework.http.HttpInputMessage inputMessage)
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.molgenis.util.BaseHttpMessageConverter

getCharset

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

Constructor Detail

GsonHttpMessageConverter

public GsonHttpMessageConverter()

Construct a new GsonHttpMessageConverter with a default Gson.

GsonHttpMessageConverter

public GsonHttpMessageConverter(boolean prettyPrinting)

Construct a new GsonHttpMessageConverter with a default Gson.

GsonHttpMessageConverter

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

Construct a new GsonHttpMessageConverter.

Parameters:

gson - a customized Gson

Method Detail

setType

public void setType(Type type)

getType

public Type getType()

getGson

public com.google.gson.Gson getGson()

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