io.syndesis.integration.runtime.IntegrationRouteBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2016 Red Hat, Inc.
 *
 * Licensed 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 io.syndesis.integration.runtime;

import java.io.IOException;
import java.io.InputStream;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;

import org.apache.camel.CamelContext;
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.model.ModelHelper;
import org.apache.camel.model.ProcessorDefinition;
import org.apache.camel.model.RouteDefinition;
import org.apache.camel.model.RoutesDefinition;
import org.apache.camel.runtimecatalog.RuntimeCamelCatalog;
import org.apache.camel.util.ObjectHelper;
import org.apache.camel.util.ResourceHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import io.syndesis.common.model.Split;
import io.syndesis.common.model.action.ConnectorAction;
import io.syndesis.common.model.action.ConnectorDescriptor;
import io.syndesis.common.model.action.StepAction;
import io.syndesis.common.model.integration.Integration;
import io.syndesis.common.model.integration.Scheduler;
import io.syndesis.common.model.integration.Step;
import io.syndesis.common.model.integration.StepKind;
import io.syndesis.common.util.Json;
import io.syndesis.integration.runtime.capture.OutMessageCaptureProcessor;
import io.syndesis.integration.runtime.handlers.ConnectorStepHandler;
import io.syndesis.integration.runtime.handlers.DataMapperStepHandler;
import io.syndesis.integration.runtime.handlers.EndpointStepHandler;
import io.syndesis.integration.runtime.handlers.ExpressionFilterStepHandler;
import io.syndesis.integration.runtime.handlers.ExtensionStepHandler;
import io.syndesis.integration.runtime.handlers.LogStepHandler;
import io.syndesis.integration.runtime.handlers.RuleFilterStepHandler;
import io.syndesis.integration.runtime.handlers.SimpleEndpointStepHandler;
import io.syndesis.integration.runtime.handlers.SplitStepHandler;
import io.syndesis.integration.runtime.logging.StepDoneTracker;
import io.syndesis.integration.runtime.logging.StepStartTracker;

/**
 * A Camel {@link RouteBuilder} which maps an Integration to Camel routes
 */
public class IntegrationRouteBuilder extends RouteBuilder {
    private static final Logger LOGGER = LoggerFactory.getLogger(IntegrationRouteBuilder.class);

    private final String configurationUri;
    private final List stepHandlerList;
    private final Set resources;
    private final boolean loggingEnabled;

    public IntegrationRouteBuilder(String configurationUri, Collection handlers) {
        this(configurationUri, handlers, false);
    }

    public IntegrationRouteBuilder(String configurationUri, Collection handlers, boolean logging) {
        this.configurationUri = configurationUri;
        this.resources = new HashSet<>();

        this.stepHandlerList = new ArrayList<>();
        this.stepHandlerList.add(new ConnectorStepHandler());
        this.stepHandlerList.add(new EndpointStepHandler());
        this.stepHandlerList.add(new SimpleEndpointStepHandler());
        this.stepHandlerList.add(new DataMapperStepHandler());
        this.stepHandlerList.add(new ExpressionFilterStepHandler());
        this.stepHandlerList.add(new RuleFilterStepHandler());
        this.stepHandlerList.add(new ExtensionStepHandler());
        this.stepHandlerList.add(new SplitStepHandler());
        this.stepHandlerList.add(new LogStepHandler());
        this.stepHandlerList.addAll(handlers);

        this.loggingEnabled = logging;
    }

    protected Integration loadIntegration() throws IOException {
        final Integration integration;

        try (InputStream is = ResourceHelper.resolveResourceAsInputStream(getContext().getClassResolver(), configurationUri)) {
            if (is != null) {
                LOGGER.info("Loading integration from: {}", configurationUri);
                integration = Json.reader().forType(Integration.class).readValue(is);
            } else {
                throw new IllegalStateException("Unable to load deployment: " + configurationUri);
            }
        }

        return integration;
    }

    @SuppressWarnings("PMD")
    @Override
    public void configure() throws Exception {
        final Integration integration = loadIntegration();
        final List steps = Collections.unmodifiableList(integration.getSteps());

        if (steps.isEmpty()) {
            return;
        }

        ProcessorDefinition route = configureRouteScheduler(integration);

        for (int i = 0; i < steps.size(); i++) {
            final Step step = steps.get(i);
            final IntegrationStepHandler handler = findHandler(step);

            if (route == null && !(handler instanceof IntegrationStepHandler.Consumer)) {
                throw new IllegalStateException("The handler for step kind " + step.getKind() + " is not a consumer");
            }

            // Load route fragments eventually defined by extensions.
            loadFragments(step);

            // If a step id is present, then we need to log the step.
            StepStartTracker startTracker = null;
            if (loggingEnabled && route != null && step.getId().isPresent()) {
                startTracker = new StepStartTracker(step.getId().get());
                route = route.process(startTracker);
            }

            final String index = Integer.toString(i + 1);
            final Optional definition = handler.handle(step, route, this, index);

            if (route == null && definition.isPresent()) {
                definition.filter(RouteDefinition.class::isInstance)
                    .map(RouteDefinition.class::cast)
                    .map(rd -> rd.getInputs().get(0))
                    .ifPresent(rd -> {
                        step.getId().ifPresent(rd::id);
                    });

                route = definition.get();
                integration.getId().ifPresent(route::setId);
            } else {
                route = definition.map(rd -> {
                    step.getId().ifPresent(rd::id);
                    return rd;
                }).orElse(route);
            }

            route = handleConnectorSplit(step, route, index).map(rd -> {
                step.getId().ifPresent(id -> rd.id(id + "-split"));
                return rd;
            }).orElse(route);

            if (route != null) {
                route = route.process(new OutMessageCaptureProcessor(step));
                if (step.getId().isPresent()) {
                    route.id(step.getId().get() + "-capture");
                }

                if( startTracker!=null ) {
                    route = route.process(StepDoneTracker.INSTANCE);
                }
            }
        }
    }

    // Visibility changed for test purpose.
    protected IntegrationStepHandler findHandler(Step step) {
        for (int i = 0; i < stepHandlerList.size(); i++) {
            IntegrationStepHandler handler = stepHandlerList.get(i);

            if (handler.canHandle(step)) {
                LOGGER.debug("Step kind: {}, handler: {}", step.getStepKind(), handler.getClass().getName());
                return handler;
            }
        }

        throw new IllegalStateException("Unsupported step kind: " + step.getStepKind());
    }

    /**
     * If the integration has a scheduler, start the route with a timer or quartz2
     * endpoint.
     */
    private ProcessorDefinition configureRouteScheduler(Integration integration) throws URISyntaxException {
        if (integration.getScheduler().isPresent()) {
            Scheduler scheduler = integration.getScheduler().get();

            // We now support simple timer only, cron support will be supported
            // later on.
            if (scheduler.isTimer()) {
                Map properties = new HashMap<>();
                properties.put("timerName", "integration");
                properties.put("period", scheduler.getExpression());

                final RuntimeCamelCatalog catalog = getContext().getRuntimeCamelCatalog();
                final String uri = catalog.asEndpointUri("timer", properties, false);

                RouteDefinition route = this.from(uri);
                route.getInputs().get(0).setId("integration-scheduler");
                integration.getId().ifPresent(route::setId);

                return route;
            } else {
                throw new IllegalArgumentException("Unsupported scheduler type: " + scheduler.getType());
            }
        }

        return null;
    }

    private Optional handleConnectorSplit(Step step, ProcessorDefinition route, String index) {
        if (step.getAction().filter(ConnectorAction.class::isInstance).isPresent()) {
            final ConnectorAction action = step.getAction().filter(ConnectorAction.class::isInstance).map(ConnectorAction.class::cast).get();
            final ConnectorDescriptor descriptor = action.getDescriptor();

            if (descriptor.getSplit().isPresent()) {
                final Split split = descriptor.getSplit().get();
                final Step.Builder splitBuilder = new Step.Builder().stepKind(StepKind.split);

                split.getLanguage().ifPresent(s -> splitBuilder.putConfiguredProperty("language", s));
                split.getExpression().ifPresent(s -> splitBuilder.putConfiguredProperty("expression", s));

                return new SplitStepHandler().handle(
                    splitBuilder.build(),
                    route,
                    this,
                    index);
            }
        }

        return Optional.empty();
    }

    @SuppressWarnings("PMD")
    private void loadFragments(Step step) {
        if (StepKind.extension != step.getStepKind()) {
            return;
        }

        final StepAction action = step.getAction().filter(StepAction.class::isInstance).map(StepAction.class::cast).get();

        if (action.getDescriptor().getKind() == StepAction.Kind.ENDPOINT) {
            final CamelContext context = getContext();
            final String resource = action.getDescriptor().getResource();

            if (ObjectHelper.isNotEmpty(resource) && resources.add(resource)) {
                final Object instance = mandatoryloadResource(context, resource);
                final RoutesDefinition definitions = mandatoryConvertToRoutesDefinition(resource, instance);

                LOGGER.debug("Resolved resource: {} as {}", resource, instance.getClass());

                try {
                    context.addRouteDefinitions(definitions.getRoutes());
                } catch (Exception e) {
                    throw new IllegalStateException(e);
                }
            }
        }
    }

    @SuppressWarnings("PMD")
    private Object mandatoryloadResource(CamelContext context, String resource) {
        Object instance = null;

        if (resource.startsWith("classpath:")) {
            try (InputStream is = ResourceHelper.resolveMandatoryResourceAsInputStream(context, resource)) {
                instance = ModelHelper.loadRoutesDefinition(context, is);
            } catch (Exception e) {
                throw new IllegalArgumentException(e);
            }
        } else if (resource.startsWith("class:")) {
            Class type = context.getClassResolver().resolveClass(resource.substring("class:".length()));
            instance = context.getInjector().newInstance(type);
        } else if (resource.startsWith("bean:")) {
            instance = context.getRegistry().lookupByName(resource.substring("bean:".length()));
        }

        if (instance == null) {
            throw new IllegalArgumentException("Unable to resolve resource: " + resource);
        }

        return instance;
    }

    @SuppressWarnings("PMD")
    private RoutesDefinition mandatoryConvertToRoutesDefinition(String resource, Object instance)  {
        final RoutesDefinition definitions;

        if (instance instanceof RoutesDefinition) {
            definitions = (RoutesDefinition)instance;
        } else if (instance instanceof RouteDefinition) {
            definitions = new RoutesDefinition();
            definitions.route((RouteDefinition)instance);
        } else if (instance instanceof RouteBuilder) {
            RouteBuilder builder = (RouteBuilder)instance;
            try {
                builder.configure();
                definitions = builder.getRouteCollection();
            } catch (Exception e) {
                LOGGER.warn("Unable to configure resource: " + resource, e);

                throw ObjectHelper.wrapRuntimeCamelException(e);
            }
        } else {
            throw new IllegalArgumentException("Unable to convert instance: " + instance);
        }

        return definitions;
    }
}