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