com.centurylink.mdw.workflow.activity.event

Class EventWaitActivity

java.lang.Object

com.centurylink.mdw.services.process.BaseActivity

com.centurylink.mdw.workflow.activity.DefaultActivityImpl

com.centurylink.mdw.workflow.activity.AbstractWait

com.centurylink.mdw.workflow.activity.event.EventWaitActivity

All Implemented Interfaces:

ActivityCategory, EventWaitActivity, GeneralActivity, SuspendableActivity, Category

Direct Known Subclasses:

DependenciesWaitActivity, EventCheckActivity, PauseActivity

@Tracked(value=TRACE)
 @Activity(value="Event Wait Activity",
          category=EventWaitActivity.class,
          icon="com.centurylink.mdw.base/receive.gif",
          pagelet="com.centurylink.mdw.base/eventWait.pagelet")
public class EventWaitActivity
extends AbstractWait
implements EventWaitActivity

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RECEIVED_MESSAGE_DOC_VAR

Fields inherited from class com.centurylink.mdw.services.process.BaseActivity

DISABLED, GROOVY, JAVA_EL, JAVASCRIPT, logger, OUTPUTDOCS

Constructor Summary

Constructors

Constructor and Description
EventWaitActivity()

Method Summary

Modifier and Type	Method and Description
void	execute() Method that executes the logic based on the work
protected int	getTimeoutSeconds()
java.util.List<java.lang.String[]>	getWaitEventSpecs()
protected boolean	handleCompletionCode()
protected boolean	isEventRecurring(java.lang.String completionCode)
boolean	needSuspend() The method is invoked by the engine right after the activity is executed, to determine whether to put the activity instance in waiting status.
protected void	processMessage(java.lang.String message) You should override this method to process event messages.
boolean	resume(InternalEvent eventMessageDoc) You cannot override this method.
boolean	resumeWaiting(InternalEvent eventMessageDoc) Typically you will not override this method
protected void	setActivityHoldOnExit()
protected void	setActivityWaitingOnExit()
protected void	updateSLA(int seconds) Update SLA of this

Methods inherited from class com.centurylink.mdw.workflow.activity.AbstractWait

deregisterEvents, getMessageFromEventMessage, handleEventCompletionCode, registerWaitEvents, registerWaitEvents

Methods inherited from class com.centurylink.mdw.workflow.activity.DefaultActivityImpl

execute

Methods inherited from class com.centurylink.mdw.services.process.BaseActivity

createDocument, createDocument, createDocument, createDocument, evaluateExpression, executeScript, getActivityId, getActivityInstance, getActivityInstanceId, getActivityName, getAttribute, getAttribute, getAttribute, getAttribute, getAttributes, getAttributeValue, getAttributeValueSmart, getDocument, getDocumentContent, getDocumentForUpdate, getDocumentType, getEngine, getExternalEventInstanceDetails, getLogger, getMainProcessDefinition, getMasterRequestId, getOutputDocuments, getPackage, getParameterId, getParameters, getParameterStringValue, getParameterType, getParameterValue, getPerformanceLevel, getProcessDefinition, getProcessId, getProcessInstance, getProcessInstanceId, getProcessInstanceOwner, getProcessInstanceOwnerId, getProperty, getRequiredAttribute, getRequiredVariableValue, getReturnCode, getReturnMessage, getRuntimeContext, getScriptEvaluator, getScriptExecClassName, getScriptExecutor, getValue, getValues, getValueSmart, getVariableInstance, getVariableValue, getVariableValueSmart, getWorkTransitionInstanceId, initialize, isDisabled, isLogDebugEnabled, isLogInfoEnabled, isOutputDocument, lockActivityInstance, lockProcessInstance, logdebug, logDebug, logError, logError, logexception, loginfo, logInfo, logsevere, logwarn, logWarn, prepare, setOutputDocuments, setParameterValue, setParameterValueAsDocument, setParameterValues, setProcessInstanceCompletionCode, setReturnCode, setReturnMessage, setValue, setVariableValue, setVariableValue, startTransaction, stopTransaction, translatePlaceHolder, updateDocumentContent, updateDocumentInfo, updateDocumentInfo, valueIsJavaExpression, valueIsVariable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.centurylink.mdw.activity.types.GeneralActivity

execute

Field Detail

RECEIVED_MESSAGE_DOC_VAR

public static final java.lang.String RECEIVED_MESSAGE_DOC_VAR

See Also:

Constant Field Values

Constructor Detail

EventWaitActivity

public EventWaitActivity()

Method Detail

execute

public void execute()
             throws ActivityException

Method that executes the logic based on the work

Specified by:

execute in interface GeneralActivity

Overrides:

execute in class DefaultActivityImpl

Throws:

ActivityException

isEventRecurring

protected boolean isEventRecurring(java.lang.String completionCode)

getTimeoutSeconds

protected int getTimeoutSeconds()
                         throws PropertyException

Throws:

PropertyException

getWaitEventSpecs

public java.util.List<java.lang.String[]> getWaitEventSpecs()

Overrides:

getWaitEventSpecs in class AbstractWait

Returns:

a table of event specifications

needSuspend

public boolean needSuspend()

Description copied from interface: SuspendableActivity

The method is invoked by the engine right after the activity is executed, to determine whether to put the activity instance in waiting status. Not all suspendible activities need to be suspended. For example, asynchronous process invocation, event wait when the event is already arrived, etc.

Specified by:

needSuspend in interface SuspendableActivity

Overrides:

needSuspend in class AbstractWait

Returns:

true if the activity instance really needs to be suspended (put in WAITING status).

resume

public final boolean resume(InternalEvent eventMessageDoc)
                     throws ActivityException

You cannot override this method. Override processMessage(String) or handleCompletionCode() instead. This method is called when the message is received after registration. It extracts the message, records the message in ADAPTER_INSTANCE table, and invoke processMessage(String).

Specified by:

resume in interface SuspendableActivity

Overrides:

resume in class AbstractWait

Returns:

true normally, false when the activity need to be put back in waiting status

Throws:

ActivityException

processMessage

protected void processMessage(java.lang.String message)

You should override this method to process event messages. The default method does nothing if Received Message Variable is not defined and returns WorkStatus.STATUS_COMPLETED. If Received Message Variable is defined then it would store the received message in that pre-defined document variable Process Designer has to define a Document type variable in order to store the message received When the method returns WorkStatus.STATUS_COMPLETED, the engine will complete the activity and move on. By default, the transition is determined based on null completion code and FINISH event type. You can change the completion code by using the method this.setReturnCode(). You can also change the event type from FINISH to ABORT, CORRECT and DELAY, by prepending the completion code with "ABORT:", "CORRECT:" and "DELAY:", respectively. Examples are "ABORT:my-return-code" and "CORRECT:". You can leave the activity in a status other than WorkStatus.STATUS_COMPLETED by returning a different status code. If WorkStatus.STATUS_WAITING is returned, your overridden method needs to re-register the events to be waited on. The work flow does not transition away and the completion code is ignored. You can also return WorkStatus.STATUS_HOLD or return WorkStatus.STATUS_CANCELLED.

Parameters:

message - received message

handleCompletionCode

protected boolean handleCompletionCode()
                                throws ActivityException

Throws:

ActivityException

resumeWaiting

public boolean resumeWaiting(InternalEvent eventMessageDoc)
                      throws ActivityException

Typically you will not override this method

Specified by:

resumeWaiting in interface SuspendableActivity

Throws:

ActivityException

setActivityWaitingOnExit

protected final void setActivityWaitingOnExit()

setActivityHoldOnExit

protected final void setActivityHoldOnExit()

updateSLA

protected void updateSLA(int seconds)
                  throws ActivityException

Update SLA of this

Parameters:

seconds - number of seconds from now as the new SLA

Throws:

ActivityException - ActivityException