com.microsoft.durabletask.OrchestratorBlockedException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of durabletask-client Show documentation

This package contains classes and interfaces for building Durable Task orchestrations in Java.

There is a newer version: 1.5.0

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.microsoft.durabletask;

/**
 * Control flow {@code Throwable} class for orchestrator functions. This {@code Throwable} must never be caught by user
 * code.
 * 
 * {@code OrchestratorBlockedException} is thrown when an orchestrator calls {@link Task#await} on an uncompleted task. The
 * purpose of throwing in this way is to halt execution of the orchestrator to save the current state and commit any
 * side effects. Catching {@code OrchestratorBlockedException} in user code could prevent the orchestration from saving
 * state and scheduling new tasks, resulting in the orchestration getting stuck.
 */
public final class OrchestratorBlockedException extends RuntimeException {
    OrchestratorBlockedException(String message) {
        super(message);
    }
}