Package com.prosyst.mprm.admin.rule

This package provides the Rule Engine functionality.

See: Description

Interface Summary

Interface	Description
DeviceExecItem	Represents status report of partial execution for a device within a given Task.
DeviceExecStatus	Represents abstract execution status of given device.
DeviceRuleStatus	Represents execution status of device in the scope of a Rule.
DeviceTaskStatus	Represents execution status of device in the scope of a Task.
FilteredSet<T>	Represents a generic set used for retrieving Rules or Tasks that are filtered by some criteria on the target attributes.
Rule	Represents a Rule.
RuleBuilder	A builder utility for facilitating the creating of Rules in a 'builder-like pattern'.
RuleEngine	The RuleEngine service provides functionality for appointing and monitoring of Task executions and automation Rules over the mPRM System and devices managed by mPRM.
RuleListener	Could be implemented by user applications to receive event notifications related to Rule life-cycles.
Task	Represents a Task.
TaskBuilder	A builder utility for facilitating the launching of Tasks in a 'builder-like pattern'.
TaskListener	Could be implemented by user applications to receive event notifications about launching of Tasks, changes in Tasks progress, processing of involved devices in Tasks, completing and deleting of Tasks.

Class Summary

Class	Description
DeviceScope	Represents Device scope.
ExecOptions	Execution options define execution behavior of Tasks and Rules, providing possible choices for various aspects of the execution.
FunctionalEventTrigger	Represents Rule trigger defined via functional event.
ManualTrigger	Represents a manual Rule trigger.
Scope	Represents a scope abstraction for Tasks and Rules.
SystemScope	Represents System scope.
TimerTrigger	Represents a timer Rule trigger.
Trigger	Defines a Rule trigger.
TriggerElement	Defines definition of situation that triggers a Rule.
TriggerEvent	Represents abstraction for event that fires a Rule trigger.

Enum Summary

Enum	Description
DeviceExecItem.State	Defines possible execution statuses.
DeviceExecStatus.State	Defines possible statuses for device executions.
ExecOptions.Overlapping	Defines whether multiple Tasks (launched out of the same Rule) over a particular device can be overlapped or should be replaced.
Rule.State	Defines possible Rule states.
RuleListener.RuleEventType	Defines possible Rule events.
Task.State	Defines possible Task states.
TaskListener.TaskEventType	Defines possible Task events.

Package com.prosyst.mprm.admin.rule Description

This package provides the Rule Engine functionality. It's main interface is RuleEngine and it can be accessed in two ways:

• as a service on the backend framework and it is accessible to the other bundles through methods defined by the OSGi Framework specification.
  
  Example :
  
  

  import com.prosyst.mprm.admin.rule.RuleEngine; import org.osgi.framework.BundleContext; import org.osgi.framework.ServiceReference; public RuleEngine getRuleEngine(BundleContext context) { RuleEngine ruleEngine = null; ServiceReference omRef = context.getServiceReference("com.prosyst.mprm.admin.rule.RuleEngine"); if (omRef != null) { ruleEngine = (RuleEngine)context.getService(omRef); } return ruleEngine; }

  
  
  
• as a stand-alone application, not depending on OSGi Framework, by using com.prosyst.mprm.rac.RemoteAccessClient. An external stand-alone application can use this package by including system-rac.jar and gdm-rac.jar in its classpath.
  
  Example :
  
  

  import com.prosyst.mprm.admin.rule.RuleEngine; import com.prosyst.mprm.rac.RemoteAccessClient; import java.util.Hashtable; public RuleEngine getRuleEngine(RemoteAccessClient rac) { RuleEngine ruleEngine = null; if (rac != null) { ruleEngine = (RuleEngine)rac.getService("com.prosyst.mprm.admin.rule.RuleEngine"); } return ruleEngine; } public static void main(String[] args) { //Open session using the system account. Hashtable credentials = new Hashtable(); credentials.put(RemoteAccessClient.USER_PASSWORD, "system"); RemoteAccessClient rac = RemoteAccessClient.connect("socket://mprm.acme.com:11449", "system", credentials, null); ... //Now the application can access RuleEngine service RuleEngine ruleEngine = getRuleEngine(rac); ... //closing session rac.close(); }