Class ActivatorEvent

java.lang.Object

org.efs.activator.event.ActivatorEvent

All Implemented Interfaces:

IEfsEvent

public final class ActivatorEvent
extends Object
implements IEfsEvent

As EfsActivator steps through its workflow, its publishes two ActivatorEvents for each step:

1. An in-progress transition with a zero transition duration.
2. Either a successful completion or failed completion. If failed, then contains exception causing the failure. In both cases, transition execution time is provided.

An activator event contains the following fields:

• Unique name of agent being transition from a begin state to end state.
• Name of workflow step being performed.
• Defines workflow step state: in-progress, completed successfully, and completed but failed.
• Agent transition initial state.
• Agent transition target final state.
• Agent transition duration. Will be zero for an in-progress step.
• Exception associated with a failed agent transition.

An agent wishing to receive activator events should register with the activator executing the workflows.

Author:

Charles W. Rapp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ActivatorEvent.Builder	Builder class used to create an activator event.
static enum	ActivatorEvent.StepState	Workflow step states are in-progress, completed (success), and completed (failed).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NO_MESSAGE	Exception did not contain a message.
static final String	NULL_STATE	Common failure reason.

Method Summary

Modifier and Type	Method	Description
static ActivatorEvent.Builder	builder()	Returns a new activator event builder instance.
boolean	equals(Object o)	Returns true if o is a non-null ActivorEvent instance whose agent name, step name, step state, initial and final states are equal.
String	getAgentName()	Returns efs agent name.
Duration	getDuration()	Returns allowed transition time.
Throwable	getException()	Returns optional getException associated with a failed step.
EfsAgentState	getFinalState()	Returns target agent final state.
EfsAgentState	getInitialState()	Returns agent initial state.
String	getStepName()	Returns workflow step name.
ActivatorEvent.StepState	getStepState()	Returns workflow step's state.
int	hashCode()	Activator event hash code based on unique agent name, workflow step name, workflow step state, agent current state, and agent target final state.
String	toString()	Returns a single text line containing agent name, initial state, and final state.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NO_MESSAGE

public static final String NO_MESSAGE

Exception did not contain a message.

See Also:

• Constant Field Values

NULL_STATE

public static final String NULL_STATE

Common failure reason.

See Also:

• Constant Field Values

Method Details

equals

public boolean equals(Object o)

Returns true if o is a non-null ActivorEvent instance whose agent name, step name, step state, initial and final states are equal. This method ignores the duration and optional exception associated with the event.

This equals implementation is designed to facilitate units tests only.

Overrides:

equals in class Object

Parameters:

o - comparison object.

Returns:

true if this ActivatorEvent equals o and false otherwise.

hashCode

public int hashCode()

Activator event hash code based on unique agent name, workflow step name, workflow step state, agent current state, and agent target final state.

Overrides:

hashCode in class Object

Returns:

integer hash value for this activator event.

toString

public String toString()

Returns a single text line containing agent name, initial state, and final state.

Overrides:

toString in class Object

Returns:

activator event as text.

getAgentName

public String getAgentName()

Returns efs agent name.

Returns:

agent name.

getStepName

public String getStepName()

Returns workflow step name.

Returns:

workflow step name.

getStepState

public ActivatorEvent.StepState getStepState()

Returns workflow step's state.

Returns:

workflow step state.

getInitialState

public EfsAgentState getInitialState()

Returns agent initial state.

Returns:

agent initial state.

getFinalState

public EfsAgentState getFinalState()

Returns target agent final state.

Returns:

agent final state.

getDuration

public Duration getDuration()

Returns allowed transition time.

Returns:

allowed transition time.

getException

@Nullable
public Throwable getException()

Returns optional getException associated with a failed step.

Returns:

getException associated with failed step.

builder

public static ActivatorEvent.Builder builder()

Returns a new activator event builder instance.

Returns:

new activator event builder.