com.ibm.di.fc.axis2
Class Axis2WSClientFC

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

public class Axis2WSClientFC
extends Function

This is a WebService client based on the Axis2 library. For more information see the on-line documentation of the Axis2 WebService Client Function Component.

Since:
7.0

Field Summary
 
Fields inherited from class com.ibm.di.fc.Function
logger
 
Constructor Summary
Axis2WSClientFC()
           
 
Method Summary
 String getVersion()
          This method returns the current version of the component.
 void initialize(Object initParams)
          Initializes the invocation process.
 Object perform(Object input)
          Gathers the passed information and creates invocation payload for the client.
 Object querySchema(Object src)
          Retrieves the input and output message schema of the configured operation.
 
Methods inherited from class com.ibm.di.fc.Function
debug, getConfiguration, getContext, getDebug, getLog, getParam, getRSInterface, getUI, initialize, logmsg, 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
 

Constructor Detail

Axis2WSClientFC

public Axis2WSClientFC()
Method Detail

initialize

public void initialize(Object initParams)
                throws Exception
Initializes the invocation process. Creates the client which will be used as a basis for the invocation. During the initialization all mandatory fields are gathered and the internal objects dependent from them are created. The mandatory fields are: WSDL URL, Service, Endpoint and Operation.

Specified by:
initialize in interface FunctionInterface
Overrides:
initialize in class Function
Parameters:
initParams - not used.
Throws:
Exception - If a mandatory field value is missing or if exception occurs during the internal objects initialization.

perform

public Object perform(Object input)
               throws Exception
Gathers the passed information and creates invocation payload for the client. The FC expects a IBM Tivoli Directory Integrator Attribute which corresponds to the input message of the configured operation. If the attribute is not found an Exception will be thrown. The FC expects only IBM Tivoli Directory Integrator Entry object for input and Exception will be thrown if other type is given.

Parameters:
input - The input IBM Tivoli Directory Integrator Entry.
Returns:
Entry object with the server response.
Throws:
Exception - If the required IBM Tivoli Directory Integrator Attribute is missing, if the input is not an entry or if an Axis specific fault occurs.

querySchema

public Object querySchema(Object src)
                   throws Exception
Retrieves the input and output message schema of the configured operation.

Specified by:
querySchema in interface FunctionInterface
Overrides:
querySchema in class Function
Parameters:
src - not used.
Returns:
IBM Tivoli Directory Integrator Schema (SchemaConfig) object filled with the schema extracted for the operations.
Throws:
Exception - If an error occurs during the process.
See Also:
Entry, Vector

getVersion

public String getVersion()
This method returns the current version of the component.

Returns:
the current version of the component as a String object.