com.codepoetics.fluvius.api.history.FlowEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fluvius-api Show documentation
There is a newer version: 1.10
package com.codepoetics.fluvius.api.history;

import java.util.Map;
import java.util.UUID;

/**
 * An event that has occurred during flow execution.
 *
 * @param  The type of the event's serialised data (if it has any).
 */
public abstract class FlowEvent {

  /**
   * Create an event representing the start of a step's execution.
   *
   * @param flowId The ID of the flow being executed.
   * @param stepId The step ID of the step being executed.
   * @param timestamp The time (in milliseconds since epoch) when the event occurred.
   * @param scratchpadState The state of the scratchpad at the point where the step was started.
   * @param  The type to which event data is serialised.
   * @return The constructed event.
   */
  public static  FlowEvent started(UUID flowId, UUID stepId, long timestamp, Map scratchpadState) {
    return new StepStartedEvent<>(flowId, stepId, timestamp, scratchpadState);
  }

  /**
   * Create an event representing the failure of a step's execution.
   *
   * @param flowId The ID of the flow being executed.
   * @param stepId The step ID of the step being executed.
   * @param timestamp The time (in milliseconds since epoch) when the event occurred.
   * @param reason The reason why the step failed.
   * @param  The type to which event data is serialised.
   * @return The constructed event.
   */
  public static  FlowEvent failed(UUID flowId, UUID stepId, long timestamp, T reason) {
    return new StepFailedEvent<>(flowId, stepId, timestamp, reason);
  }

  /**
   * Create an event representing the successful completion of a step's execution.
   *
   * @param flowId The ID of the flow being executed.
   * @param stepId The step ID of the step being executed.
   * @param timestamp The time (in milliseconds since epoch) when the event occurred.
   * @param result The result of executing the step.
   * @param  The type to which event data is serialised.
   * @return The constructed event.
   */
  public static  FlowEvent succeeded(UUID flowId, UUID stepId, long timestamp, T result) {
    return new StepSucceededEvent<>(flowId, stepId, timestamp, result);
  }

  private final UUID flowId;
  private final UUID stepId;
  private final long timestamp;

  protected FlowEvent(UUID flowId, UUID stepId, long timestamp) {
    this.flowId = flowId;
    this.stepId = stepId;
    this.timestamp = timestamp;
  }

  /**
   * Get the id of the flow in which the event occurred.
   * @return The id of the flow in which the event occurred.
   */
  public UUID getFlowId() {
    return flowId;
  }

  /**
   * Get the id of the flow step in which the event occurred.
   * @return The id of the flow step in which the event occurred.
   */
  public UUID getStepId() {
    return stepId;
  }

  /**
   * Get the timestamp (milliseconds since epoch) of the flow event.
   * @return The timestamp (milliseconds since epoch) of the flow event.
   */
  public long getTimestamp() {
    return timestamp;
  }

  /**
   * Translate this event to some other type using the provided event translator.
   *
   * @param translator The translator to use to translate this event.
   * @param  The target type of translation.
   * @return The translated event.
   */
  public abstract  V translate(FlowEventTranslator translator);
}