org.apache.camel.spi.ExtendedRoutesBuilderLoader Maven / Gradle / Ivy

Go to download
/*
 * 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 org.apache.camel.RoutesBuilder;

/**
 * An extended {@link RoutesBuilderLoader} that is capable of loading from multiple resources in one unit (such as
 * compiling them together).
 */
public interface ExtendedRoutesBuilderLoader extends RoutesBuilderLoader {

    /**
     * Loads {@link RoutesBuilder} from multiple {@link Resource}s.
     *
     * @param  resources the resources to be loaded.
     * @return           a set of loaded {@link RoutesBuilder}s
     */
    Collection loadRoutesBuilders(Collection resources) throws Exception;

    String getCompileDirectory();

    /**
     * Directory to use for saving runtime compiled Camel routes to class files, when using camel-java-joor-dsl as Java
     * DSL (such as when using Camel K with Java source routes). Camel will compile to in-memory only by default.
     * Specifying this option, allows Camel to persist the compiled class to disk. And when starting the application
     * again the routes are loaded from the pre-compiled class files instead of re-compiling again.
     */
    void setCompileDirectory(String compileDirectory);

    boolean isCompileLoadFirst();

    /**
     * Whether to load preexisting compiled Camel routes class files, when using camel-java-joor-dsl as Java DSL (such
     * as when using Camel K with Java source routes).
     *
     * If enabled then Camel will look in the routes compile directory if a compiled Java route already exists and load
     * its bytecode instead of runtime compiling from its java source file.
     */
    void setCompileLoadFirst(boolean compileLoadFirst);

}