Package com.ibm.di.fc.axis2

Class Axis2WSClientFC

java.lang.Object

com.ibm.di.fc.Function

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

Constructors

Constructor	Description
Axis2WSClientFC()

Method Summary

Modifier and Type	Method	Description
org.apache.axis2.AxisFault	getAxisFault()	Returns the AxisFault that just occurred.
java.lang.String	getHttpAuthPassword()
java.lang.String	getHttpAuthUserName()	Returns the Username set for http authentication using the method setHttpAuthUserName
org.apache.axis2.client.ServiceClient	getServiceClient()	Returns the ServiceClient
java.lang.String	getVersion()	This method returns the current version of the component.
void	initialize(java.lang.Object initParams)	Initializes the invocation process.
java.lang.Object	perform(java.lang.Object input)	Gathers the passed information and creates invocation payload for the client.
java.lang.Object	querySchema(java.lang.Object src)	Retrieves the input and output message schema of the configured operation.
void	setHttpAuthPassword(java.lang.String httpAuthPassword)	Sets the password for http authenticaton when WSDL is http auth protected.
void	setHttpAuthUserName(java.lang.String httpAuthUserName)	Sets the username for http authenticaton when WSDL is http auth protected.

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

getHttpAuthUserName

public java.lang.String getHttpAuthUserName()

Returns the Username set for http authentication using the method setHttpAuthUserName

Returns:

Username

Since:

7.1 FP4.

setHttpAuthUserName

public void setHttpAuthUserName(java.lang.String httpAuthUserName)

Sets the username for http authenticaton when WSDL is http auth protected.

Parameters:

httpAuthUserName -

Since:

7.1 FP4.

getHttpAuthPassword

public java.lang.String getHttpAuthPassword()

Returns:

setHttpAuthPassword

public void setHttpAuthPassword(java.lang.String httpAuthPassword)

Sets the password for http authenticaton when WSDL is http auth protected.

Parameters:

httpAuthPassword -

Since:

7.1 FP4.

initialize

public void initialize(java.lang.Object initParams)
                throws java.lang.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:

java.lang.Exception - If a mandatory field value is missing or if exception occurs during the internal objects initialization.

perform

public java.lang.Object perform(java.lang.Object input)
                         throws java.lang.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:

java.lang.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 java.lang.Object querySchema(java.lang.Object src)
                             throws java.lang.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:

java.lang.Exception - If an error occurs during the process.

See Also:

Entry, Vector

getVersion

public java.lang.String getVersion()

This method returns the current version of the component.

Returns:

the current version of the component as a String object.

getServiceClient

public org.apache.axis2.client.ServiceClient getServiceClient()

Returns the ServiceClient

getAxisFault

public org.apache.axis2.AxisFault getAxisFault()

Returns the AxisFault that just occurred.

Returns:

The AxisFault from the last perform(), or null if no AxisFault was caught.