com.whitestein.lsps.wsclient.task

Class WsSoapCall

java.lang.Object

com.whitestein.lsps.engine.AbstractAsynchronousExecutionTask

com.whitestein.lsps.wsclient.task.WsSoapCall

All Implemented Interfaces:

AsynchronousExecutionTask, ExecutableTask

@PermitAll
public class WsSoapCall
extends AbstractAsynchronousExecutionTask
implements AsynchronousExecutionTask

This is the generic implementation of task for web service calls. Thus this task can handle different webservice calls based on the custom TaskInfo ( Task.getTaskInfo()) object which is obtained at runtime (and contains metadata information such as endpoint address etc.) and the values of the fields input, output and error. The task definition and other needed artifacts (data types) are genereted in the process modeler by WSDL generator component. Therefore this task is only interpreter of the task and types definitions generated in the modeler. For the information about the generation process, see the javadoc for class com.whitestein.lsps.wsdl.parser.WSDLParser. This task contains following fields:

• input : RecordHolder object, the input for the webservice. This input is transformed to webservice xml request
• output : ReferenceHolder object. It is the reference where the output from the webservice call should be stored
• error : ReferenceHolder object. In case that web service respond with soap fault, the given fault is stored into this reference
• readTimeout : Number of miliseconds for read timeout. If the server doesn't respond for more than defined time, SocketTimeoutException is raised
• login : Login name to use for HTTP BASIC authentication
• password : Password to use for HTTP BASIC authentication
• logMessges : Boolean flag to indicate whether all sent and received xml messages should be logged too application log (debug purposes)
• endpointAddress : endpoint address for webservice call. If not set, default address from task metadata is used
• requestHeaders : MapHolder containing http headers (names and values) to be added to ws request
• responseHeaders : reference to MapHolder. If set, all http headers from response in MapHolder object will be set into this reference
• isSynchronous : if not null and true, task will be executed synchronously. Otherwise it will be executed asynchronously using JMS messaging to achieve it

Author:

mbj

Nested Class Summary

Nested classes/interfaces inherited from interface com.whitestein.lsps.engine.ExecutableTask

ExecutableTask.Result

Constructor Summary

Constructors

Constructor and Description
WsSoapCall()

Method Summary

Modifier and Type	Method and Description
Serializable	collectDataForExecution(TaskContext context) Collects data from task context for asynchronous execution.
protected WebServiceCaller	createWebServiceCaller()
boolean	executeAsynchronously(TaskContext context) Determines, based on current task context (params, metadata, etc.) if the exeuction should be done asynchronously.
protected WsSoapMessageBuilder	getBuilder(TaskContext context)
Class<? extends AbstractAsynchronousExecutionTask>	getImplementationClass()
protected Type	getInputType(TaskContext context)
Serializable	processDataAsynchronously(Serializable data) Process data collected in AsynchronousExecutionTask.collectDataForExecution(com.whitestein.lsps.engine.lang.TaskContext).
void	processExecutionResult(TaskContext context, Serializable data) This method is called after the asynchronous execution has been done

Methods inherited from class com.whitestein.lsps.engine.AbstractAsynchronousExecutionTask

processInput, start, terminate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.whitestein.lsps.engine.ExecutableTask

processInput, start, terminate

Constructor Detail

WsSoapCall

public WsSoapCall()

Method Detail

getBuilder

protected WsSoapMessageBuilder getBuilder(TaskContext context)
                                   throws ErrorException

Parameters:

context -

Returns:

builder to use for building soap messages

Throws:

ErrorException

collectDataForExecution

public Serializable collectDataForExecution(TaskContext context)
                                     throws ErrorException

Description copied from interface: AsynchronousExecutionTask

Collects data from task context for asynchronous execution. These data will be used to invoke AsynchronousExecutionTask.processDataAsynchronously(java.io.Serializable) method asynchronously.

Specified by:

collectDataForExecution in interface AsynchronousExecutionTask

Specified by:

collectDataForExecution in class AbstractAsynchronousExecutionTask

Returns:

data that will be used in asynchronous execution

Throws:

ErrorException

getInputType

protected Type getInputType(TaskContext context)
                     throws ErrorException

Parameters:

context -

Returns:

LSPS type of input

Throws:

ErrorException

processExecutionResult

public void processExecutionResult(TaskContext context,
                                   Serializable data)
                            throws ErrorException

Description copied from interface: AsynchronousExecutionTask

This method is called after the asynchronous execution has been done

Specified by:

processExecutionResult in interface AsynchronousExecutionTask

Specified by:

processExecutionResult in class AbstractAsynchronousExecutionTask

data - result of asynchronous call of method AsynchronousExecutionTask.processDataAsynchronously(java.io.Serializable)

Throws:

ErrorException

processDataAsynchronously

public Serializable processDataAsynchronously(Serializable data)

Description copied from interface: AsynchronousExecutionTask

Process data collected in AsynchronousExecutionTask.collectDataForExecution(com.whitestein.lsps.engine.lang.TaskContext). This execution is done asynchronously outside of process model. The result of this execution is afterwards sent back to task (AsynchronousExecutionTask.processExecutionResult(com.whitestein.lsps.engine.lang.TaskContext, java.io.Serializable)) so that the computed results can be processed and any necessary changes in model instance can be done. This method should not throw ErrorException since it is not executed in model instance context.

Specified by:

processDataAsynchronously in interface AsynchronousExecutionTask

Specified by:

processDataAsynchronously in class AbstractAsynchronousExecutionTask

Parameters:

data - data to process

Returns:

result of execution

createWebServiceCaller

protected WebServiceCaller createWebServiceCaller()

Returns:

web service caller instance to use to perform web service call.

executeAsynchronously

public boolean executeAsynchronously(TaskContext context)
                              throws ErrorException

Description copied from interface: AsynchronousExecutionTask

Determines, based on current task context (params, metadata, etc.) if the exeuction should be done asynchronously. If true, method AsynchronousExecutionTask.processDataAsynchronously(java.io.Serializable) will be executed outside model instance (thus not blocking transaction, model execution, etc.}. If false it will be called directly.

Specified by:

executeAsynchronously in interface AsynchronousExecutionTask

Specified by:

executeAsynchronously in class AbstractAsynchronousExecutionTask

Returns:

true if the execution should be performed asynchronously, false otherwise

Throws:

ErrorException

getImplementationClass

public Class<? extends AbstractAsynchronousExecutionTask> getImplementationClass()

Specified by:

getImplementationClass in class AbstractAsynchronousExecutionTask

Returns:

class of implementation. We can't use plain this.getClass() since weblogic returns the class of some weblogic specific subclass (some wrapper) and we need concrete implementation in order to look it up from ComponentService.