All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.apache.servicemix.drools.DroolsEndpoint Maven / Gradle / Ivy

    Go to download

    The ServiceMix Drools component provides JBI integration to the Drools Rules Engine. It can be used to deploy a rules set that will implement a router or an actual service. A router will mostly act as a transparent proxy between the consumer and the target service provider mad will mostly be implemented by the jbi.route(uri) method below. This method creates a new exchange identical to the one received by the component and will send it to the specified destination. You can also send back a Fault if needed. A router can also be implemented by using directly the JBI Apis (available with the jbi helper) by using the provided client.

    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.servicemix.drools;

import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URL;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

import javax.jbi.JBIException;
import javax.jbi.management.DeploymentException;
import javax.jbi.messaging.ExchangeStatus;
import javax.jbi.messaging.Fault;
import javax.jbi.messaging.InOnly;
import javax.jbi.messaging.InOptionalOut;
import javax.jbi.messaging.InOut;
import javax.jbi.messaging.MessageExchange;
import javax.jbi.messaging.MessagingException;
import javax.jbi.messaging.NormalizedMessage;
import javax.jbi.messaging.MessageExchange.Role;
import javax.jbi.servicedesc.ServiceEndpoint;
import javax.xml.namespace.NamespaceContext;
import javax.xml.namespace.QName;

import org.apache.servicemix.common.DefaultComponent;
import org.apache.servicemix.common.JbiConstants;
import org.apache.servicemix.common.ServiceUnit;
import org.apache.servicemix.common.endpoints.ProviderEndpoint;
import org.apache.servicemix.common.util.MessageUtil;
import org.apache.servicemix.drools.model.Exchange;
import org.drools.RuleBase;
import org.drools.compiler.RuleBaseLoader;
import org.springframework.core.io.Resource;

/**
 * 
 * @author gnodet
 * @org.apache.xbean.XBean element="endpoint"
 */

public class DroolsEndpoint extends ProviderEndpoint {

    private RuleBase ruleBase;
    private Resource ruleBaseResource;
    private URL ruleBaseURL;
    private NamespaceContext namespaceContext;
    private QName defaultTargetService;
    private String defaultTargetURI;
    private Map globals;
    private List assertedObjects;
    private boolean autoReply;
    
    @SuppressWarnings("serial")
    private ConcurrentMap pending = new ConcurrentHashMap() {
        public DroolsExecutionContext remove(Object key) {
            DroolsExecutionContext context = super.remove(key);
            if (context != null) {
              // stop the execution context -- updating and disposing of any working memory
              context.update();
              context.stop();
            }
            return context;
        };
    };

    public DroolsEndpoint() {
        super();
    }

    public DroolsEndpoint(DefaultComponent component, ServiceEndpoint endpoint) {
        super(component, endpoint);
    }

    public DroolsEndpoint(ServiceUnit su, QName service, String endpoint) {
        super(su, service, endpoint);
    }

    /**
     * @return the ruleBase
     */
    public RuleBase getRuleBase() {
        return ruleBase;
    }

    /**
     * Set the rule base to be used for handling the exchanges
     *
     * @param ruleBase the ruleBase to set
     */
    public void setRuleBase(RuleBase ruleBase) {
        this.ruleBase = ruleBase;
    }

    /**
     * @return the ruleBaseResource
     */
    public Resource getRuleBaseResource() {
        return ruleBaseResource;
    }

    /**
     * Specifies the resource location to load the rule base from (.drl file)
     *
     * @param ruleBaseResource the ruleBaseResource to set
     */
    public void setRuleBaseResource(Resource ruleBaseResource) {
        this.ruleBaseResource = ruleBaseResource;
    }

    /**
     * @return the ruleBaseURL
     */
    public URL getRuleBaseURL() {
        return ruleBaseURL;
    }

    /**
     * Specifies a URL to load the rule base from (.drl file)
     *
     * @param ruleBaseURL the ruleBaseURL to set
     */
    public void setRuleBaseURL(URL ruleBaseURL) {
        this.ruleBaseURL = ruleBaseURL;
    }

    /**
     * @return the namespaceContext
     */
    public NamespaceContext getNamespaceContext() {
        return namespaceContext;
    }

    /**
     * The namespace context to use when evaluating the rules.
     *
     * @param namespaceContext the namespaceContext to set
     */
    public void setNamespaceContext(NamespaceContext namespaceContext) {
        this.namespaceContext = namespaceContext;
    }

    /**
     * @return the variables
     */
    public Map getGlobals() {
        return globals;
    }

    /**
     * The global variables that are available while evaluating the rule base.
     *
     * @param variables the variables to set
     */
    public void setGlobals(Map variables) {
        this.globals = variables;
    }
    
    /**
     * Will this endpoint automatically reply to any exchanges not handled by the Drools rulebase?
     * 
     * @return true if the endpoint replies to any unanswered exchanges
     */
    public boolean isAutoReply() {
        return autoReply;
    }
    
    /**
     * Set auto-reply to true to ensure that every exchange is being replied to.
     * This way, you can avoid having to end every Drools rule with jbi.answer().
     *
     * Defaults to false
     * 
     * @param autoReply true for auto-replying on incoming exchanges 
     */
    public void setAutoReply(boolean autoReply) {
        this.autoReply = autoReply;
    }

    public void validate() throws DeploymentException {
        super.validate();
        if (ruleBase == null && ruleBaseResource == null && ruleBaseURL == null) {
            throw new DeploymentException("Property ruleBase, ruleBaseResource or ruleBaseURL must be set");
        }
    }
    
    public void start() throws Exception {
        super.start();
        if (ruleBase == null) {
            InputStream is = null;
            try {
                if (ruleBaseResource != null) {
                    is = ruleBaseResource.getInputStream();
                } else if (ruleBaseURL != null) {
                    is = ruleBaseURL.openStream();
                } else {
                    throw new IllegalArgumentException("Property ruleBase, ruleBaseResource "
                            + "or ruleBaseURL must be set");
                }
                RuleBaseLoader loader = RuleBaseLoader.getInstance();
                ruleBase = loader.loadFromReader(new InputStreamReader(is));
            } catch (Exception e) {
                throw new JBIException(e);
            } finally {
                if (is != null) {
                    is.close();
                }
            }
        }
    }

    /* (non-Javadoc)
     * @see org.apache.servicemix.common.endpoints.ProviderEndpoint#process(
     *      javax.jbi.messaging.MessageExchange, javax.jbi.messaging.NormalizedMessage)
     */
    public void process(MessageExchange exchange) throws Exception {
        if (exchange.getRole() == Role.PROVIDER) {
            handleProviderExchange(exchange);
        } else {
            handleConsumerExchange(exchange);
        }
    }
    
    /*
     * Handle a consumer exchange
     */
    private void handleConsumerExchange(MessageExchange exchange) throws MessagingException {
        String correlation = (String) exchange.getProperty(DroolsComponent.DROOLS_CORRELATION_ID); 
        DroolsExecutionContext drools = pending.get(correlation);
        if (drools != null) {
            MessageExchange original = drools.getExchange();
            if (exchange.getStatus() == ExchangeStatus.DONE) {
                done(original);
            } else if (exchange.getStatus() == ExchangeStatus.ERROR) {
                fail(original, exchange.getError());
            } else {
                if (exchange.getFault() != null) {
                    MessageUtil.transferFaultToFault(exchange, original);
                } else {
                    MessageUtil.transferOutToOut(exchange, original);
                }
                // TODO: remove this sendSync() and replace by a send()
                // TODO: there is a need to store the exchange and send the DONE
                // TODO: when the original comes back
                sendSync(original);
                done(exchange);
            }
        } else {
            logger.debug("No pending exchange found for {}, no additional rules will be triggered", correlation);
        }
    }

    private void handleProviderExchange(MessageExchange exchange) throws Exception {
        if (exchange.getStatus() == ExchangeStatus.ACTIVE) {
            drools(exchange);
        } else {
            //must be a DONE/ERROR so removing any pending contexts
            pending.remove(exchange.getExchangeId());
        }
    }

    public static String getCorrelationId(MessageExchange exchange) {
        Object correlation = exchange.getProperty(JbiConstants.CORRELATION_ID);
        if (correlation == null) {
            return exchange.getExchangeId();
        } else {
            return correlation.toString();
        }
    }

    protected void drools(MessageExchange exchange) throws Exception {
        DroolsExecutionContext drools = startDroolsExecutionContext(exchange);
        if (drools.getRulesFired() < 1) {
            if (getDefaultTargetService() == null) {
                fail(exchange, new Exception("No rules have handled the exchange. Check your rule base."));
            } else {
                drools.getHelper().route(getDefaultRouteURI());
            }
        } else {
            //the exchange has been answered or faulted by the drools endpoint
            if (drools.isExchangeHandled() && exchange instanceof InOnly) {
                //only removing InOnly
                pending.remove(exchange.getExchangeId());
            }
            if (!drools.isExchangeHandled() && autoReply) {
                reply(exchange, drools);
            }
        }
    }
    
    private void reply(MessageExchange exchange, DroolsExecutionContext drools) throws Exception {
        Fault fault = exchange.getFault();
        if (fault != null) {
            drools.getHelper().fault(fault.getContent());
        } else if (isOutCapable(exchange)) {
            NormalizedMessage message = exchange.getMessage(Exchange.OUT_MESSAGE);
            if (message == null) {
                // send back the 'in' message if no 'out' message is available
                message = exchange.getMessage(Exchange.IN_MESSAGE); 
            }
            drools.getHelper().answer(message.getContent());
        } else if (exchange instanceof InOnly) {
            // just send back the done
            done(exchange);
        }
    }

    private boolean isOutCapable(MessageExchange exchange) {
        return exchange instanceof InOptionalOut || exchange instanceof InOut;
    }

    private DroolsExecutionContext startDroolsExecutionContext(MessageExchange exchange) {
        DroolsExecutionContext drools = new DroolsExecutionContext(this, exchange);
        pending.put(exchange.getExchangeId(), drools);
        drools.start();
        return drools;
    }


    public QName getDefaultTargetService() {
        return defaultTargetService;
    }

    /**
     * The default service that the exchange will be sent to if none of the rules have handled it.
     *
     * @param defaultTargetService
     */
    public void setDefaultTargetService(QName defaultTargetService) {
        this.defaultTargetService = defaultTargetService;
    }

    public String getDefaultTargetURI() {
        return defaultTargetURI;
    }

    /**
     * The default endpoint URI that the exchange will be sent to if none of the rules have handled it.
     *
     * @param defaultTargetURI
     */
    public void setDefaultTargetURI(String defaultTargetURI) {
        this.defaultTargetURI = defaultTargetURI;
    }

    public List getAssertedObjects() {
        return assertedObjects;
    }

    /**
     * List of additional objects to be inserted into the drools working memory for evaluating rules.
     *
     * @param assertedObjects
     */
    public void setAssertedObjects(List assertedObjects) {
        this.assertedObjects = assertedObjects;
    }

    public String getDefaultRouteURI() {
        if (defaultTargetURI != null) {
            return defaultTargetURI;
        } else if (defaultTargetService != null) {
            String nsURI = defaultTargetService.getNamespaceURI();
            String sep = (nsURI.indexOf("/") > 0) ? "/" : ":";
            return "service:" + nsURI + sep + defaultTargetService.getLocalPart();
        } else {
            return null;
        }
    }
    
    @Override
    protected void send(MessageExchange me) throws MessagingException {
        if (me.getStatus() != ExchangeStatus.ACTIVE) {
            // must be a DONE/ERROR so removing any pending contexts
            pending.remove(me.getExchangeId());
        }
        super.send(me);
    }
 }
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy