com.ibm.di.fc.webservice
Class AxisJavaToSoap

java.lang.Object
  com.ibm.di.fc.Function
      com.ibm.di.fc.webservice.AxisJavaToSoap

All Implemented Interfaces:

FunctionInterface, VersionInfoInterface

public class AxisJavaToSoap
extends Function

The Axis Java-to-Soap 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 component receives an Entry or a Java object and produces the SOAP request (when on the client) or response (when on the server) message. It will provide the whole SOAP message, as well as separately the SOAP Header and the SOAP Body to facilitate processing and customization.The component supports both RPC and Document style.

Field Summary

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_MODE specifies whether this Function Component handles a SOAP request or a SOAP response
static String	PARAM_OPERATION_PARAM_LIST The list of ordered SOAP operation parameter names
static String	PARAM_RETURN_XML_TYPE The XML return type - DOMElement or String
static String	PARAM_SOAP_OPERATION The name of the SOAP operation as described in the WSDL file
static String	PARAM_USE_MULTI_REFS If checked the generated SOAP message will use multi-refs.
static String	PARAM_WSDL_URL The WSDL URL parameter
static String	RETURN_XML_DOM The name of the returnXMLType attribute when DOMElement is chosen
static String	RETURN_XML_STRING The name of the returnXMLType attribute when String is chosen

Fields inherited from class com.ibm.di.fc.Function

logger

Constructor Summary

AxisJavaToSoap()

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) Generates a SOAP message from the given Java code.
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_RETURN_XML_TYPE

public static final String PARAM_RETURN_XML_TYPE

The XML return type - DOMElement or String

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

PARAM_OPERATION_PARAM_LIST

public static final String PARAM_OPERATION_PARAM_LIST

The list of ordered SOAP operation parameter names

See Also:

Constant Field Values

PARAM_USE_MULTI_REFS

public static final String PARAM_USE_MULTI_REFS

If checked the generated SOAP message will use multi-refs.

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

RETURN_XML_STRING

public static final String RETURN_XML_STRING

The name of the returnXMLType attribute when String is chosen

See Also:

Constant Field Values

RETURN_XML_DOM

public static final String RETURN_XML_DOM

The name of the returnXMLType attribute when DOMElement is chosen

See Also:

Constant Field Values

Constructor Detail

AxisJavaToSoap

public AxisJavaToSoap()

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 - An exception is thrown if the initialization fails.

perform

public Object perform(Object obj)
               throws Exception

Generates a SOAP message from the given Java code. If this FC is passed (a) an Entry with a "soapFault" Attribute, whose value is an object of type org.apache.axis.AxisFault, or (b) a Java object of type org.apache.axis.AxisFault, then the FC generates a SOAP Fault message containing the information stored in the passed AxisFault object. If the value of the Return XML as FC parameter is String then the SOAP response message is stored in the "xmlString" Attribute, if an Entry was passed to the FC. However, if the value of the "Return XML as" FC parameter is DOMElement then the generated SOAP message is stored in the "xmlDOMElement" Attribute, if an Entry was passed to the FC. If a Java Object array (Object[]) was passed to this FC, then the return value of the FC is either a java.lang.String object (when the value of the "Return XML as" FC parameter is String) or an org.w3c.dom.Element object (when the value 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