org.drools.jsr94.rules.admin.RuleAdministratorImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of drools-jsr94 Show documentation
Implements the JSR-94 API with Drools.
There is a newer version: 7.2.0.Final
/*
 * Copyright 2010 Red Hat, Inc. and/or its affiliates.
 *
 * 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 org.drools.jsr94.rules.admin;

import java.util.Map;

import javax.rules.admin.LocalRuleExecutionSetProvider;
import javax.rules.admin.RuleAdministrator;
import javax.rules.admin.RuleExecutionSet;
import javax.rules.admin.RuleExecutionSetDeregistrationException;
import javax.rules.admin.RuleExecutionSetProvider;
import javax.rules.admin.RuleExecutionSetRegisterException;

import org.drools.jsr94.rules.repository.RuleExecutionSetRepository;
import org.drools.jsr94.rules.repository.RuleExecutionSetRepositoryException;

/**
 * The Drools implementation of the RuleAdministrator interface
 * which is used by rule execution set administrators to load rule execution
 * sets from external sources and create a RuleExecutionSet
 * runtime object.  The RuleAdministrator should be accessed
 * by calling: 
 
 * RuleServiceProvider ruleServiceProvider =
 *     RuleServiceProvider.newInstance();

 * RuleAdministrator ruleAdministration =
 *     ruleServiceProvider.getRuleAdministrator();
 * 
 *  In an additional step the administrator may also choose to bind the
 * RuleExecutionSet instance to a URI so that it is globally
 * accessible and RuleSessions can be created for the
 * RuleExecutionSet through the RuleRuntime.
 * 
 * @see RuleAdministrator
 */
public class RuleAdministratorImpl
    implements
    RuleAdministrator, java.io.Serializable {
    private RuleExecutionSetRepository repository;

    /** Default constructor. */
    public RuleAdministratorImpl(final RuleExecutionSetRepository repository) {
        super();
        this.repository = repository;
    }

    /**
     * Returns a RuleExecutionSetProvider implementation.
     * 
     * @param properties
     *            additional properties
     * 
     * @return The created RuleExecutionSetProvider.
     */
    public RuleExecutionSetProvider getRuleExecutionSetProvider(final Map properties) {
        return new RuleExecutionSetProviderImpl();
    }

    /**
     * Returns a LocalRuleExecutionSetProvider implementation.
     * 
     * Returns a LocalRuleExecutionSetProvider implementation or
     * null if this implementation does not support creating a
     * RuleExecutionSet from non-serializable resources.
     * 
     * @param properties
     *            additional properties
     * 
     * @return The created LocalRuleExecutionSetProvider.
     */
    public LocalRuleExecutionSetProvider getLocalRuleExecutionSetProvider(final Map properties) {
        return new LocalRuleExecutionSetProviderImpl();
    }

    /**
     * Registers a RuleExecutionSet and associates it with a
     * given URI. Once a RuleExecutionSet has been registered it
     * is accessible to runtime clients through the RuleRuntime.
     * If a RuleExecutionSet has already been associated with the
     * URI it should be deregistered (as if
     * deregisterRuleExecutionSet/ had been called) and the URI
     * should be associated with the new RuleExecutionSet.
     * 
     * @param bindUri
     *            the URI to associate with the RuleExecutionSet.
     * @param set
     *            the RuleExecutionSet to associate with the URI
     * @param properties
     *            additional properties used to perform the registration
     * 
     * @throws RuleExecutionSetRegisterException
     *             if an error occurred that prevented registration
     */
    public void registerRuleExecutionSet(final String bindUri,
                                         final RuleExecutionSet set,
                                         final Map properties)
    throws RuleExecutionSetRegisterException {

        // Note: an existing RuleExecutionSet is simply replaced
        repository.registerRuleExecutionSet(bindUri, set, properties);
    }

    /**
     * Unregisters a previously registered RuleExecutionSet from
     * a URI.
     * 
     * @param bindUri
     *            the URI to disassociate with the RuleExecutionSet.
     * @param properties
     *            additional properties used to perform the deregistration
     * 
     * @throws RuleExecutionSetDeregistrationException
     *             if an error occurred that prevented unregistration
     */
    public void deregisterRuleExecutionSet(final String bindUri,
                                           final Map properties)
    throws RuleExecutionSetDeregistrationException {

        try {
            if ( this.repository.getRuleExecutionSet(bindUri, properties) == null ) {
                throw new RuleExecutionSetDeregistrationException( "no execution set bound to: " + bindUri );
            }
        } catch (RuleExecutionSetRepositoryException e) {
            String s = "Error while retrieving rule execution set bound to: " + bindUri;
            throw new RuleExecutionSetDeregistrationException(s, e);
        }

        repository.unregisterRuleExecutionSet(bindUri, properties);
    }
}