openconnector

Class JsonBuilder

java.lang.Object

openconnector.JsonBuilder

public class JsonBuilder
extends java.lang.Object

Utility class for rendering JSON.

There are other utilities for this but they seem over-engineered. This just gets a generic Map/List/String model through JSON. If you want to reflectively serialize arbitrary Java classes then use something else.

Dates are rendered as strings, but they do not parse back as dates. The "secrets" list was added to automatically obfuscate map keys that typically contain passwords. This is necessary since this is almost always used to serialize objects for debug logging, and seeing passwords in the log raises all sorts of alarms.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATE_FORMAT Date format we render.
static boolean	SortMapKeys A global flag controlling whether we sort map keys before rendering.

Constructor Summary

Constructors

Constructor and Description
JsonBuilder()

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String literal)
void	add(java.lang.String name, java.lang.Object value)
void	addSecret(java.lang.String s)
void	addSecrets(java.lang.String[] secrets)
void	end()
void	endArray()
boolean	isSecret(java.lang.String name)
static java.lang.String	render(java.lang.Object o) Public interface to rendering something as a JSON string.
void	reset()
void	start()
void	start(java.lang.String name)
void	startArray()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SortMapKeys

public static boolean SortMapKeys

A global flag controlling whether we sort map keys before rendering. This is normally false. It is intended for the unit tests that want to compare JSON renderings with previous renderings stored in files. Changes in JVMs can change the iteration order of map entries. In particular 1.5 Hashmap order appears to be random, but in 1.6 the keys come out sorted. By forcing them to render sorted we can use the same test files with different JVMs.

It probably would not hurt to leave this on all the time, we should not have many large maps?

DATE_FORMAT

public static final java.lang.String DATE_FORMAT

Date format we render. !! Need to think more about the canonical syntax.

See Also:

Constant Field Values

Constructor Detail

JsonBuilder

public JsonBuilder()

Method Detail

addSecret

public void addSecret(java.lang.String s)

addSecrets

public void addSecrets(java.lang.String[] secrets)

isSecret

public boolean isSecret(java.lang.String name)

reset

public void reset()

start

public void start()

end

public void end()

start

public void start(java.lang.String name)

startArray

public void startArray()

endArray

public void endArray()

add

public void add(java.lang.String name,
                java.lang.Object value)

add

public void add(java.lang.String literal)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

render

public static java.lang.String render(java.lang.Object o)

Public interface to rendering something as a JSON string. A null value returns a null String, not the JSON string "null".

For debugging it is important that we render as much as we can so this does not throw exceptions if it counters something it does not understand.

The static interface is convenient, but if you need to set options like the Secrets list, you have to construct one and use the interface methods above.