org.apache.camel.support.RoutePolicySupport Maven / Gradle / Ivy
/*
* 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.support;
import java.util.concurrent.TimeUnit;
import org.apache.camel.Consumer;
import org.apache.camel.Exchange;
import org.apache.camel.Route;
import org.apache.camel.spi.ExceptionHandler;
import org.apache.camel.spi.RouteController;
import org.apache.camel.spi.RoutePolicy;
import org.apache.camel.support.service.ServiceHelper;
import org.apache.camel.support.service.ServiceSupport;
/**
* A base class for developing custom {@link RoutePolicy} implementations.
*/
public abstract class RoutePolicySupport extends ServiceSupport implements RoutePolicy {
private ExceptionHandler exceptionHandler;
@Override
public void onInit(Route route) {
if (exceptionHandler == null) {
exceptionHandler = new LoggingExceptionHandler(route.getCamelContext(), getClass());
}
}
@Override
public void onRemove(Route route) {
// noop
}
@Override
public void onStart(Route route) {
// noop
}
@Override
public void onStop(Route route) {
// noop
}
@Override
public void onSuspend(Route route) {
// noop
}
@Override
public void onResume(Route route) {
// noop
}
@Override
public void onExchangeBegin(Route route, Exchange exchange) {
// noop
}
@Override
public void onExchangeDone(Route route, Exchange exchange) {
// noop
}
/**
* Starts the consumer.
*
* @return the returned value is always true and should not be used.
* @see #resumeOrStartConsumer(Consumer)
*/
public void startConsumer(Consumer consumer) throws Exception {
ServiceHelper.startService(consumer);
log.debug("Started consumer {}", consumer);
}
/**
* Stops the consumer.
*
* @return the returned value is always true and should not be used.
* @see #suspendOrStopConsumer(Consumer)
*/
public void stopConsumer(Consumer consumer) throws Exception {
// stop and shutdown
ServiceHelper.stopAndShutdownServices(consumer);
log.debug("Stopped consumer {}", consumer);
}
/**
* Suspends or stops the consumer.
*
* If the consumer is {@link org.apache.camel.Suspendable} then the consumer is suspended,
* otherwise the consumer is stopped.
*
* @see #stopConsumer(Consumer)
* @return true if the consumer was suspended or stopped, false if the consumer was already suspend or stopped
*/
public boolean suspendOrStopConsumer(Consumer consumer) throws Exception {
boolean suspended = ServiceHelper.suspendService(consumer);
if (suspended) {
log.debug("Suspended consumer {}", consumer);
} else {
log.trace("Consumer already suspended {}", consumer);
}
return suspended;
}
/**
* Resumes or starts the consumer.
*
* If the consumer is {@link org.apache.camel.Suspendable} then the consumer is resumed,
* otherwise the consumer is started.
*
* @see #startConsumer(Consumer)
* @return true if the consumer was resumed or started, false if the consumer was already resumed or started
*/
public boolean resumeOrStartConsumer(Consumer consumer) throws Exception {
boolean resumed = ServiceHelper.resumeService(consumer);
if (resumed) {
log.debug("Resumed consumer {}", consumer);
} else {
log.trace("Consumer already resumed {}", consumer);
}
return resumed;
}
public void startRoute(Route route) throws Exception {
controller(route).startRoute(route.getId());
}
public void resumeRoute(Route route) throws Exception {
controller(route).resumeRoute(route.getId());
}
public void suspendRoute(Route route) throws Exception {
controller(route).suspendRoute(route.getId());
}
public void suspendRoute(Route route, long timeout, TimeUnit timeUnit) throws Exception {
controller(route).suspendRoute(route.getId(), timeout, timeUnit);
}
/**
* @see #stopRouteAsync(Route)
*/
public void stopRoute(Route route) throws Exception {
controller(route).stopRoute(route.getId());
}
/**
* @see #stopRouteAsync(Route)
*/
public void stopRoute(Route route, long timeout, TimeUnit timeUnit) throws Exception {
controller(route).stopRoute(route.getId(), timeout, timeUnit);
}
/**
* Allows to stop a route asynchronously using a separate background thread which can allow any current in-flight exchange
* to complete while the route is being shutdown.
* You may attempt to stop a route from processing an exchange which would be in-flight and therefore attempting to stop
* the route will defer due there is an inflight exchange in-progress. By stopping the route independently using a separate
* thread ensures the exchange can continue process and complete and the route can be stopped.
*/
public void stopRouteAsync(final Route route) {
String threadId = route.getCamelContext().getExecutorServiceManager().resolveThreadName("StopRouteAsync");
Runnable task = () -> {
try {
controller(route).stopRoute(route.getId());
} catch (Exception e) {
handleException(e);
}
};
new Thread(task, threadId).start();
}
protected RouteController controller(Route route) {
return route.getCamelContext().getRouteController();
}
/**
* Handles the given exception using the {@link #getExceptionHandler()}
*
* @param t the exception to handle
*/
protected void handleException(Throwable t) {
if (exceptionHandler != null) {
exceptionHandler.handleException(t);
}
}
@Override
protected void doStart() throws Exception {
// noop
}
@Override
protected void doStop() throws Exception {
// noop
}
public ExceptionHandler getExceptionHandler() {
return exceptionHandler;
}
public void setExceptionHandler(ExceptionHandler exceptionHandler) {
this.exceptionHandler = exceptionHandler;
}
}