org.apache.camel.spi.RouteController 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.spi;
import java.util.Collection;
import java.util.concurrent.TimeUnit;
import org.apache.camel.CamelContextAware;
import org.apache.camel.Experimental;
import org.apache.camel.Route;
import org.apache.camel.Service;
// TODO: Add javadoc
@Experimental
public interface RouteController extends CamelContextAware, Service {
/**
* Return the list of routes controlled by this controller.
*
* @return the list of controlled routes
*/
Collection getControlledRoutes();
void startRoute(String routeId) throws Exception;
void stopRoute(String routeId) throws Exception;
void stopRoute(String routeId, long timeout, TimeUnit timeUnit) throws Exception;
boolean stopRoute(String routeId, long timeout, TimeUnit timeUnit, boolean abortAfterTimeout) throws Exception;
void suspendRoute(String routeId) throws Exception;
void suspendRoute(String routeId, long timeout, TimeUnit timeUnit) throws Exception;
void resumeRoute(String routeId) throws Exception;
/**
* Access the underlying concrete RouteController implementation.
*
* @param clazz the proprietary class or interface of the underlying concrete RouteController.
* @return an instance of the underlying concrete RouteController as the required type.
*/
default T unwrap(Class clazz) {
if (RouteController.class.isAssignableFrom(clazz)) {
return clazz.cast(this);
}
throw new IllegalArgumentException(
"Unable to unwrap this RouteController type (" + getClass() + ") to the required type (" + clazz + ")"
);
}
}