com.celequest.api.function.webservice
Interface IAlertWSMessageConstructor

All Superinterfaces:

IUDFunction

public interface IAlertWSMessageConstructor

extends IUDFunction

Interface for user-defined a function for constructing a web service message based on alert data.

Since:

4.0.0

Field Summary

static String	SOAP_PASSWORD SOAP password attribute name.
static String	SOAP_USER_NAME SOAP username attribute Name.

Method Summary

org.apache.axis.Message	constructMessage(Element alertData, String wsdlURI, String soapOperation) Constructs the web service message based on the specified alert data.
org.apache.axis.Message	constructMessage(Element alertData, String wsdlURI, String soapOperation, Map additionalProperties) Constructs the web service message based on the specified alert data.

Methods inherited from interface com.celequest.api.function.IUDFunction

setLogger

Field Detail

SOAP_USER_NAME

public static final String SOAP_USER_NAME

SOAP username attribute Name.

See Also:

Constant Field Values

SOAP_PASSWORD

public static final String SOAP_PASSWORD

SOAP password attribute name.

See Also:

Constant Field Values

Method Detail

constructMessage

public org.apache.axis.Message constructMessage(Element alertData,
                                                String wsdlURI,
                                                String soapOperation)
                                         throws Exception

Constructs the web service message based on the specified alert data. This method is expected to map the alert data to the right web service arguments so that the target web service has all the requisite arguments filled in.

Parameters:

alertData - xml document containing alert data: business rows which caused the alert to fire and the reportlet rows (if any)

wsdlURI - the URI of the web service which will be invoked using the message returned by this method.

soapOperation - the name of the operation which will be invoked in the webservice

Returns:

Message object containing the web service message

Throws:

Exception - when the message construction fails

constructMessage

public org.apache.axis.Message constructMessage(Element alertData,
                                                String wsdlURI,
                                                String soapOperation,
                                                Map additionalProperties)
                                         throws Exception

Constructs the web service message based on the specified alert data. This method is expected to map the alert data to the right web service arguments so that the target web service has all the requisite arguments filled in.

Parameters:

alertData - xml document containing alert data: business rows which caused the alert to fire and the reportlet rows (if any)

wsdlURI - the URI of the web service which will be invoked using the message returned by this method.

soapOperation - the name of the operation which will be invoked in the webservice

additionalProperties - Map to pass in the additional properties to the construct Method(like username, password, etc.)

Returns:

Message object containing the web service message

Throws:

Exception - when the message construction fails