com.ibm.di.fc.webservice
Class AxisSoapToJava

java.lang.Object
  extended by com.ibm.di.fc.Function
      extended by com.ibm.di.fc.webservice.AxisSoapToJava
All Implemented Interfaces:
FunctionInterface, VersionInfoInterface

public class AxisSoapToJava
extends Function

The Axis Soap-to-Java Function Component (FC) is part of the TDI Web Services suite.This component can be used both on the web service client and on the web service server side. This FC uses Axis' mechanism for parsing SOAP response (when on the client) or SOAP request (when on the server) to Java objects - as a complementary component to the AxisJavaToSoap FC. It is given a SOAP response/request message and returns the parsed Java objects either as standalone Java object(s) or capsulated in an Entry object.This component supports both RPC and Document style.


Field Summary
static String INPUT_XML_DOM
          The name of the returnXMLType attribute when DOMElement is chosen
static String INPUT_XML_STRING
          The name of the returnXMLType attribute when String is chosen
static String MODE_REQUEST
          The value of the request mode
static String MODE_RESPONSE
          The value of the response attribute
static String PARAM_COMPLEX_TYPES
          The list of fully qualified Java classes generated by WSDL2Java from the WSDL file
static String PARAM_INPUT_TYPE
          specifies the input type
static String PARAM_MODE
          specifies whether this Function Component handles a SOAP request or a SOAP response
static String PARAM_SOAP_OPERATION
          The name of the SOAP operation as described in the WSDL file
static String PARAM_WSDL_URL
          The WSDL URL parameter
 
Fields inherited from class com.ibm.di.fc.Function
logger
 
Constructor Summary
AxisSoapToJava()
           
 
Method Summary
 String getVersion()
          Version information.
 void initialize(Object obj)
          Initializes the function component by using the parameters in the Config Tab.
 Object perform(Object obj)
          Parses a SOAP message and turns it into a Java Object If this FC is passed a SOAP Fault message to parse, this FC returns a Java object of type org.apache.axis.AxisFault.
 void registerTypeMapping(Class javaType, QName xmlType, org.apache.axis.encoding.SerializerFactory serializerFactory, org.apache.axis.encoding.DeserializerFactory deserializerFactory)
          This method is analogous to the 'registerTypeMapping' method in org.apache.axis.client.Call.
 
Methods inherited from class com.ibm.di.fc.Function
debug, getConfiguration, getContext, getDebug, getLog, getParam, getRSInterface, getUI, initialize, logmsg, querySchema, setConfiguration, setContext, setDebug, setLog, setParam, setRSInterface, terminate, updateSchema, verifyInitialized
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PARAM_WSDL_URL

public static final String PARAM_WSDL_URL
The WSDL URL parameter

See Also:
Constant Field Values

PARAM_SOAP_OPERATION

public static final String PARAM_SOAP_OPERATION
The name of the SOAP operation as described in the WSDL file

See Also:
Constant Field Values

PARAM_INPUT_TYPE

public static final String PARAM_INPUT_TYPE
specifies the input type

See Also:
Constant Field Values

PARAM_COMPLEX_TYPES

public static final String PARAM_COMPLEX_TYPES
The list of fully qualified Java classes generated by WSDL2Java from the WSDL file

See Also:
Constant Field Values

PARAM_MODE

public static final String PARAM_MODE
specifies whether this Function Component handles a SOAP request or a SOAP response

See Also:
Constant Field Values

MODE_REQUEST

public static final String MODE_REQUEST
The value of the request mode

See Also:
Constant Field Values

MODE_RESPONSE

public static final String MODE_RESPONSE
The value of the response attribute

See Also:
Constant Field Values

INPUT_XML_STRING

public static final String INPUT_XML_STRING
The name of the returnXMLType attribute when String is chosen

See Also:
Constant Field Values

INPUT_XML_DOM

public static final String INPUT_XML_DOM
The name of the returnXMLType attribute when DOMElement is chosen

See Also:
Constant Field Values
Constructor Detail

AxisSoapToJava

public AxisSoapToJava()
Method Detail

initialize

public void initialize(Object obj)
                throws Exception
Initializes the function component by using the parameters in the Config Tab.

Specified by:
initialize in interface FunctionInterface
Overrides:
initialize in class Function
Parameters:
obj - not used in this method
Throws:
Exception

perform

public Object perform(Object obj)
               throws Exception
Parses a SOAP message and turns it into a Java Object If this FC is passed a SOAP Fault message to parse, this FC returns a Java object of type org.apache.axis.AxisFault. In case this FC returns an org.apache.axis.AxisFault object, the FC stores this object in the "soapFault" Attribute if an Entry is passed to the FC; and if a java.lang.Object was passed then this FC returns the org.apache.axis.AxisFault object. If the value of the "Input the SOAP message as" FC parameter is String then the SOAP message to parse is read from the "xmlString" Attribute as a java.lang.String, provided an Entry is passed to the FC. If the value of the "Input the SOAP message as" FC parameter is DOMElement then the SOAP message to parse is read from the "xmlDOMElement" Attribute as an org.w3c.dom.Element object, provided an Entry is passed to the FC. If a Java Object is passed to this FC, then the SOAP message to parse is assumed to be the value of the passed Java Object as either a java.lang.String object (when the value of the "Input the SOAP message as" FC parameter is String) or as an org.w3c.dom.Element object (when the value of the "Input the SOAP message as" FC parameter is DOMElement).

Parameters:
obj -
Returns:
a Java object
Throws:
Exception

registerTypeMapping

public void registerTypeMapping(Class javaType,
                                QName xmlType,
                                org.apache.axis.encoding.SerializerFactory serializerFactory,
                                org.apache.axis.encoding.DeserializerFactory deserializerFactory)
This method is analogous to the 'registerTypeMapping' method in org.apache.axis.client.Call. It can be used for configuring serialization/deserialization of Java types, for which the default serializer/deserializer (org.apache.axis.encoding.ser.BeanSerializer/ org.apache.axis.encoding.ser.BeanDeserializer) is not suitable.

Parameters:
javaType - java type to handle
xmlType - XML mapping
serializerFactory - a factory of the serializers
deserializerFactory - a factory of deserializers

getVersion

public String getVersion()
Version information.

Returns:
version information