com.boomi.util.json

Class JSONUtil

java.lang.Object

com.boomi.util.json.JSONUtil

public class JSONUtil
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JSONUtil.NodeType JSON Node types as defined in http://tools.ietf.org/html/draft-zyp-json-schema-04#section-3.5
static class	JSONUtil.SchemaVersion Supported JSON Schema Versions

Field Summary

Fields

Modifier and Type	Field and Description
static String	$REF
static String	$SCHEMA
static String	FULL_DOCUMENT_JSON_POINTER
static com.boomi.util.StreamUtil.Parser<JsonNode>	JSON_PARSER A StreamUtil.Parser implementation which parses a given InputStream into a JsonNode by calling StreamUtil.Parser
static String	POINTER_PATH_DELIMITER
static char	POINTER_PATH_DELIMITER_CHAR
static String	SCHEMA_ID
static String	SCHEMA_PROPERTIES
static String	SCHEMA_TITLE
static String	SCHEMA_TYPE

Method Summary

Modifier and Type	Method and Description
static boolean	asBoolean(JsonNode node, String fieldName) Util method to safely get the specified field as a boolean.
static String	asText(JsonNode node, String fieldName) Util method to safely get the content of the specified field using JsonNode.asText().
static JsonNode	buildSchema(Buildable buildable) Build a JSON schema based on the provided Buildable.
static PrettyPrinter	createPrettyPrinter() Creates and returns a JSON pretty printer which always uses windows newlines (the boomi "standard").
static String	decodeSlashesAndtildas(String name)
static String	encodeSlashesAndTildas(String name)
static Iterable<Map.Entry<String,JsonNode>>	fieldsIterable(JsonNode jsonNode) Creates an Iterable of the node fields.
static JsonPointer	formatPointer(String pattern, String... arguments) Creates a JsonPointer for the supplied pattern.
static JsonFactory	getDefaultJsonFactory() Obtain the global JsonFactory instance.
static ObjectMapper	getDefaultObjectMapper() Obtain the global ObjectMapper instance.
static boolean	hasNonNull(JsonNode node, String fieldName) Util method to safely determine if the specified field exists with a non-null value.
static JsonNode	loadSchemaFromResource(String resourceName) Utility method to load a JSON schema from a resource.
static ObjectNode	newEmptySchema(JSONUtil.SchemaVersion schemaVersion) Instantiates a new object node to be used as a schema.
static JsonParser	newInitializedParser(InputStream inputStream) Creates a new JsonParser for the input stream and advances parser to the first value token.
static ObjectDefinition	newJsonDefinition(ObjectDefinitionRole role, JsonNode schema) Factory method to create a new ObjectDefinition instance with JSON defaults.
static ObjectDefinition	newJsonDefinitionFromResource(ObjectDefinitionRole role, String resourceName) Factory method to load a schema resource and use it to create a new ObjectDefinition instance with JSON defaults.
static ObjectNode	newObjectNode() Instantiates a new ObjectNode with the default node factory.
static ObjectNode	newObjectNode(Map<String,JsonNode> children) Instantiates a new ObjectNode with the default node factory.
static JsonParser	newParser(InputStream inputStream) Creates a new JsonParser for the input stream.
static JsonPointer	newPointer(String... arguments) Creates a JsonPointer for the path arguments.
static String	newPointerString(String... arguments) Creates a JsonPointer for the path arguments.
static ObjectNode	newSchema(JSONUtil.SchemaVersion schemaVersion, JSONUtil.NodeType... type) Creates a new schema with the specified version and ID.
static ObjectNode	newSchema(JSONUtil.SchemaVersion schemaVersion, String id) Creates a new schema with the specified version and ID.
static ObjectNode	newSchema(JSONUtil.SchemaVersion schemaVersion, String title, JSONUtil.NodeType... types) Creates a new schema with the specified version and ID.
static SchemaBuilder	newSchemaBuilder() Factory method to create a new SchemaBuilder instance.
static JsonNode	parseNode(InputStream inputStream) Parses an JSON input stream into a Java object.
static JsonNode	path(JsonNode node, String fieldName) Null safe convenience method for JsonNode.path(String).
static String	prettyPrintJSON(Object json) Pretty print JSON nodes.
static JsonNode	remove(JsonNode node, String fieldName) Convenience method to remove the provided field name from the the provided json node.
static void	writeNode(JsonNode jsonNode, OutputStream outputStream) Writes the given node to the supplied output stream.

Methods inherited from class java.lang.Object

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

Field Detail

FULL_DOCUMENT_JSON_POINTER

public static final String FULL_DOCUMENT_JSON_POINTER

See Also:

Constant Field Values

JSON_PARSER

public static final com.boomi.util.StreamUtil.Parser<JsonNode> JSON_PARSER

A StreamUtil.Parser implementation which parses a given InputStream into a JsonNode by calling StreamUtil.Parser

$SCHEMA

public static final String $SCHEMA

See Also:

Constant Field Values

$REF

public static final String $REF

See Also:

Constant Field Values

SCHEMA_ID

public static final String SCHEMA_ID

See Also:

Constant Field Values

SCHEMA_TITLE

public static final String SCHEMA_TITLE

See Also:

Constant Field Values

SCHEMA_TYPE

public static final String SCHEMA_TYPE

See Also:

Constant Field Values

SCHEMA_PROPERTIES

public static final String SCHEMA_PROPERTIES

See Also:

Constant Field Values

POINTER_PATH_DELIMITER_CHAR

public static final char POINTER_PATH_DELIMITER_CHAR

See Also:

Constant Field Values

POINTER_PATH_DELIMITER

public static final String POINTER_PATH_DELIMITER

Method Detail

getDefaultObjectMapper

public static ObjectMapper getDefaultObjectMapper()

Obtain the global ObjectMapper instance.

Returns:

Default ObjectMapper instance.

getDefaultJsonFactory

public static JsonFactory getDefaultJsonFactory()

Obtain the global JsonFactory instance.

Returns:

JsonFactory instance.

newParser

public static JsonParser newParser(InputStream inputStream)
                            throws IOException

Creates a new JsonParser for the input stream.

Parameters:

inputStream - java.io.InputStream to parse.

Returns:

Initialized JsonParserObject

Throws:

IOException

newInitializedParser

public static JsonParser newInitializedParser(InputStream inputStream)
                                       throws IOException

Creates a new JsonParser for the input stream and advances parser to the first value token.

Parameters:

inputStream - java.io.InputStream to parse.

Returns:

Initialized JsonParser

Throws:

IOException

prettyPrintJSON

public static String prettyPrintJSON(Object json)
                              throws JsonProcessingException

Pretty print JSON nodes.

Parameters:

json - Object to be formatted.

Returns:

Formatted string.

Throws:

JsonProcessingException

encodeSlashesAndTildas

public static String encodeSlashesAndTildas(String name)

decodeSlashesAndtildas

public static String decodeSlashesAndtildas(String name)

newObjectNode

public static ObjectNode newObjectNode()

Instantiates a new ObjectNode with the default node factory.

Returns:

New ObjectNode.

newObjectNode

public static ObjectNode newObjectNode(Map<String,JsonNode> children)

Instantiates a new ObjectNode with the default node factory.

Parameters:

children - Children for new node.

Returns:

New ObjectNode.

newEmptySchema

public static ObjectNode newEmptySchema(JSONUtil.SchemaVersion schemaVersion)

Instantiates a new object node to be used as a schema.

Parameters:

schemaVersion - The version of the schema.

Returns:

ObjectNode with $schema set for the specified schema version.

newSchema

public static ObjectNode newSchema(JSONUtil.SchemaVersion schemaVersion,
                                   String id)

Creates a new schema with the specified version and ID.

Parameters:

schemaVersion - The version of the schema to set.

id - The ID of the schema.

Returns:

ObjectNode with initialized parameters.

newSchema

public static ObjectNode newSchema(JSONUtil.SchemaVersion schemaVersion,
                                   JSONUtil.NodeType... type)

Creates a new schema with the specified version and ID.

Parameters:

schemaVersion - The version of the schema to set.

type - The schema object type.

Returns:

Initialized ObjectNode for the schema.

newSchema

public static ObjectNode newSchema(JSONUtil.SchemaVersion schemaVersion,
                                   String title,
                                   JSONUtil.NodeType... types)

Creates a new schema with the specified version and ID.

Parameters:

schemaVersion - The version of the schema to set.

title - The schema object title.

types - The schema object types.

Returns:

Initialized ObjectNode for the schema.

newPointerString

public static String newPointerString(String... arguments)

Creates a JsonPointer for the path arguments.

Parameters:

arguments - Array of arguments in path.

Returns:

JSON pointer string.

newPointer

public static JsonPointer newPointer(String... arguments)

Creates a JsonPointer for the path arguments.

Parameters:

arguments - Array of arguments in path.

Returns:

Compiled JsonPointer object.

formatPointer

public static JsonPointer formatPointer(String pattern,
                                        String... arguments)

Creates a JsonPointer for the supplied pattern.

Parameters:

pattern - MessageFormat pattern to populate.

arguments - Arguments for the template.

Returns:

Compiled JsonPointer object.

fieldsIterable

public static Iterable<Map.Entry<String,JsonNode>> fieldsIterable(JsonNode jsonNode)

Creates an Iterable of the node fields.

Parameters:

jsonNode - JsonNode whose fields need to be iterated.

Returns:

Iterable of the node fields.

writeNode

public static void writeNode(JsonNode jsonNode,
                             OutputStream outputStream)
                      throws IOException

Writes the given node to the supplied output stream.

Parameters:

jsonNode - com.fasterxml.jackson.databind.JsonNode to write.

outputStream - java.io.OutputStream to write to.

Throws:

IOException - In event of failure.

parseNode

public static JsonNode parseNode(InputStream inputStream)
                          throws JsonProcessingException,
                                 IOException

Parses an JSON input stream into a Java object.

Parameters:

inputStream - The input stream to parse.

Returns:

JsonNode tree produced.

Throws:

JsonProcessingException - On parsing error.

IOException - On stream error.

createPrettyPrinter

public static PrettyPrinter createPrettyPrinter()

Creates and returns a JSON pretty printer which always uses windows newlines (the boomi "standard").

asText

public static String asText(JsonNode node,
                            String fieldName)

Util method to safely get the content of the specified field using JsonNode.asText(). Numeric and boolean fields will be converted to text.

Parameters:

node - the json node

fieldName - the name of the field

Returns:

the text value of the field if the node is not null and the field exists, null otherwise

asBoolean

public static boolean asBoolean(JsonNode node,
                                String fieldName)

Util method to safely get the specified field as a boolean. Note the semantics of this method are different than calling JsonNode#path(String)#asBoolean(JsonNode, String) directly. This method only calls JsonNode.asBoolean() if the node returned from JsonNode.path(String) is actually a BooleanNode and treats everything else as false. Invoking JsonNode.asBoolean() on non-boolean nodes leads to some interesting behavior. e.g., {"x": 9}.path("x").asBoolean() == true .

Parameters:

node - the json node

fieldName - the name of the field

Returns:

the boolean value of the field if the node is not null, the field exists, and the field is boolean, false otherwise

path

public static JsonNode path(JsonNode node,
                            String fieldName)

Null safe convenience method for JsonNode.path(String).

Parameters:

node - the json node

fieldName - the name of the field

Returns:

JsonNode.path(String) if the node is non-null, MissingNode instance otherwise

hasNonNull

public static boolean hasNonNull(JsonNode node,
                                 String fieldName)

Util method to safely determine if the specified field exists with a non-null value.

Parameters:

node - the json node

fieldName - the name of the field

Returns:

true if the node is not null and it contains non-null field with the specified name, false otherwise

remove

public static JsonNode remove(JsonNode node,
                              String fieldName)

Convenience method to remove the provided field name from the the provided json node. This method handles the cast from JsonNode to ObjectNode.

Parameters:

node - the node to modify

fieldName - the name of the field to remove

Returns:

JsonNode containing the field data if the field exists, a MissingNode instance otherwise.

Throws:

IllegalArgumentException - if node is null or cannot be cast to an ObjectNode

newSchemaBuilder

public static SchemaBuilder newSchemaBuilder()

Factory method to create a new SchemaBuilder instance.

Returns:

the schema builder

newJsonDefinition

public static ObjectDefinition newJsonDefinition(ObjectDefinitionRole role,
                                                 JsonNode schema)

Factory method to create a new ObjectDefinition instance with JSON defaults. Specifically, the input and output content types will be set to either ContentType.JSON or ContentType.NONE depending on the provided ObjectDefinitionRole, the element name will be set to JSON Pointer for the full document, and the JSON schema with the string value of the provided schema.

Parameters:

role - the role for the definition

schema - the schema for the definition

Returns:

the ObjectDefinition instance with JSON defaults

newJsonDefinitionFromResource

public static ObjectDefinition newJsonDefinitionFromResource(ObjectDefinitionRole role,
                                                             String resourceName)
                                                      throws IOException

Factory method to load a schema resource and use it to create a new ObjectDefinition instance with JSON defaults.

Parameters:

role - the role for the definition

resourceName - the name of the resource containing the schema

Returns:

the ObjectDefinition instance with JSON defaults

Throws:

IOException

See Also:

newJsonDefinition(ObjectDefinitionRole, JsonNode)

loadSchemaFromResource

public static JsonNode loadSchemaFromResource(String resourceName)
                                       throws IOException

Utility method to load a JSON schema from a resource.

Parameters:

resourceName - the name of the resource to load

Returns:

JsonNode representing the schema

Throws:

IOException

buildSchema

public static JsonNode buildSchema(Buildable buildable)

Build a JSON schema based on the provided Buildable. Currently only supports building schemas with root type of "object".

Parameters:

buildable - the buildable

Returns:

JsonNode containing the schema

Throws:

IllegalArgumentException - if the buildable is null

IllegalArgumentException - if Buildable.getType() is not JSONUtil.NodeType.OBJECT