platforms/commands/commands-core/src/main/java/org/apache/camel/commands/LocalCamelController.java

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

import java.util.List;

import org.apache.camel.CamelContext;

/**
 * A {@link org.apache.camel.commands.CamelController} that runs locally, eg within the same JVM as the {@link CamelContext}s
 * it manages.
 *
 * For example the Apache Camel Karaf commands does this.
 */
public interface LocalCamelController extends CamelController {

    /**
     * Get the list of Camel context.
     *
     * @return the list of Camel contexts.
     * @throws Exception can be thrown
     */
    List<CamelContext> getLocalCamelContexts() throws Exception;

    /**
     * Get a Camel context identified by the given name.
     *
     * @param name the Camel context name.
     * @return the Camel context or null if not found.
     * @throws Exception can be thrown
     */
    CamelContext getLocalCamelContext(String name) throws Exception;
}