com.massa.mrules.builder

Class MRulesBuilder

java.lang.Object

com.massa.mrules.builder.MRulesBuilder

All Implemented Interfaces:

javax.rules.admin.LocalRuleExecutionSetProvider, javax.rules.admin.RuleExecutionSetProvider

public class MRulesBuilder
extends Object
implements javax.rules.admin.RuleExecutionSetProvider, javax.rules.admin.LocalRuleExecutionSetProvider

This class provides a generic way to deal with MRuleExecutionSet instances via an uri. At first usage of an Engine, the instance will be created an stored for reuse. If configuration changes, it's detected via a hash change of the ConfigHolder. Implementations should :

• implement the method allowing to retrieve ConfigHolder from uri
• handle errors more specifically if needed

The following parameters are expected to be accessible when building a rule engine :

• ruleengine.uri : Unique Rule Engine configuration name
• configholder.impl : IRuleEngineConfigHolder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HASH

Constructor Summary

Constructors

Constructor and Description
MRulesBuilder() Default constructor.
MRulesBuilder(Map<String,String> parameters) Constructor with direct initialization of default parameters.

Method Summary

Modifier and Type	Method and Description
IMRuleExecutionSet	createRuleExecutionSet(Element ruleExecutionSetElement, Map parameters) For JSR94 compatibility
IMRuleExecutionSet	createRuleExecutionSet(InputStream ruleExecutionSetStream, Map parameters) For JSR94 compatibility
IMRuleExecutionSet	createRuleExecutionSet(Object ruleExecutionSetAst, Map parameters) For JSR94 compatibility
IMRuleExecutionSet	createRuleExecutionSet(Reader ruleExecutionSetReader, Map parameters) For JSR94 compatibility
IMRuleExecutionSet	createRuleExecutionSet(Serializable ruleExecutionSetAst, Map parameters) For JSR94 compatibility
IMRuleExecutionSet	createRuleExecutionSet(String uri, Map parameters) For JSR94 compatibility
protected IRuleEngineConfigHolder	getConfig(Map<String,String> parameters, boolean useGenericHolder, boolean nofail) Retrieves the configuration XML from the name.
Map<String,String>	getDefaultParameters()
IMRuleExecutionSet	getRuleExecutionSetInstance() Builds if necessary or retrieves from cache the requested engine instance, using the default parameters.
IMRuleExecutionSet	getRuleExecutionSetInstance(Map<String,String> parameters) Builds if necessary or retrieves from cache the requested engine instance, merging the default parameters with the provided ones.
static List<String>	getUris() Get all URIs of cached rulesets.
static boolean	putEngines(String uri, Pair<String,IMRuleExecutionSet> engines) Thread safely removing an instance from cache.
static boolean	removeEngines(String uri) Thread safely removing an instance from cache.
void	setDefaultParameters(Map<String,String> defaultParameters)
static void	updateMetaData(Map<String,String> parameters, IMRuleExecutionSet eng) Updates URI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_HASH

public static final String DEFAULT_HASH

See Also:

Constant Field Values

Constructor Detail

MRulesBuilder

public MRulesBuilder()

Default constructor. Should be followed by initialization or, if not, the instance should be used with Map parameterized methods.

MRulesBuilder

public MRulesBuilder(Map<String,String> parameters)

Constructor with direct initialization of default parameters.

Method Detail

createRuleExecutionSet

public IMRuleExecutionSet createRuleExecutionSet(InputStream ruleExecutionSetStream,
                                                 Map parameters)
                                          throws MRuleExecutionSetCreateException,
                                                 IOException

For JSR94 compatibility

Specified by:

createRuleExecutionSet in interface javax.rules.admin.LocalRuleExecutionSetProvider

Throws:

MRuleExecutionSetCreateException

IOException

createRuleExecutionSet

public IMRuleExecutionSet createRuleExecutionSet(Reader ruleExecutionSetReader,
                                                 Map parameters)
                                          throws javax.rules.admin.RuleExecutionSetCreateException,
                                                 IOException

For JSR94 compatibility

Specified by:

createRuleExecutionSet in interface javax.rules.admin.LocalRuleExecutionSetProvider

Throws:

javax.rules.admin.RuleExecutionSetCreateException

IOException

createRuleExecutionSet

public IMRuleExecutionSet createRuleExecutionSet(Object ruleExecutionSetAst,
                                                 Map parameters)
                                          throws javax.rules.admin.RuleExecutionSetCreateException

For JSR94 compatibility

Specified by:

createRuleExecutionSet in interface javax.rules.admin.LocalRuleExecutionSetProvider

Throws:

javax.rules.admin.RuleExecutionSetCreateException

createRuleExecutionSet

public IMRuleExecutionSet createRuleExecutionSet(Element ruleExecutionSetElement,
                                                 Map parameters)
                                          throws javax.rules.admin.RuleExecutionSetCreateException,
                                                 RemoteException

For JSR94 compatibility

Specified by:

createRuleExecutionSet in interface javax.rules.admin.RuleExecutionSetProvider

Throws:

javax.rules.admin.RuleExecutionSetCreateException

RemoteException

createRuleExecutionSet

public IMRuleExecutionSet createRuleExecutionSet(Serializable ruleExecutionSetAst,
                                                 Map parameters)
                                          throws javax.rules.admin.RuleExecutionSetCreateException,
                                                 RemoteException

For JSR94 compatibility

Specified by:

createRuleExecutionSet in interface javax.rules.admin.RuleExecutionSetProvider

Throws:

javax.rules.admin.RuleExecutionSetCreateException

RemoteException

createRuleExecutionSet

public IMRuleExecutionSet createRuleExecutionSet(String uri,
                                                 Map parameters)
                                          throws MRuleExecutionSetCreateException

For JSR94 compatibility

Specified by:

createRuleExecutionSet in interface javax.rules.admin.RuleExecutionSetProvider

Throws:

MRuleExecutionSetCreateException

getRuleExecutionSetInstance

public IMRuleExecutionSet getRuleExecutionSetInstance()
                                               throws MConfigurationException

Builds if necessary or retrieves from cache the requested engine instance, using the default parameters.

Throws:

MConfigurationException

getRuleExecutionSetInstance

public IMRuleExecutionSet getRuleExecutionSetInstance(Map<String,String> parameters)
                                               throws MConfigurationException

Builds if necessary or retrieves from cache the requested engine instance, merging the default parameters with the provided ones.

Throws:

MConfigurationException

updateMetaData

public static void updateMetaData(Map<String,String> parameters,
                                  IMRuleExecutionSet eng)

Updates URI.

putEngines

public static boolean putEngines(String uri,
                                 Pair<String,IMRuleExecutionSet> engines)

Thread safely removing an instance from cache.

Returns:

true if an engine was present, false otherwise.

removeEngines

public static boolean removeEngines(String uri)

Thread safely removing an instance from cache.

Returns:

true if an engine was present, false otherwise.

getUris

public static List<String> getUris()

Get all URIs of cached rulesets.

getConfig

protected IRuleEngineConfigHolder getConfig(Map<String,String> parameters,
                                            boolean useGenericHolder,
                                            boolean nofail)
                                     throws MConfigurationException

Retrieves the configuration XML from the name. For instance, if configuration is stored in a long parameter, will be the parameter name.

Parameters:

useGenericHolder - if configholder_impl parameter is omitted, use GenericRuleEngineConfigHolder ?

nofail - If holder can't be built, will fail or return null depending on this flag's value.

Returns:

The XML as String

Throws:

MConfigurationException

getDefaultParameters

public Map<String,String> getDefaultParameters()

setDefaultParameters

public void setDefaultParameters(Map<String,String> defaultParameters)