javax.rules.admin
Interface RuleAdministrator

public interface RuleAdministrator

The RuleAdministrator inteface 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 Also:

RuleExecutionSet, RuleSession, RuleRuntime

Method Summary

void	deregisterRuleExecutionSet(java.lang.String bindUri, java.util.Map properties) Deregisters a previously registers RuleExecutionSet from a URI.
LocalRuleExecutionSetProvider	getLocalRuleExecutionSetProvider(java.util.Map properties) Returns a LocalRuleExecutionSetProvider implementation or null if this implementation does not support creating a RuleExecutionSet from non-serializable resources.
RuleExecutionSetProvider	getRuleExecutionSetProvider(java.util.Map properties) Returns a RuleExecutionSetProvider implementation.
void	registerRuleExecutionSet(java.lang.String bindUri, RuleExecutionSet set, java.util.Map properties) Registers a RuleExecutionSet and associates it with a given URI.

Method Detail

getRuleExecutionSetProvider

public RuleExecutionSetProvider getRuleExecutionSetProvider(java.util.Map properties)
                                                     throws java.rmi.RemoteException

Returns a RuleExecutionSetProvider implementation.

Parameters:

properties - additional properties

Throws:

java.rmi.RemoteException

See Also:

RuleExecutionSetProvider

getLocalRuleExecutionSetProvider

public LocalRuleExecutionSetProvider getLocalRuleExecutionSetProvider(java.util.Map properties)
                                                               throws java.rmi.RemoteException

Returns a LocalRuleExecutionSetProvider implementation or null if this implementation does not support creating a RuleExecutionSet from non-serializable resources.

Parameters:

properties - additional properties

Throws:

java.rmi.RemoteException

See Also:

LocalRuleExecutionSetProvider

registerRuleExecutionSet

public void registerRuleExecutionSet(java.lang.String bindUri,
                                     RuleExecutionSet set,
                                     java.util.Map properties)
                              throws RuleExecutionSetRegisterException,
                                     java.rmi.RemoteException

Registers a RuleExecutionSet and associates it with a given URI. Once a RuleExecutionSet has been registered it is acessible 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.

Parameters:

bindUri - the URI to associate with the RuleExecutionSet.

set - the RuleExecutionSet to associate with the URI

properties - additional properties used to perform the registration

Throws:

RuleExecutionSetRegistedException - if an error occured that prevented registration

RuleExecutionSetRegisterException

java.rmi.RemoteException

deregisterRuleExecutionSet

public void deregisterRuleExecutionSet(java.lang.String bindUri,
                                       java.util.Map properties)
                                throws RuleExecutionSetDeregistrationException,
                                       java.rmi.RemoteException

Deregisters a previously registers RuleExecutionSet from a URI.

Parameters:

bindUri - the URI to disassociate with the RuleExecutionSet.

properties - additional properties used to perform the deregisteration

Throws:

RuleExecutionSetUnregistedException - if an error occured that prevented unregistration

RuleExecutionSetDeregistrationException

java.rmi.RemoteException