org.jooby.json

Class Jackson

java.lang.Object

org.jooby.json.Jackson

All Implemented Interfaces:

Jooby.Module

public class Jackson
extends Object
implements Jooby.Module

jackson

JSON support from the excellent Jackson library. This module provides a JSON Parser and Renderer, but also an ObjectMapper.

usage

 {
   use(new Jackson());

   // sending
   get("/my-api", req  -> new MyObject());

   // receiving a json body
   post("/my-api", req  -> {
     MyObject obj = req.body(MyObject.class);
     return obj;
   });

   // receiving a json param from a multipart or form url encoded
   post("/my-api", req  -> {
     MyObject obj = req.param("my-object").to(MyObject.class);
     return obj;
   });
 }
 

views

Dynamic views are supported via JacksonView:

 {
   use(new Jackson());

   get("/public", req -> {
     Item item = ...;
     return new JacksonView<>(Views.Public.class, item);
   });

   get("/public", req -> {
     Item item = ...;
     return new JacksonView<>(Views.Internal.class, item);
   });
 }
 

advanced configuration

If you need a special setting or configuration for your ObjectMapper:

 {
   use(new Jackson().configure(mapper  -> {
     // setup your custom object mapper
   });
 }
 

or provide an ObjectMapper instance:

 {
   ObjectMapper mapper = ....;
   use(new Jackson(mapper));
 }
 

It is possible to wire Jackson modules too:

 {

   use(new Jackson()
      .module(MyJacksonModuleWiredByGuice.class)
   );
 }
 

This is useful when your jackson module require some dependencies.

Since:

0.6.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Jackson() Creates a new Jackson module.
Jackson(com.fasterxml.jackson.databind.ObjectMapper mapper) Creates a new Jackson module and use the provided ObjectMapper instance.

Method Summary

Modifier and Type	Method and Description
void	configure(Env env, com.typesafe.config.Config config, com.google.inject.Binder binder)
Jackson	doWith(Consumer<com.fasterxml.jackson.databind.ObjectMapper> configurer) Apply advanced configuration over the provided ObjectMapper.
Jackson	module(Class<? extends com.fasterxml.jackson.databind.Module> module) Register the provided Module.
Jackson	module(com.fasterxml.jackson.databind.Module module) Register the provided module.
Jackson	raw() Add support raw string json responses:
Jackson	type(MediaType type) Set the json type supported by this module, default is: application/json.
Jackson	type(String type) Set the json type supported by this module, default is: application/json.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooby.Jooby.Module

config

Constructor Detail

Jackson

public Jackson(com.fasterxml.jackson.databind.ObjectMapper mapper)

Creates a new Jackson module and use the provided ObjectMapper instance.

Parameters:

mapper - ObjectMapper to apply.

Jackson

public Jackson()

Creates a new Jackson module.

Method Detail

type

public Jackson type(MediaType type)

Set the json type supported by this module, default is: application/json.

Parameters:

type - Media type.

Returns:

This module.

type

public Jackson type(String type)

Set the json type supported by this module, default is: application/json.

Parameters:

type - Media type.

Returns:

This module.

doWith

public Jackson doWith(Consumer<com.fasterxml.jackson.databind.ObjectMapper> configurer)

Apply advanced configuration over the provided ObjectMapper.

Parameters:

configurer - A configurer callback.

Returns:

This module.

module

public Jackson module(com.fasterxml.jackson.databind.Module module)

Register the provided module.

Parameters:

module - A module instance.

Returns:

This module.

module

public Jackson module(Class<? extends com.fasterxml.jackson.databind.Module> module)

Register the provided Module. The module will be instantiated by Guice.

Parameters:

module - Module type.

Returns:

This module.

raw

public Jackson raw()

Add support raw string json responses:

 {
   get("/raw", () -> {
     return "{\"raw\": \"json\"}";
   });
 }
 

Returns:

This module.

configure

public void configure(Env env,
                      com.typesafe.config.Config config,
                      com.google.inject.Binder binder)

Specified by:

configure in interface Jooby.Module