com.amazonaws.services.simpleworkflow.flow.generic

Class ActivityImplementationBase

java.lang.Object

com.amazonaws.services.simpleworkflow.flow.generic.ActivityImplementation

com.amazonaws.services.simpleworkflow.flow.generic.ActivityImplementationBase

public abstract class ActivityImplementationBase
extends ActivityImplementation

Extend this class to implement an activity. There are two types of activity implementation: synchronous and asynchronous. Synchronous ties thread that calls #execute(Map, ActivityExecutionContext) method.

Author:

fateev

See Also:

ActivityWorker

Constructor Summary

Constructors

Constructor and Description
ActivityImplementationBase()

Method Summary

Methods

Modifier and Type	Method and Description
String	execute(ActivityExecutionContext context) Execute external activity or initiate its execution if #isManualActivityCompletion() is true.
protected abstract String	execute(String input, ActivityExecutionContext context) Execute activity.
ActivityTypeExecutionOptions	getExecutionOptions()
ActivityTypeRegistrationOptions	getRegistrationOptions() By default do not register

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityImplementationBase

public ActivityImplementationBase()

Method Detail

execute

public String execute(ActivityExecutionContext context)
               throws ActivityFailureException,
                      CancellationException

Description copied from class: ActivityImplementation

Execute external activity or initiate its execution if #isManualActivityCompletion() is true.

Specified by:

execute in class ActivityImplementation

Returns:

result of activity execution if #isManualActivityCompletion() is set to false. Use ActivityWorker#respondActivityTaskCompleted(String, Map) to return result in asynchronous case.

Throws:

ActivityFailureException

CancellationException

See Also:

ActivityImplementation.execute(ActivityExecutionContext)

getExecutionOptions

public ActivityTypeExecutionOptions getExecutionOptions()

Specified by:

getExecutionOptions in class ActivityImplementation

getRegistrationOptions

public ActivityTypeRegistrationOptions getRegistrationOptions()

By default do not register

Specified by:

getRegistrationOptions in class ActivityImplementation

Returns:

null if activity registration is not required on the worker startup

execute

protected abstract String execute(String input,
             ActivityExecutionContext context)
                           throws ActivityFailureException,
                                  CancellationException

Execute activity.

Parameters:

input - activity input.

Returns:

result of activity execution

Throws:

Exception - any other exception is converted to status, reason and details using DataConverter#failureToTaskFailed(Throwable).

ActivityFailureException

CancellationException

See Also:

#isManualActivityCompletion()