com.whitestein.lsps.wsclient.task

Class HttpClientTask

java.lang.Object

com.whitestein.lsps.engine.AbstractAsynchronousExecutionTask

com.whitestein.lsps.wsclient.task.HttpClientTask

All Implemented Interfaces:

AsynchronousExecutionTask, ExecutableTask

@PermitAll
public class HttpClientTask
extends AbstractAsynchronousExecutionTask
implements AsynchronousExecutionTask

This is the generic implementation of task for http calls. This task accept following parameters:

• httpMethod : String type of httpMethod to execute. Possible values: GET, POST, PUT, DELETE
• endpointAddress : endpoint address for the http call. Required
• request : String request payload - text that will be sent in http request
• requestContentType : String request content type
• response : ReferenceHolder object. It is the String reference where the output from the http call (response payload) will be stored
• responseCode : ReferenceHolder object. HTTP response code will be 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
• requestHeaders : MapHolder containing http headers (names and values) to be added to http request
• responseHeaders : reference to MapHolder. If set, all http headers from response in MapHolder object will be stored into this reference
• isSynchronous : if not null and true, task will be executed synchronously in the context of process. Otherwise it will be executed asynchronously outside of the process context.

Author:

mbj

Nested Class Summary

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

ExecutableTask.Result

Constructor Summary

Constructors

Constructor and Description
HttpClientTask()

Method Summary

Modifier and Type	Method and Description
Serializable	collectDataForExecution(TaskContext context) Collects data from task context for asynchronous execution.
boolean	executeAsynchronously(TaskContext context) Determines, based on current task context (params, metadata, etc.) if the exeuction should be done asynchronously.
Class<? extends AbstractAsynchronousExecutionTask>	getImplementationClass()
Serializable	processDataAsynchronously(Serializable data) Process data collected in AsynchronousExecutionTask.collectDataForExecution(com.whitestein.lsps.engine.lang.TaskContext).
void	processExecutionResult(TaskContext context, Serializable result) 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

HttpClientTask

public HttpClientTask()

Method Detail

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.

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

processExecutionResult

public void processExecutionResult(TaskContext context,
                                   Serializable result)
                            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

result - 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

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