org.apache.camel.model.ModelCamelContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-core Show documentation
Show all versions of camel-core Show documentation
The Core Camel Java DSL based router
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.model;
import java.io.InputStream;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.apache.camel.CamelContext;
import org.apache.camel.model.rest.RestDefinition;
import org.apache.camel.model.rest.RestsDefinition;
/**
* Model level interface for the {@link CamelContext}
*/
public interface ModelCamelContext extends CamelContext {
/**
* Returns a list of the current route definitions
*
* @return list of the current route definitions
*/
List getRouteDefinitions();
/**
* Gets the route definition with the given id
*
* @param id id of the route
* @return the route definition or null if not found
*/
RouteDefinition getRouteDefinition(String id);
/**
* Loads a collection of route definitions from the given {@link java.io.InputStream}.
*
* @param is input stream with the route(s) definition to add
* @return the route definitions
* @throws Exception if the route definitions could not be loaded for whatever reason
*/
RoutesDefinition loadRoutesDefinition(InputStream is) throws Exception;
/**
* Loads a collection of rest definitions from the given {@link java.io.InputStream}.
*
* @param is input stream with the rest(s) definition to add
* @return the rest definitions
* @throws Exception if the rest definitions could not be loaded for whatever reason
*/
RestsDefinition loadRestsDefinition(InputStream is) throws Exception;
/**
* Adds a collection of route definitions to the context
*
* Important: Each route in the same {@link org.apache.camel.CamelContext} must have an unique route id.
* If you use the API from {@link org.apache.camel.CamelContext} or {@link org.apache.camel.model.ModelCamelContext} to add routes, then any
* new routes which has a route id that matches an old route, then the old route is replaced by the new route.
*
* @param routeDefinitions the route(s) definition to add
* @throws Exception if the route definitions could not be created for whatever reason
*/
void addRouteDefinitions(Collection routeDefinitions) throws Exception;
/**
* Add a route definition to the context
*
* Important: Each route in the same {@link org.apache.camel.CamelContext} must have an unique route id.
* If you use the API from {@link org.apache.camel.CamelContext} or {@link org.apache.camel.model.ModelCamelContext} to add routes, then any
* new routes which has a route id that matches an old route, then the old route is replaced by the new route.
*
* @param routeDefinition the route definition to add
* @throws Exception if the route definition could not be created for whatever reason
*/
void addRouteDefinition(RouteDefinition routeDefinition) throws Exception;
/**
* Removes a collection of route definitions from the context - stopping any previously running
* routes if any of them are actively running
*
* @param routeDefinitions route(s) definitions to remove
* @throws Exception if the route definitions could not be removed for whatever reason
*/
void removeRouteDefinitions(Collection routeDefinitions) throws Exception;
/**
* Removes a route definition from the context - stopping any previously running
* routes if any of them are actively running
*
* @param routeDefinition route definition to remove
* @throws Exception if the route definition could not be removed for whatever reason
*/
void removeRouteDefinition(RouteDefinition routeDefinition) throws Exception;
/**
* Returns a list of the current REST definitions
*
* @return list of the current REST definitions
*/
List getRestDefinitions();
/**
* Adds a collection of rest definitions to the context
*
* @param restDefinitions the rest(s) definition to add
* @throws Exception if the rest definitions could not be created for whatever reason
*/
void addRestDefinitions(Collection restDefinitions) throws Exception;
/**
* Starts the given route if it has been previously stopped
*
* @param route the route to start
* @throws Exception is thrown if the route could not be started for whatever reason
* @deprecated favor using {@link CamelContext#startRoute(String)}
*/
@Deprecated
void startRoute(RouteDefinition route) throws Exception;
/**
* Stops the given route.
*
* @param route the route to stop
* @throws Exception is thrown if the route could not be stopped for whatever reason
* @deprecated favor using {@link CamelContext#stopRoute(String)}
*/
@Deprecated
void stopRoute(RouteDefinition route) throws Exception;
/**
* Sets the data formats that can be referenced in the routes.
*
* @param dataFormats the data formats
*/
void setDataFormats(Map dataFormats);
/**
* Gets the data formats that can be referenced in the routes.
*
* @return the data formats available
*/
Map getDataFormats();
/**
* Resolve a data format definition given its name
*
* @param name the data format definition name or a reference to it in the {@link org.apache.camel.spi.Registry}
* @return the resolved data format definition, or null if not found
*/
DataFormatDefinition resolveDataFormatDefinition(String name);
}