org.wisdom.content.jackson

Class JacksonSingleton

java.lang.Object

org.wisdom.content.jackson.JacksonSingleton

All Implemented Interfaces:

org.wisdom.api.content.JacksonModuleRepository, org.wisdom.api.content.Json, org.wisdom.api.content.Xml

public class JacksonSingleton
extends Object
implements org.wisdom.api.content.JacksonModuleRepository, org.wisdom.api.content.Json, org.wisdom.api.content.Xml

This component is a layer on top of Jackson and provides the Json and Xml services.

This class manages Jackson module dynamically, and recreates a JSON Mapper and XML mapper every time a module arrives or leaves.

Field Summary

Fields

Modifier and Type	Field and Description
private DocumentBuilderFactory	factory The document builder factory used to create new document.
private Object	lock An object used as lock.
private static org.slf4j.Logger	LOGGER The logger.
private com.fasterxml.jackson.databind.ObjectMapper	mapper The current object mapper.
private Set<com.fasterxml.jackson.databind.Module>	modules The current set of registered modules.
private com.fasterxml.jackson.dataformat.xml.XmlMapper	xml The current object mapper.

Constructor Summary

Constructors

Constructor and Description
JacksonSingleton()

Method Summary

Modifier and Type	Method and Description
Document	fromInputStream(InputStream stream, Charset encoding) Builds a new XML Document from the given input stream.
<A> A	fromJson(com.fasterxml.jackson.databind.JsonNode json, Class<A> clazz) Converts a JsonNode to a Java value.
<A> A	fromJson(String json, Class<A> clazz) Converts a Json String to a Java value.
Document	fromString(String xml) Builds a new XML Document from the given (xml) string.
<A> A	fromXML(Document document, Class<A> clazz) Builds a new instance of the given class clazz from the given XML document.
<A> A	fromXML(String xml, Class<A> clazz) Builds a new instance of the given class clazz from the given XML string.
void	invalidate() Stops the JSON and XML management.
com.fasterxml.jackson.databind.ObjectMapper	mapper() Gets the current mapper.
com.fasterxml.jackson.databind.node.ArrayNode	newArray() Creates a new JSON Array.
Document	newDocument() Creates a new document.
com.fasterxml.jackson.databind.node.ObjectNode	newObject() Creates a new JSON Object.
com.fasterxml.jackson.databind.JsonNode	parse(InputStream stream) Parses a stream representing a json, and return it as a JsonNode.
com.fasterxml.jackson.databind.JsonNode	parse(String src) Parses a String representing a json, and return it as a JsonNode.
private void	rebuildMappers()
void	register(com.fasterxml.jackson.databind.Module module) Registers a new Jackson Module.
private void	setMappers(com.fasterxml.jackson.databind.ObjectMapper mapper, com.fasterxml.jackson.dataformat.xml.XmlMapper xml) Sets the object mapper.
String	stringify(Document document) Retrieves the string form of the given XML document.
String	stringify(com.fasterxml.jackson.databind.JsonNode json) Converts a JsonNode to its string representation.
com.fasterxml.jackson.databind.JsonNode	toJson(Object data) Converts an object to JsonNode.
String	toJsonP(String callback, Object data) Gets the JSONP response for the given callback and value.
void	unregister(com.fasterxml.jackson.databind.Module module) Un-registers a JSON Module.
void	validate() Starts the JSON and XML support.
com.fasterxml.jackson.dataformat.xml.XmlMapper	xmlMapper() Gets the current XML mapper.

Methods inherited from class java.lang.Object

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

Field Detail

lock

private final Object lock

An object used as lock.

mapper

private com.fasterxml.jackson.databind.ObjectMapper mapper

The current object mapper.

xml

private com.fasterxml.jackson.dataformat.xml.XmlMapper xml

The current object mapper.

factory

private DocumentBuilderFactory factory

The document builder factory used to create new document.

LOGGER

private static final org.slf4j.Logger LOGGER

The logger.

modules

private Set<com.fasterxml.jackson.databind.Module> modules

The current set of registered modules.

Constructor Detail

JacksonSingleton

public JacksonSingleton()

Method Detail

mapper

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

Gets the current mapper.

Specified by:

mapper in interface org.wisdom.api.content.Json

Returns:

the mapper.

toJson

public com.fasterxml.jackson.databind.JsonNode toJson(Object data)

Converts an object to JsonNode.

Specified by:

toJson in interface org.wisdom.api.content.Json

Parameters:

data - Value to convert in Json.

Returns:

the resulting JSON Node

Throws:

RuntimeException - if the JSON Node cannot be created

toJsonP

public String toJsonP(String callback,
                      Object data)

Gets the JSONP response for the given callback and value.

Specified by:

toJsonP in interface org.wisdom.api.content.Json

Parameters:

callback - the callback name

data - the data to transform to json

Returns:

the String built as follows: "callback(json(data))"

fromJson

public <A> A fromJson(com.fasterxml.jackson.databind.JsonNode json,
                      Class<A> clazz)

Converts a JsonNode to a Java value.

Specified by:

fromJson in interface org.wisdom.api.content.Json

Parameters:

json - Json value to convert.

clazz - Expected Java value type.

Returns:

the created object

Throws:

RuntimeException - if the object cannot be created

fromJson

public <A> A fromJson(String json,
                      Class<A> clazz)

Converts a Json String to a Java value.

Specified by:

fromJson in interface org.wisdom.api.content.Json

Parameters:

json - Json string to convert.

clazz - Expected Java value type.

Returns:

the created object

Throws:

RuntimeException - if the object cannot be created

stringify

public String stringify(com.fasterxml.jackson.databind.JsonNode json)

Converts a JsonNode to its string representation. This implementation use a `pretty printer`.

Specified by:

stringify in interface org.wisdom.api.content.Json

Parameters:

json - the json node

Returns:

the String representation of the given Json Object

Throws:

RuntimeException - if the String form cannot be created

parse

public com.fasterxml.jackson.databind.JsonNode parse(String src)

Parses a String representing a json, and return it as a JsonNode.

Specified by:

parse in interface org.wisdom.api.content.Json

Parameters:

src - the JSON String

Returns:

the Json Node

Throws:

RuntimeException - if the given string is not a valid JSON String

parse

public com.fasterxml.jackson.databind.JsonNode parse(InputStream stream)

Parses a stream representing a json, and return it as a JsonNode. The stream is not closed by the method.

Specified by:

parse in interface org.wisdom.api.content.Json

Parameters:

stream - the JSON stream

Returns:

the JSON node

Throws:

RuntimeException - if the given stream is not a valid JSON String

newObject

public com.fasterxml.jackson.databind.node.ObjectNode newObject()

Creates a new JSON Object.

Specified by:

newObject in interface org.wisdom.api.content.Json

Returns:

the new Object Node.

newArray

public com.fasterxml.jackson.databind.node.ArrayNode newArray()

Creates a new JSON Array.

Specified by:

newArray in interface org.wisdom.api.content.Json

Returns:

the new Array Node.

validate

public void validate()

Starts the JSON and XML support. An empty mapper is created.

setMappers

private void setMappers(com.fasterxml.jackson.databind.ObjectMapper mapper,
                        com.fasterxml.jackson.dataformat.xml.XmlMapper xml)

Sets the object mapper.

Parameters:

mapper - the object mapper to use

invalidate

public void invalidate()

Stops the JSON and XML management. Releases the current mappers.

register

public void register(com.fasterxml.jackson.databind.Module module)

Registers a new Jackson Module.

Specified by:

register in interface org.wisdom.api.content.JacksonModuleRepository

Parameters:

module - the module to register

rebuildMappers

private void rebuildMappers()

unregister

public void unregister(com.fasterxml.jackson.databind.Module module)

Un-registers a JSON Module.

Specified by:

unregister in interface org.wisdom.api.content.JacksonModuleRepository

Parameters:

module - the module

xmlMapper

public com.fasterxml.jackson.dataformat.xml.XmlMapper xmlMapper()

Gets the current XML mapper.

Specified by:

xmlMapper in interface org.wisdom.api.content.Xml

Returns:

the mapper

fromString

public Document fromString(String xml)
                    throws IOException

Builds a new XML Document from the given (xml) string. By default this method uses UTF-8. If your document does not use UTF-8, use fromInputStream(java.io.InputStream, java.nio.charset.Charset) that let you set the encoding.

Specified by:

fromString in interface org.wisdom.api.content.Xml

Parameters:

xml - the xml to parse, must not be null

Returns:

the document

Throws:

IOException - if the given string is not a valid XML document

fromInputStream

public Document fromInputStream(InputStream stream,
                                Charset encoding)
                         throws IOException

Builds a new XML Document from the given input stream. The stream is not closed by this method, and so you must close it.

Specified by:

fromInputStream in interface org.wisdom.api.content.Xml

Parameters:

stream - the input stream, must not be null

encoding - the encoding, if null, UTF-8 is used.

Returns:

the built document

Throws:

IOException - if the given stream is not a valid XML document, or if the given encoding is not supported.

fromXML

public <A> A fromXML(Document document,
                     Class<A> clazz)

Builds a new instance of the given class clazz from the given XML document.

Specified by:

fromXML in interface org.wisdom.api.content.Xml

Parameters:

document - the XML document

clazz - the class of the instance to construct

Returns:

an instance of the class.

fromXML

public <A> A fromXML(String xml,
                     Class<A> clazz)

Builds a new instance of the given class clazz from the given XML string.

Specified by:

fromXML in interface org.wisdom.api.content.Xml

Parameters:

xml - the XML string

clazz - the class of the instance to construct

Returns:

an instance of the class.

stringify

public String stringify(Document document)

Retrieves the string form of the given XML document.

Specified by:

stringify in interface org.wisdom.api.content.Xml

Parameters:

document - the XML document, must not be null

Returns:

the String form of the object

newDocument

public Document newDocument()

Creates a new document.

Specified by:

newDocument in interface org.wisdom.api.content.Xml

Returns:

the document