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;
018
019import java.util.List;
020import java.util.Map;
021
022import org.apache.camel.spi.RouteContext;
023
024/**
025 * A <a href="http://camel.apache.org/routes.html">Route</a>
026 * defines the processing used on an inbound message exchange
027 * from a specific {@link org.apache.camel.Endpoint} within a {@link org.apache.camel.CamelContext}.
028 * <p/>
029 * Use the API from {@link org.apache.camel.CamelContext} to control the lifecycle of a route,
030 * such as starting and stopping using the {@link org.apache.camel.CamelContext#startRoute(String)}
031 * and {@link org.apache.camel.CamelContext#stopRoute(String)} methods.
032 */
033public interface Route extends EndpointAware {
034
035    String ID_PROPERTY = "id";
036    String PARENT_PROPERTY = "parent";
037    String GROUP_PROPERTY = "group";
038    String REST_PROPERTY = "rest";
039    String DESCRIPTION_PROPERTY = "description";
040
041    /**
042     * Gets the route id
043     *
044     * @return the route id
045     */
046    String getId();
047
048    /**
049     * Gets the inbound {@link Consumer}
050     *
051     * @return the inbound consumer
052     */
053    Consumer getConsumer();
054
055    /**
056     * Whether or not the route supports suspension (suspend and resume)
057     *
058     * @return <tt>true</tt> if this route supports suspension
059     */
060    boolean supportsSuspension();
061
062    /**
063     * This property map is used to associate information about the route.
064     *
065     * @return properties
066     */
067    Map<String, Object> getProperties();
068
069    /**
070     * Gets the route description (if any has been configured).
071     * <p/>
072     * The description is configured using the {@link #DESCRIPTION_PROPERTY} as key in the {@link #getProperties()}.
073     *
074     * @return the description, or <tt>null</tt> if no description has been configured.
075     */
076    String getDescription();
077
078    /**
079     * Gets the route context
080     *
081     * @return the route context
082     */
083    RouteContext getRouteContext();
084
085    /**
086     * A strategy callback allowing special initialization when services are starting.
087     *
088     * @param services the service
089     * @throws Exception is thrown in case of error
090     */
091    void onStartingServices(List<Service> services) throws Exception;
092
093    /**
094     * Returns the services for this particular route
095     *
096     * @return the services
097     */
098    List<Service> getServices();
099
100    /**
101     * Adds a service to this route
102     *
103     * @param service the service
104     */
105    void addService(Service service);
106
107    /**
108     * Returns a navigator to navigate this route by navigating all the {@link Processor}s.
109     *
110     * @return a navigator for {@link Processor}.
111     */
112    Navigate<Processor> navigate();
113
114    /**
115     * Callback preparing the route to be started, by warming up the route.
116     */
117    void warmUp();
118
119}