001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel.saga;
018
019import java.util.concurrent.CompletableFuture;
020
021import org.apache.camel.Exchange;
022import org.apache.camel.spi.HasId;
023
024/**
025 * A saga coordinator can be used to register compensator's and
026 * take the final decision on the saga: compensate or complete (successfully).
027 */
028public interface CamelSagaCoordinator extends HasId {
029
030    CompletableFuture<Void> beginStep(Exchange exchange, CamelSagaStep step);
031
032    CompletableFuture<Void> compensate();
033
034    CompletableFuture<Void> complete();
035
036}