Interface OrchestraService

public interface OrchestraService
Public facade exposed by the installed Orchestra Paper plugin.

  • Method Details

    • registerDefinition

      void registerDefinition(EventDefinition definition)
      Registers or replaces an event definition by identifier.
      Parameters:
      definition - validated definition used by future processing

    • registerAction

      void registerAction(String type, OrchestraAction action)
      Registers a custom action type for this server session.
      Parameters:
      type - unique action type used in definitions
      action - asynchronous action implementation

    • registerCondition

      void registerCondition(String type, OrchestraCondition condition)
      Registers a custom condition type for this server session.
      Parameters:
      type - unique condition type used in definitions
      condition - asynchronous condition implementation

    • startNow

      UUID startNow(String definitionId)
      Starts a known event immediately.
      Parameters:
      definitionId - registered event identifier
      Returns:
      durable execution identifier

    • schedule

      UUID schedule(String definitionId, Instant startAt, Map<String,Object> variables)
      Creates a durable execution at the requested time with initial variables.
      Parameters:
      definitionId - registered event identifier
      startAt - requested start time
      variables - initial execution variables
      Returns:
      durable execution identifier

    • addListener

      void addListener(EventLifecycleListener listener)
      Registers a listener for persisted lifecycle transitions.
      Parameters:
      listener - transition listener retained for this server session

    • pause

      boolean pause(UUID executionId)
      Pauses an execution if its current state permits the transition.
      Parameters:
      executionId - execution identifier
      Returns:
      whether the optimistic update succeeded

    • resume

      boolean resume(UUID executionId)
      Resumes a paused execution.
      Parameters:
      executionId - execution identifier
      Returns:
      whether the optimistic update succeeded

    • cancel

      boolean cancel(UUID executionId)
      Cancels an execution if its current state permits the transition.
      Parameters:
      executionId - execution identifier
      Returns:
      whether the optimistic update succeeded

    • retry

      boolean retry(UUID executionId)
      Restarts a failed execution from its first stage.
      Parameters:
      executionId - execution identifier
      Returns:
      whether the optimistic update succeeded

    • setVariable

      boolean setVariable(UUID executionId, String key, Object value)
      Sets an execution variable, or removes it when value is null.
      Parameters:
      executionId - execution identifier
      key - variable key
      value - replacement value, or null to remove it
      Returns:
      whether the optimistic update succeeded

    • execution

      Optional<EventExecution> execution(UUID executionId)
      Returns one current execution snapshot.
      Parameters:
      executionId - execution identifier
      Returns:
      current immutable snapshot, if it exists

    • definitions

      Collection<EventDefinition> definitions()
      Returns a snapshot of all registered definitions.
      Returns:
      immutable definition snapshot

    • activeExecutions

      Collection<EventExecution> activeExecutions(int limit)
      Returns active execution snapshots up to the requested limit.
      Parameters:
      limit - maximum results
      Returns:
      immutable active execution snapshot

    • status

      OrchestraStatus status()
      Returns current platform-neutral administration status.
      Returns:
      current status snapshot