org.hawkular.cmdgw.api

Class ApiDeserializer

java.lang.Object

org.hawkular.cmdgw.api.ApiDeserializer

public class ApiDeserializer
extends Object

Given the special syntax of "apiName=JSON" this will deserialize the JSON into the appropriate API POJO.

Constructor Summary

Constructors

Constructor and Description
ApiDeserializer()

Method Summary

Modifier and Type	Method and Description
<T extends org.hawkular.bus.common.BasicMessage> org.hawkular.bus.common.BasicMessageWithExtraData<T>	deserialize(InputStream input) Reads a JSON string in Hawkular format that is found in the given input stream and converts the JSON string to a particular message object.
<T extends org.hawkular.bus.common.BasicMessage> org.hawkular.bus.common.BasicMessageWithExtraData<T>	deserialize(String nameAndJson) Deserializes a JSON string in Hawkular format.
static String	toHawkularFormat(org.hawkular.bus.common.BasicMessage msg) Returns a string that encodes the given object as a JSON message but then prefixes that JSON with additional information that a Hawkular client will need to be able to deserialize the JSON.
static org.hawkular.bus.common.BinaryData	toHawkularFormat(org.hawkular.bus.common.BasicMessage msg, InputStream extraData) Returns a BinaryData object (which is a stream) that encodes the given message just like toHawkularFormat(BasicMessage) does but also packages the given input stream as extra data with the JSON message.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiDeserializer

public ApiDeserializer()

Method Detail

toHawkularFormat

public static String toHawkularFormat(org.hawkular.bus.common.BasicMessage msg)

Returns a string that encodes the given object as a JSON message but then prefixes that JSON with additional information that a Hawkular client will need to be able to deserialize the JSON. This string can be used to deserialize the object via deserialize(String).

Parameters:

msg - the message object that will be serialized into JSON

Returns:

a string that includes the JSON that can be used by other Hawkular endpoints to deserialize the message.

toHawkularFormat

public static org.hawkular.bus.common.BinaryData toHawkularFormat(org.hawkular.bus.common.BasicMessage msg,
                                                                  InputStream extraData)

Returns a BinaryData object (which is a stream) that encodes the given message just like toHawkularFormat(BasicMessage) does but also packages the given input stream as extra data with the JSON message. The returned object can be used to deserialize the msg and extra data via deserialize(InputStream).

Parameters:

msg - the message object that will be serialized into JSON

extraData - the extra data to be packages with the given message

Returns:

an object that can be used by other Hawkular endpoints to deserialize the message.

deserialize

public <T extends org.hawkular.bus.common.BasicMessage> org.hawkular.bus.common.BasicMessageWithExtraData<T> deserialize(String nameAndJson)

Deserializes a JSON string in Hawkular format. The JSON object is returned.

Parameters:

nameAndJson - the string to be deserialized

Returns:

the object represented by the JSON

deserialize

public <T extends org.hawkular.bus.common.BasicMessage> org.hawkular.bus.common.BasicMessageWithExtraData<T> deserialize(InputStream input)

Reads a JSON string in Hawkular format that is found in the given input stream and converts the JSON string to a particular message object. The input stream will remain open so the caller can stream any extra data that might appear after it. Because of the way the JSON parser works, some extra data might have been read from the stream that wasn't part of the JSON message but was part of the extra data that came with it. Because of this, the caller should no longer use the given stream but instead read the extra data via the returned object (see BasicMessageWithExtraData.getBinaryData()) since it will handle this condition properly.

Parameters:

in - input stream that has the Hawkular formatted JSON string at the head.

Returns:

a POJO that contains a message object that was represented by the JSON string found in the stream. This returned POJO will also contain a BinaryData object that you can use to stream any additional data that came in the given input stream.