org.apache.camel.ShutdownableService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of camel-core Show documentation

The Core Camel Java DSL based router

There is a newer version: 4.6.0

/**
 * 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;

/**
 * A {@link org.apache.camel.Service} which is capable of being shut down.
 * 
 * This is useful for services which need more fine grained control when the {@link CamelContext} is shutting down.
 * This allows customization of behavior when stopping or shutting down.
 * 
 * For example to shutdown thread pools during shutdown and not at CamelContext termination.
 *
 * @version 
 */
public interface ShutdownableService extends Service {

    /**
     * Shutdown the service, which means it cannot be started again.
     *
     * @throws Exception thrown if shutting down failed
     */
    void shutdown() throws Exception;

}