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.spi;
018
019import java.util.List;
020
021import org.apache.camel.Consumer;
022import org.apache.camel.Route;
023import org.apache.camel.Service;
024
025/**
026 * Information about a route to be started where we want to control the order
027 * in which they are started by {@link org.apache.camel.CamelContext}.
028 */
029public interface RouteStartupOrder {
030
031    /**
032     * Get the order this route should be started.
033     * <p/>
034     * See more at <a href="http://camel.apache.org/configuring-route-startup-ordering-and-autostartup.html">
035     * configuring route startup ordering</a>.
036     *
037     * @return the order
038     */
039    int getStartupOrder();
040
041    /**
042     * Gets the route
043     *
044     * @return the route
045     */
046    Route getRoute();
047
048    /**
049     * Gets the input to this route (often only one consumer)
050     *
051     * @return the input consumers.
052     */
053    List<Consumer> getInputs();
054
055    /**
056     * Gets the services to this route.
057     *
058     * @return the services.
059     */
060    List<Service> getServices();
061
062}