ratpack.jackson

Class Jackson

java.lang.Object

ratpack.jackson.Jackson

public abstract class Jackson
extends java.lang.Object

Provides key integration points with the Jackson support for dealing with JSON.

The JacksonModule Guice module provides the infrastructure necessary to use these functions.

Rendering as JSON

The methods that return a JsonRender are to be used with the Context.render(Object) method for serializing objects to the response as JSON.

 import ratpack.handling.Handler;
 import ratpack.handling.Context;

 import static ratpack.jackson.Jackson.json;

 public class MyHandler implements Handler {
   public void handle(Context context) {
     Person person = new Person("John");
     context.render(json(person));
   }
 }

 public class Person {
   private final String name;
   public Person(String name) {
     this.name = name;
   }
 }
 

Parsing JSON requests

The methods that return a JsonParseOpts are to be used with the Context.parse(ratpack.parse.Parse) method for deserializing request bodies containing JSON.

 import ratpack.handling.Handler;
 import ratpack.handling.Context;
 import com.fasterxml.jackson.databind.JsonNode;

 import static ratpack.jackson.Jackson.jsonNode;

 public class MyHandler implements Handler {
   public void handle(Context context) {
     JsonNode node = context.parse(jsonNode())
     context.render(node.get("someKey"));
   }
 }
 

Constructor Summary

Constructors

Constructor and Description
Jackson()

Method Summary

Modifier and Type	Method and Description
static <T> ratpack.parse.Parse<T,JsonParseOpts>	fromJson(java.lang.Class<T> type)
static <T> ratpack.parse.Parse<T,JsonParseOpts>	fromJson(java.lang.Class<T> type, ObjectMapper objectMapper)
static <T> ratpack.parse.Parse<T,JsonParseOpts>	fromJson(com.google.common.reflect.TypeToken<T> type)
static <T> ratpack.parse.Parse<T,JsonParseOpts>	fromJson(com.google.common.reflect.TypeToken<T> type, ObjectMapper objectMapper)
static JsonRender	json(java.lang.Object object) Jackson rendering of the given object, using the default object writer.
static JsonRender	json(java.lang.Object object, ObjectWriter objectWriter) Jackson rendering of the given object, using the given object writer.
static ratpack.parse.Parse<JsonNode,JsonParseOpts>	jsonNode()
static ratpack.parse.Parse<JsonNode,JsonParseOpts>	jsonNode(ObjectMapper objectMapper)

Methods inherited from class java.lang.Object

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

Constructor Detail

Jackson

public Jackson()

Method Detail

json

public static JsonRender json(java.lang.Object object)

Jackson rendering of the given object, using the default object writer.

Parameters:

object - The object to render as JSON.

Returns:

A JSON type wrapper for the given object.

json

public static JsonRender json(java.lang.Object object,
                              @Nullable
                              ObjectWriter objectWriter)

Jackson rendering of the given object, using the given object writer.

Parameters:

object - The object to render as JSON.

objectWriter - The writer to use to render the object as JSON. If null, the default object writer will be used by the renderer.

Returns:

A JSON type wrapper for the given object.

jsonNode

public static ratpack.parse.Parse<JsonNode,JsonParseOpts> jsonNode()

jsonNode

public static ratpack.parse.Parse<JsonNode,JsonParseOpts> jsonNode(@Nullable
                                                                   ObjectMapper objectMapper)

fromJson

public static <T> ratpack.parse.Parse<T,JsonParseOpts> fromJson(java.lang.Class<T> type)

fromJson

public static <T> ratpack.parse.Parse<T,JsonParseOpts> fromJson(com.google.common.reflect.TypeToken<T> type)

fromJson

public static <T> ratpack.parse.Parse<T,JsonParseOpts> fromJson(java.lang.Class<T> type,
                                                                @Nullable
                                                                ObjectMapper objectMapper)

fromJson

public static <T> ratpack.parse.Parse<T,JsonParseOpts> fromJson(com.google.common.reflect.TypeToken<T> type,
                                                                @Nullable
                                                                ObjectMapper objectMapper)