Package ch.ivyteam.ivy.process.extension.impl

Class AbstractUserAsynchronousProcessExtension

java.lang.Object

ch.ivyteam.ivy.process.extension.impl.AbstractProcessExtension

ch.ivyteam.ivy.process.extension.impl.AbstractUserAsynchronousProcessExtension

All Implemented Interfaces:

IProcessExtension, IUserAsynchronousProcessExtension

Direct Known Subclasses:

Wait

public abstract class AbstractUserAsynchronousProcessExtension
extends AbstractProcessExtension
implements IUserAsynchronousProcessExtension

Abstract base class that implements the IUserAsynchronousProcessExtension interface. Users can extends this interface to implement their process extension bean classes. This class provides a lot of useful methods that can be used to implement the IUserAsynchronousProcessExtension.performRequest(IRequestId, CompositeObject, IIvyScriptContext) method.

Since:

06.08.2009

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
protected String	generateGlobalUniqueEventIdentifier()	Generates a global unique event identifier
UserAsynchronousProcessExtensionResult	performRequest(IRequestId requestId, CompositeObject in, IIvyScriptContext context)	This method is the program performed in an asynchronous process extension element every time a token comes to the process element (request).

Methods inherited from class ch.ivyteam.ivy.process.extension.impl.AbstractProcessExtension

abort, createOwnContext, declareAndInitializeVariable, declareVariable, executeAsSystem, executeIvyScript, executeIvyScript, getAdditionalLogInfo, getCase, getConfiguration, getConfigurationProperty, getConfigurationPropertyNames, getContentManagementSystem, getExtensions, getLog, getProcessDataField, getProcessElementIdentifier, getRequest, getResponse, getServerExtension, getSession, getTask, getWf, parseIvyScript, release, setConfiguration, setProcessDataField, setVariableValue, start, stop

Methods inherited from interface ch.ivyteam.ivy.process.extension.IProcessExtension

abort, getAdditionalLogInfo, release, setConfiguration, start, stop

Method Detail

performRequest

public UserAsynchronousProcessExtensionResult performRequest(IRequestId requestId,
                                                             CompositeObject in,
                                                             IIvyScriptContext context)
                                                      throws Exception

Description copied from interface: IUserAsynchronousProcessExtension

This method is the program performed in an asynchronous process extension element every time a token comes to the process element (request). Note that more than one thread can call this method parallel if more than one request are running through the process extension element. Therefore the bean must be aware of multithreading.

Specified by:

performRequest in interface IUserAsynchronousProcessExtension

Parameters:

requestId - the identifier of the request

in - the current process data. Modify this process data in your implementation

context - the context to use to perform the request

Returns:

the process data that are reinjected to the process. Most implementation simple return the in object

Throws:

Exception - if perform fails

API:

This public API is available in Java.

generateGlobalUniqueEventIdentifier

protected String generateGlobalUniqueEventIdentifier()

Generates a global unique event identifier

Returns:

global unique event identifier

API:

This public API is available in Java.