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     */
017    package org.apache.camel;
018    
019    import javax.xml.bind.annotation.XmlEnum;
020    import javax.xml.bind.annotation.XmlType;
021    
022    /**
023     * Represents the options available when shutting down routes.
024     * <p/>
025     * Is used for example to defer shutting down a route until all inflight exchanges have
026     * been completed, after which the route can be shutdown safely.
027     * <p/>
028     * This allows fine grained configuration in accomplishing graceful shutdown where you
029     * have for example some internal route which other routes are dependent upon.
030     * <ul>
031     *   <li>Default - The <b>default</b> behavior where a route will attempt to shutdown now</li>
032     *   <li>Defer - Will defer shutting down the route and let it be active during graceful shutdown.
033     *               The route will be shutdown at a later stage during the graceful shutdown process.</li>
034     * </ul>
035     */
036    @XmlType
037    @XmlEnum(String.class)
038    public enum ShutdownRoute {
039    
040        Default, Defer
041    
042    }