AdroitLogic UltraESB v1.7.0

org.adroitlogic.ultraesb.api.mediation
Interface JSONSupport


public interface JSONSupport

Mediation Support for JSON based mediation

Since:
1.7.0

Method Summary
 void convertJSONToStream(Message m, java.lang.Object o)
          Convert an untyped Object (e.g.
 void convertSOAPToJSONStream(Message m)
          Convert the current SOAP message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream
 void convertSOAPToJSONStream(Message m, javax.xml.namespace.QName staringElement, boolean retainNSPrefixes)
          Convert the current SOAP message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream
 java.lang.Object convertToTypedJSON(Message m, java.lang.Class clazz)
          Convert the current message into a Typed JSON Object
 java.util.Map convertToUntypedJSON(Message m)
          Convert the current message into an untyped JSON MapMessage
 void convertXMLToJSONStream(Message m)
          Convert the current XML message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream
 void convertXMLToJSONStream(Message m, javax.xml.namespace.QName staringElement, boolean retainNSPrefixes)
          Convert the current XML message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream
 void processBasicJSONDataServiceRequest(Message msg, java.lang.String dataSvcBeanName, java.lang.String dataSourceName)
          Process request message as a basic JSON data service request.
 

Method Detail

convertSOAPToJSONStream

void convertSOAPToJSONStream(Message m)
Convert the current SOAP message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream

Parameters:
m - the message to be converted

convertXMLToJSONStream

void convertXMLToJSONStream(Message m,
                            javax.xml.namespace.QName staringElement,
                            boolean retainNSPrefixes)
Convert the current XML message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream

Parameters:
m - the message to be converted
staringElement - an optional starting element to begin conversion (e.g. first element of the SOAP body)
retainNSPrefixes - retain the namespace prefixes into JSON names for elements

convertXMLToJSONStream

void convertXMLToJSONStream(Message m)
Convert the current XML message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream

Parameters:
m - the message to be converted

convertSOAPToJSONStream

void convertSOAPToJSONStream(Message m,
                             javax.xml.namespace.QName staringElement,
                             boolean retainNSPrefixes)
Convert the current SOAP message payload (which maybe available as any format such as raw file or DOM etc) into a file based JSON stream

Parameters:
m - the message to be converted
staringElement - an optional starting element to begin conversion (e.g. first element of the SOAP body)
retainNSPrefixes - retain the namespace prefixes into JSON names for elements

convertJSONToStream

void convertJSONToStream(Message m,
                         java.lang.Object o)
Convert an untyped Object (e.g. Map holding a JSON payload) to a streamed (file based) message

Parameters:
m - current message to hold final stream
o - untyped object to conver to JSON

convertToUntypedJSON

java.util.Map convertToUntypedJSON(Message m)
Convert the current message into an untyped JSON MapMessage

Parameters:
m - the current message to be transformed
Returns:
an untyped Map created using the Jackson JSON parser

convertToTypedJSON

java.lang.Object convertToTypedJSON(Message m,
                                    java.lang.Class clazz)
Convert the current message into a Typed JSON Object

Parameters:
m - the current message to be transformed
clazz - the class of the return message
Returns:
the Object instance of the JSON message

processBasicJSONDataServiceRequest

void processBasicJSONDataServiceRequest(Message msg,
                                        java.lang.String dataSvcBeanName,
                                        java.lang.String dataSourceName)
                                        throws java.lang.Exception
Process request message as a basic JSON data service request. The response would be generated by executing the specified queries of the JSON Data Service bean definition

Parameters:
msg - the request message
dataSvcBeanName - the name of the bean defining the JSON data service
dataSourceName - the name of the data source bean
Throws:
java.lang.Exception - on an error

Copyright (c) 2010-2012 AdroitLogic Private Ltd. All rights reserved.