com.wm.util.coder

Class IDataJSONCoder

java.lang.Object

com.wm.util.coder.IDataCoder

com.wm.util.coder.IDataJSONCoder

public class IDataJSONCoder
extends IDataCoder

This class encodes an Integration Server document to JSON and decodes JSON to an Integration Server document. The encode(OutputStream, IData) and decode(InputStream) methods are called directly from client applications or from these public services:

• pub.json:jsonStreamToDocument
• pub.json:documentToJSONString
• pub.json:jsonStringToDocument

IDataJSONCoder uses the Jackson library to parse and generate JSON. Jackson attempts to conform to the published JSON standard, RFC 4627. It does not use a convention, such as Badgerfish, to represent XML in JSON.

See Also:

JSON, RFC 4627, Jackson documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IDataJSONCoder.JSON_ENCODING The character encodings that can be used by encode(OutputStream, IData) when generating JSON.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	WATT_SERVER_JSON_DECODE_INTEGER_AS_LONG
static java.lang.String	WATT_SERVER_JSON_DECODE_REAL_AS_DOUBLE
static java.lang.String	WATT_SERVER_JSON_PRETTY_PRINT

Constructor Summary

Constructors

Constructor and Description
IDataJSONCoder()

Method Summary

Modifier and Type	Method and Description
IData	decode(java.io.InputStream is) Converts a stream of JSON content into an Integration Server document.
void	encode(java.io.OutputStream os, IData data) Converts an Integration Server document to JSON and writes it to the supplied OutputStream.
java.lang.String	getContentType() Returns a String containing the name of the content type that is in use by this instance of IDataCoder.
void	setDateEncoding(java.lang.String encodeAs) Indicates whether Date instances in the IData being encoded should become long timestamps or Strings in the JSON text returned by encode(OutputStream, IData).
void	setDecodeIntegerAsLong(boolean value) Indicates to the IDataJSONCoder whether to convert integer numbers in the JSON content to java.lang.Longs or java.lang.Integers.
void	setDecodeNullRootAsEmpty(boolean value) Indicates to the IDataJSONCoder whether null scalar value at root in the JSON being parsed should be converted to empty IData or to {"$rootValue":null}
void	setDecodeRealAsDouble(boolean value) Indicates to the IDataJSONCoder whether to convert real numbers in the JSON content to java.lang.Floats or java.lang.Doubles.
void	setDecodeRealAsString(boolean value) Indicates to the IDataJSONCoder whether decimal numbers in the JSON being parsed should be converted to java.lang.Strings.
void	setEncoding(IDataJSONCoder.JSON_ENCODING encoding) Indicates to the IDataJSONCoder which character encoding to use.
void	setPrettyPrint(boolean prettyPrint) Indicates to the IDataJSONCoder whether to use pretty print to format the JSON output.
void	setUnescapeSpecialChars(boolean value) Indicates to the IDataJSONCoder whether the escape characters will be un-escaped while decoding the JSON string value.

Methods inherited from class com.wm.util.coder.IDataCoder

decodeFromBytes, encodeToBytes, readFromFile, writeToFile

Methods inherited from class java.lang.Object

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

Field Detail

WATT_SERVER_JSON_DECODE_INTEGER_AS_LONG

public static final java.lang.String WATT_SERVER_JSON_DECODE_INTEGER_AS_LONG

See Also:

Constant Field Values

WATT_SERVER_JSON_DECODE_REAL_AS_DOUBLE

public static final java.lang.String WATT_SERVER_JSON_DECODE_REAL_AS_DOUBLE

See Also:

Constant Field Values

WATT_SERVER_JSON_PRETTY_PRINT

public static final java.lang.String WATT_SERVER_JSON_PRETTY_PRINT

See Also:

Constant Field Values

Constructor Detail

IDataJSONCoder

public IDataJSONCoder()

Method Detail

getContentType

public java.lang.String getContentType()

Description copied from class: IDataCoder

Returns a String containing the name of the content type that is in use by this instance of IDataCoder. Classes that extend the Coder class support one or more content types.

Specified by:

getContentType in class IDataCoder

Returns:

A String specifying the current content type.

encode

public void encode(java.io.OutputStream os,
                   IData data)
            throws java.io.IOException,
                   InvalidDatatypeException

Converts an Integration Server document to JSON and writes it to the supplied OutputStream. The format of the JSON content generated by encode(OutputStream, IData) is controlled by the watt.server.json.prettyPrint property. The default setting for this property is false, which causes encode to generate compact JSON, with no additional carriage returns or indentation. If watt.server.json.prettyPrint is true, the generated JSON is formatted with carriage returns and indentation to make the output easier to read. You can override the setting of this property by calling the setPrettyPrint(boolean) method prior to the encode method.

Field names in the generated JSON text are enclosed in double quotes by default. This conforms to the JSON standard. If the JSON text will be consumed by an older JavaScript processor that does not handle quoted field names correctly, you can set the watt.server.json.quoteFieldNames property to false to change this.

Specified by:

encode in class IDataCoder

Parameters:

os - the OutputStream to write the JSON content to

data - an Integration Server document to be transformed into JSON

Throws:

java.io.IOException

InvalidDatatypeException - If the data in the IData object cannot be encoded (i.e., the IData object contains an object type that is not supported by the specific implementation of encode that you are using).

See Also:

#encode(OutputStream,Values)

decode

public IData decode(java.io.InputStream is)
             throws java.io.IOException,
                    InvalidDatatypeException

Converts a stream of JSON content into an Integration Server document. Field names in JSON text must be enclosed in double quotes. If you intend to parse legacy JavaScript that does not have quoted field names, you can relax this requirement by setting the watt.server.json.allowUnquotedFieldNames property to true.

Specified by:

decode in class IDataCoder

Parameters:

is - an InputStream holding JSON content

Returns:

an Integration Server document as an instance of Values

Throws:

java.io.IOException - If an error occurs while reading the InputStream or writing to the IData object.

InvalidDatatypeException - If the content of InputStream cannot an be properly parsed and decoded.

See Also:

#decodeToIData(InputStream)

setDecodeRealAsDouble

public void setDecodeRealAsDouble(boolean value)

Indicates to the IDataJSONCoder whether to convert real numbers in the JSON content to java.lang.Floats or java.lang.Doubles.

Parameters:

value - If true, real numbers will be converted to Doubles. If false, real numbers will be converted to Floats.

setDecodeIntegerAsLong

public void setDecodeIntegerAsLong(boolean value)

Indicates to the IDataJSONCoder whether to convert integer numbers in the JSON content to java.lang.Longs or java.lang.Integers.

Parameters:

value - If true, real numbers will be converted to Longs. If false, real numbers will be converted to Integers.

setDecodeRealAsString

public void setDecodeRealAsString(boolean value)

Indicates to the IDataJSONCoder whether decimal numbers in the JSON being parsed should be converted to java.lang.Strings.

Parameters:

value - If true, real numbers will be converted to Strings If false, real numbers will not be converted to Strings

setDecodeNullRootAsEmpty

public void setDecodeNullRootAsEmpty(boolean value)

Indicates to the IDataJSONCoder whether null scalar value at root in the JSON being parsed should be converted to empty IData or to {"$rootValue":null}

Parameters:

value - If true, null scalar value will be converted to empty IData If false, null scalar value will be converted to {"$rootValue":null}

setUnescapeSpecialChars

public void setUnescapeSpecialChars(boolean value)

Indicates to the IDataJSONCoder whether the escape characters will be un-escaped while decoding the JSON string value.

Parameters:

If - true, the escape characters will be un-escaped in decoded string. If false, the escape characters will be escaped in decoded string.

setDateEncoding

public void setDateEncoding(java.lang.String encodeAs)

Indicates whether Date instances in the IData being encoded should become long timestamps or Strings in the JSON text returned by encode(OutputStream, IData). If setDateEncoding is not called prior to encode(OutputStream, IData), the formatting specified in the watt.server.json.encodeDateAs configuration parameter is used. If watt.server.json.encodeDateAs is empty, or if encodeAs is null or an empty string, the default formatting provided by Date.toString() is used.

Parameters:

encodeAs - Acceptable values are

• "long" - A Java timestamp; seconds since January 1, 1970 00:00:00
• "ISO8601" - The standard ISO8601 date format YYYY-MM-dd'T'HH:mm:ss.sss'Z'
• Date format string - As defined by SimpleDateFormat.
• null - The default formatting provided by Date.toString(), EEE MMM dd hh:mm:ss zzz yyyy

See Also:

SimpleDateFormat

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

Indicates to the IDataJSONCoder whether to use pretty print to format the JSON output. Call this method prior to calling #encode(OutputStream, Values) or encode(OutputStream, IData) in order to override the current setting of the watt.server.json.prettyPrint property.

Parameters:

prettyPrint - If true, calls to the encode methods will generate JSON formatted with carriage returns and indentation to make the JSON output easier to read. If false, the generated JSON will not include carriage returns or indentation.

setEncoding

public void setEncoding(IDataJSONCoder.JSON_ENCODING encoding)

Indicates to the IDataJSONCoder which character encoding to use. Valid values for encoding are defined by the enum JSON_ENCODING.

Parameters:

encoding - Specifies the encoding to use.