camel-k-runtime-core/src/main/java/org/apache/camel/k/Runtime.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.k;

import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import java.util.stream.Collectors;

import org.apache.camel.CamelContext;
import org.apache.camel.Ordered;
import org.apache.camel.RoutesBuilder;
import org.apache.camel.RuntimeCamelException;
import org.apache.camel.spi.HasCamelContext;
import org.apache.camel.spi.Registry;

import static org.apache.camel.util.CollectionHelper.mapOf;

public interface Runtime extends HasCamelContext {

    default <T extends CamelContext> T getCamelContext(Class<T> type) {
        return getCamelContext().adapt(type);
    }

    /**
     * Returns the registry associated to this runtime.
     */
    default Registry getRegistry() {
        return getCamelContext().getRegistry();
    }

    default void setInitialProperties(Properties properties) {
        getCamelContext().getPropertiesComponent().setInitialProperties(properties);
    }

    default void setInitialProperties(Map<String, String> properties) {
        Properties p = new Properties();
        p.putAll(properties);

        setInitialProperties(p);
    }

    default void setInitialProperties(String key, String value, String... keyVals) {
        setInitialProperties(
            mapOf(HashMap::new, key, value, keyVals)
        );
    }

    default void setProperties(Properties properties) {
        getCamelContext().getPropertiesComponent().setOverrideProperties(properties);
    }

    default void setProperties(Map<String, String> properties) {
        Properties p = new Properties();
        p.putAll(properties);

        setProperties(p);
    }

    default void setProperties(String key, String value, String... keyVals) {
        setProperties(
            mapOf(HashMap::new, key, value, keyVals)
        );
    }

    default void addRoutes(RoutesBuilder builder) {
        try {
            getCamelContext().addRoutes(builder);
        } catch (Exception e) {
            throw RuntimeCamelException.wrapRuntimeCamelException(e);
        }
    }

    default void addConfiguration(Object configuration) {
        throw new UnsupportedOperationException();
    }

    default void setPropertiesLocations(Collection<String> locations) {
        getCamelContext().getPropertiesComponent().setLocation(
            locations.stream()
                .map(location -> location.startsWith("file:") ? location : "file:" + location)
                .distinct()
                .sorted()
                .collect(Collectors.joining(","))
        );
    }

    default void setPropertiesLocations(String... locations) {
        setPropertiesLocations(Arrays.asList(locations));
    }

    /**
     * Lifecycle method used to stops the entire integration.
     */
    default void stop() throws Exception {
        // Stopping the Camel context in default config is enough to tear down the integration
        getCamelContext().stop();
    }

    enum Phase {
        Starting,
        ConfigureProperties,
        ConfigureContext,
        ConfigureRoutes,
        Started,
        Stopping,
        Stopped
    }

    @FunctionalInterface
    interface Listener extends Ordered {
        boolean accept(Phase phase, Runtime runtime);

        @Override
        default int getOrder() {
            return Ordered.LOWEST;
        }
    }

    /**
     * Helper to create a simple runtime from a given Camel Context.
     *
     * @param camelContext the camel context
     * @return the runtime
     */
    static Runtime on(CamelContext camelContext) {
        return () -> camelContext;
    }

    /**
     * Helper to create a simple runtime from a given Camel Context provider.
     *
     * @param provider the camel context provider
     * @return the runtime
     */
    static Runtime on(HasCamelContext provider) {
        return () -> provider.getCamelContext();
    }
}