org.apache.camel.component.flowable.FlowableEndpoint Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-flowable Show documentation
Camel Flowable support
The newest version!
/*
 * 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.component.flowable;

import org.apache.camel.Category;
import org.apache.camel.Consumer;
import org.apache.camel.Exchange;
import org.apache.camel.Processor;
import org.apache.camel.Producer;
import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriPath;
import org.apache.camel.support.DefaultEndpoint;
import org.flowable.common.engine.api.FlowableException;
import org.flowable.eventregistry.impl.EventRegistryEngineConfiguration;
import org.flowable.eventregistry.model.CamelInboundChannelModel;
import org.flowable.eventregistry.model.CamelOutboundChannelModel;

/**
 * Send and receive messages from the Flowable BPMN and CMMN engines.
 */
@UriEndpoint(firstVersion = "4.9.0", scheme = "flowable", title = "Flowable", syntax = "flowable:channelKey",
             category = { Category.WORKFLOW })
public class FlowableEndpoint extends DefaultEndpoint {

    private EventRegistryEngineConfiguration eventRegistryEngineConfiguration;
    private FlowableConsumer flowableConsumer;

    @UriPath
    @Metadata(required = true)
    private String channelKey;
    private CamelInboundChannelModel camelInboundChannel;
    private CamelOutboundChannelModel camelOutboundChannel;

    public FlowableEndpoint(String channelKey) {
        this.channelKey = channelKey;
    }

    public FlowableEndpoint(CamelInboundChannelModel camelInboundChannel,
                            EventRegistryEngineConfiguration eventRegistryEngineConfiguration) {
        this.camelInboundChannel = camelInboundChannel;
        this.eventRegistryEngineConfiguration = eventRegistryEngineConfiguration;
    }

    public FlowableEndpoint(CamelOutboundChannelModel camelOutboundChannel,
                            EventRegistryEngineConfiguration eventRegistryEngineConfiguration) {
        this.camelOutboundChannel = camelOutboundChannel;
        this.eventRegistryEngineConfiguration = eventRegistryEngineConfiguration;
    }

    public void process(Exchange ex) throws Exception {
        if (flowableConsumer == null) {
            throw new FlowableException("Consumer not defined for " + getEndpointUri());
        }
        flowableConsumer.getProcessor().process(ex);
    }

    @Override
    public Producer createProducer() throws Exception {
        return new FlowableProducer(camelInboundChannel, this, eventRegistryEngineConfiguration);
    }

    @Override
    public Consumer createConsumer(Processor processor) throws Exception {
        return new FlowableConsumer(this, processor);
    }

    @Override
    protected String createEndpointUri() {
        if (channelKey != null) {
            return "flowable:" + channelKey;
        } else if (camelInboundChannel != null) {
            return "flowable:" + camelInboundChannel.getKey();
        } else {
            return "flowable:" + camelOutboundChannel.getKey();
        }
    }

    protected void addConsumer(FlowableConsumer consumer) {
        if (flowableConsumer != null) {
            throw new FlowableException("Consumer already defined for " + getEndpointUri() + "!");
        }
        flowableConsumer = consumer;
    }

    protected void removeConsumer() {
        flowableConsumer = null;
    }

    public String getChannelKey() {
        return channelKey;
    }

    /**
     * The channel key
     */
    public void setChannelKey(String channelKey) {
        this.channelKey = channelKey;
    }

    public void setCamelInboundChannel(CamelInboundChannelModel camelInboundChannel) {
        this.camelInboundChannel = camelInboundChannel;
    }

    public void setCamelOutboundChannel(CamelOutboundChannelModel camelOutboundChannel) {
        this.camelOutboundChannel = camelOutboundChannel;
    }

    public void setEventRegistryEngineConfiguration(EventRegistryEngineConfiguration eventRegistryEngineConfiguration) {
        this.eventRegistryEngineConfiguration = eventRegistryEngineConfiguration;
    }
}