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.model;
018
019import javax.xml.bind.annotation.XmlEnum;
020import javax.xml.bind.annotation.XmlType;
021
022/**
023 * Enumerates all saga propagation modes.
024 */
025@XmlType
026@XmlEnum
027public enum SagaPropagation {
028
029    /**
030     * Join the existing saga or create a new one if it does not exist.
031     */
032    REQUIRED,
033
034    /**
035     * Always create a new saga. Suspend the old saga and resume it when the new
036     * one terminates.
037     */
038    REQUIRES_NEW,
039
040    /**
041     * A saga must be already present. The existing saga is joined.
042     */
043    MANDATORY,
044
045    /**
046     * If a saga already exists, then join it.
047     */
048    SUPPORTS,
049
050    /**
051     * If a saga already exists, it is suspended and resumed when the current
052     * block completes.
053     */
054    NOT_SUPPORTED,
055
056    /**
057     * The current block must never be invoked within a saga.
058     */
059    NEVER
060
061}