org.coliper.ibean.extension

Class Jackson2ModuleForIBeans

java.lang.Object

com.fasterxml.jackson.databind.Module

org.coliper.ibean.extension.Jackson2ModuleForIBeans

All Implemented Interfaces:

Versioned

public class Jackson2ModuleForIBeans
extends Module

Jackson2 configuration Module for IBean support. Needs to be configured in a Jackson2 ObjectMappers to enable JSON serialization and deserialization of IBeans. Three prerequisites need to be fulfilled so that an IBean can be converted to and from JSON with Jackson2:

• Jackson2 version 2.6 or higher must be found on the classpath.
• IBean must implement extension interface Jackson2Support.
• ObjectMapper used for convertion needs to have Jackson2ModuleForIBeans added to its configuration.

Following code snippets show an example usage:

 
     IBeanFactory factory = ...;
     // Interface BeanType needs to extend Jackson2Support
     BeanType someBean = factory.create(BeanType.class);
     ...
     
     // Configure Jackson ObjectMapper
     ObjectMapper mapper = new ObjectMapper();
     mapper.registerModule(new Jackson2ModuleForIBeans(factory));
     
     // Serialize to JSON and back
     String json = mapper.writeValueAsString(someBean);
     BeanType deserializedBean = mapper.readValue(json, BeanType.class);
 
 

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.Module

Module.SetupContext

Constructor Summary

Constructors

Constructor and Description
Jackson2ModuleForIBeans() Creates a Jackson2ModuleForIBeans without having a IBeanFactory provided.
Jackson2ModuleForIBeans(IBeanFactory iBeanFactory) Creates a Jackson2ModuleForIBeans for a given IBeanFactory.

Method Summary

Modifier and Type	Method and Description
String	getModuleName() Returns "Jackson2ModuleForIBeans" as name of the Jackson2 Module.
void	setupModule(Module.SetupContext context) Registers a deserializer factory (Deserializers) that supports any Jackson2Support sub-interface.
Version	version() Returns Version.unknownVersion().

Methods inherited from class com.fasterxml.jackson.databind.Module

getTypeId

Methods inherited from class java.lang.Object

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

Constructor Detail

Jackson2ModuleForIBeans

public Jackson2ModuleForIBeans()

Creates a Jackson2ModuleForIBeans without having a IBeanFactory provided. In this case the deserializer will use default factory in IBean when creating new IBeans.

Jackson2ModuleForIBeans

public Jackson2ModuleForIBeans(IBeanFactory iBeanFactory)

Creates a Jackson2ModuleForIBeans for a given IBeanFactory. In this case the JSON deserializer will use the provides factory in IBean when creating new IBeans.

Parameters:

iBeanFactory - the factory used by the deserializer; if null the deserializer will use the default factory in IBean for IBean creation.

Method Detail

getModuleName

public String getModuleName()

Returns "Jackson2ModuleForIBeans" as name of the Jackson2 Module.

Specified by:

getModuleName in class Module

See Also:

Module.getModuleName()

version

public Version version()

Returns Version.unknownVersion().

Specified by:

version in interface Versioned

Specified by:

version in class Module

See Also:

Module.version()

setupModule

public void setupModule(Module.SetupContext context)

Registers a deserializer factory (Deserializers) that supports any Jackson2Support sub-interface.

Specified by:

setupModule in class Module

See Also:

Module.setupModule(SetupContext)