org.jitterbit.connector.sdk

Interface JitterbitActivity

All Superinterfaces:

Discoverable

public interface JitterbitActivity
extends Discoverable

A Jitterbit Activity is a unit of work that has a role of discovery (configuration) and execution.

An activity includes both:

• Discovery/configuration: The discovery of metadata associated with an activity.
• Execution: A unit of execution is part of a workflow chain of operations.

To register an activity as part of a connector, annotate the activity implementation with Activity.

During the runtime, the workflow process will invoke the activity by invoking the execute(ExecutionContext) method.

The execution context contains information about the request (if present) and the payload. The activity is responsible for setting the response payload (using JitterbitActivity.ExecutionContext.getResponsePayload(), which will be handed to the next activity within the workflow chain of operations by the process operation engine.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JitterbitActivity.ActivityStatus
static interface	JitterbitActivity.ExecutionContext The context in which an activity is executed.
static interface	JitterbitActivity.Factory A factory that creates an instance of a JitterbitActivity.
static class	JitterbitActivity.LifecycleOperation The possible stages of the lifecycle of an operation.
static class	JitterbitActivity.State The possible states of an activity.
static class	JitterbitActivity.Status

Nested classes/interfaces inherited from interface org.jitterbit.connector.sdk.Discoverable

Discoverable.DiscoverContextRequest<T>, Discoverable.DiscoveryException

Method Summary

Modifier and Type	Method and Description
void	execute(JitterbitActivity.ExecutionContext context) Executes an activity.
String	getName() Returns the name of the activity, unique within the context of the connector.
void	onDeploy(DeployedEntity deployedEntity) Invoked when an activity receives a deploy event request.
void	onStart() Invoked when an activity receives a start event request.
void	onStop() Invoked when an activity receives a stop event request.
void	onUnDeploy(DeployedEntity deployedEntity) Invoked when an activity receives an undeploy event request.
JitterbitActivity.State	state() Returns the state of this activity.

Methods inherited from interface org.jitterbit.connector.sdk.Discoverable

getActivityRequestResponseMetadata, getObjectList, getObjectSchema, invokeAction

Method Detail

getName

String getName()

Returns the name of the activity, unique within the context of the connector.

Returns:

the name of the activity

execute

void execute(JitterbitActivity.ExecutionContext context)
      throws ActivityExecutionException

Executes an activity. The JitterbitActivity.ExecutionContext contains the configuration parameters associated with the activity and the activity response that needs to be returned as part of JitterbitActivity.ExecutionContext.getResponsePayload().

Parameters:

context - the execution context

Throws:

ActivityExecutionException - if there is an exception during execution of the activity

onStart

void onStart()
      throws LifecycleActivityException

Invoked when an activity receives a start event request.

Throws:

LifecycleActivityException - if there is an exception during execution

onStop

void onStop()
     throws LifecycleActivityException

Invoked when an activity receives a stop event request.

Throws:

LifecycleActivityException - if there is an exception during execution

onDeploy

void onDeploy(DeployedEntity deployedEntity)
       throws LifecycleActivityException

Invoked when an activity receives a deploy event request. A deploy event means either a new project is being deployed or an existing project is being updated.

Parameters:

deployedEntity - the deployed entity

Throws:

LifecycleActivityException - if there is an exception during execution

onUnDeploy

void onUnDeploy(DeployedEntity deployedEntity)
         throws LifecycleActivityException

Invoked when an activity receives an undeploy event request. This occurs when a deployed entity is removed from a project or a project has been deleted.

Parameters:

deployedEntity - the deployed entity

Throws:

LifecycleActivityException - if there is an exception during execution

state

JitterbitActivity.State state()

Returns the state of this activity.

Returns:

the state of this activity