com.beasys.commerce.axiom.reasoning.rules.jrules
Class JRulesServiceProvider

java.lang.Object
  |
  +--com.beasys.commerce.axiom.reasoning.rules.jrules.JRulesServiceProvider

public class JRulesServiceProvider

extends java.lang.Object

implements ServiceProvider

Implements a JRules service provider

Field Summary

static java.lang.String	ID The service provider id
static int	MAJOR_VERSION The major version number
static int	MINOR_VERSION The minor version number
static java.lang.String	NATIVE_EXTENSION The url extension for a set of jrules-native rules

Constructor Summary

JRulesServiceProvider()
Constructor

Method Summary

boolean	acceptsURI(java.lang.String rulesetURI) Determines whether or not the service provider can create a ruleset for the given rule set uri.
Context	createContext(java.lang.String rulesetURI) Creates a context for the given rule set uri
void	createRuleset(java.lang.String rulesetURI, java.io.InputStream ruleStream) Creates a rule set for the given input stream
RulesetBuilder	createRulesetBuilder() Creates a new rule set builder
java.lang.String	getID() Gets the service provider's id
int	getMajorVersion() Gets the service provider's major version number.
int	getMinorVersion() Gets the service provider's minor version number.
void	releaseAllRulesets() Releases all rule sets
void	releaseRuleset(java.lang.String rulesetURI) Releases a named ruleset
void	releaseUnusedRulesets() Releases all rule sets that are not in use

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final java.lang.String ID

The service provider id

MAJOR_VERSION

public static final int MAJOR_VERSION

The major version number

MINOR_VERSION

public static final int MINOR_VERSION

The minor version number

NATIVE_EXTENSION

public static final java.lang.String NATIVE_EXTENSION

The url extension for a set of jrules-native rules

Constructor Detail

JRulesServiceProvider

public JRulesServiceProvider()

Constructor

Method Detail

acceptsURI

public boolean acceptsURI(java.lang.String rulesetURI)
                   throws java.lang.IllegalArgumentException

Determines whether or not the service provider can create a ruleset for the given rule set uri.

Specified by:

acceptsURI in interface ServiceProvider

Parameters:

rulesetURI - The uri of the rule set

Throws:

java.lang.IllegalArgumentException - Thrown if rulesetURI is null or zero-length

createContext

public Context createContext(java.lang.String rulesetURI)
                      throws ServiceProviderException

Creates a context for the given rule set uri

Specified by:

createContext in interface ServiceProvider

Parameters:

rulesetURI - The rule set uri for which a context is to be created

Returns:

The new context or null if there is no rule set for the uri

Throws:

java.lang.IllegalArgumentException - Thrown if rulesetURI is null or zero-length

ServiceProviderException - Thrown if unable to create the context

createRuleset

public void createRuleset(java.lang.String rulesetURI,
                          java.io.InputStream ruleStream)
                   throws java.lang.IllegalArgumentException,
                          ServiceProviderException

Creates a rule set for the given input stream

Specified by:

createRuleset in interface ServiceProvider

Parameters:

rulesetURI - The rule set uri to be mapped to the resultant rule set

ruleStream - A stream of rules expressed in the vendor-specific language

Throws:

java.lang.IllegalArgumentException - Thrown if rulesetURI is null or zero-length, or if ruleStream is null

ServiceProviderException - Thrown if unable to create the rule set

createRulesetBuilder

public RulesetBuilder createRulesetBuilder()
                                    throws ServiceProviderException

Creates a new rule set builder

Specified by:

createRulesetBuilder in interface ServiceProvider

Throws:

ServiceProviderException - Thrown if unable to create the builder

getID

public java.lang.String getID()

Gets the service provider's id

Specified by:

getID in interface ServiceProvider

Returns:

The id

getMajorVersion

public int getMajorVersion()

Gets the service provider's major version number.

Specified by:

getMajorVersion in interface ServiceProvider

Returns:

The major version number

getMinorVersion

public int getMinorVersion()

Gets the service provider's minor version number.

Specified by:

getMinorVersion in interface ServiceProvider

Returns:

The minor version number

releaseAllRulesets

public void releaseAllRulesets()
                        throws ServiceProviderException

Releases all rule sets

Specified by:

releaseAllRulesets in interface ServiceProvider

Throws:

ServiceProviderException - Thrown if unable to release all rule sets TODO: 1. Provide to caller keys for all rule sets that could not be released

releaseRuleset

public void releaseRuleset(java.lang.String rulesetURI)
                    throws java.lang.IllegalArgumentException,
                           ServiceProviderException

Releases a named ruleset

Specified by:

releaseRuleset in interface ServiceProvider

Parameters:

rulesetURI - The uri of the rule set to be released

Throws:

java.lang.IllegalArgumentException - Thrown if rulesetURI is null or zero-length

ServiceProviderException - Thrown if unable to release rule set

releaseUnusedRulesets

public void releaseUnusedRulesets()
                           throws ServiceProviderException

Releases all rule sets that are not in use

Specified by:

releaseUnusedRulesets in interface ServiceProvider

Throws:

ServiceProviderException - Thrown if unable to release unused rule sets