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 { 034 035 String ID_PROPERTY = "id"; 036 String PARENT_PROPERTY = "parent"; 037 String GROUP_PROPERTY = "group"; 038 039 /** 040 * Gets the route id 041 * 042 * @return the route id 043 */ 044 String getId(); 045 046 /** 047 * Gets the inbound endpoint 048 * 049 * @return the inbound endpoint 050 */ 051 Endpoint getEndpoint(); 052 053 /** 054 * Gets the inbound {@link Consumer} 055 * 056 * @return the inbound consumer 057 */ 058 Consumer getConsumer(); 059 060 /** 061 * Whether or not the route supports suspension (suspend and resume) 062 * 063 * @return <tt>true</tt> if this route supports suspension 064 */ 065 boolean supportsSuspension(); 066 067 /** 068 * This property map is used to associate information about the route. 069 * 070 * @return properties 071 */ 072 Map<String, Object> getProperties(); 073 074 /** 075 * Gets the route context 076 * 077 * @return the route context 078 */ 079 RouteContext getRouteContext(); 080 081 /** 082 * A strategy callback allowing special initialization when services are starting. 083 * 084 * @param services the service 085 * @throws Exception is thrown in case of error 086 */ 087 void onStartingServices(List<Service> services) throws Exception; 088 089 /** 090 * Returns the services for this particular route 091 * 092 * @return the services 093 */ 094 List<Service> getServices(); 095 096 /** 097 * Adds a service to this route 098 * 099 * @param service the service 100 */ 101 void addService(Service service); 102 103 /** 104 * Returns a navigator to navigate this route by navigating all the {@link Processor}s. 105 * 106 * @return a navigator for {@link Processor}. 107 */ 108 Navigate<Processor> navigate(); 109 110 /** 111 * Callback preparing the route to be started, by warming up the route. 112 */ 113 void warmUp(); 114 115}