RuleBuilder (Bosch IoT Remote Manager 7.1 Generic Device Management Package API)

```
public interface RuleBuilder
```
A builder utility for facilitating the creating of Rules in a 'builder-like pattern'. Instances of RuleBuilder objects can be instantiated via the RuleEngine.createRuleBuilder(String) method. Example: RuleEngine engine = ... RuleBuilder builder = engine.createRuleBuilder("My Rule"); Rule rule = builder.setDeviceScope("mprm.osgi.device", "ROOT/", null) .addTriger(ManualTrigger.create(), null, false) .setAction("target.consoleCommand('config.ls')") .buildRule(); rule.enable(); rule.fire();

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`RuleBuilder`	`addTriger(TriggerEvent fire, java.lang.String triggerConditionScript, boolean sync)` Adds a trigger definition to this Rule.
`Rule`	`buildRule()` Assembles all Rule parameters set via this builder and creates the built Rule object.
`RuleBuilder`	`setAction(java.lang.String action)` Defines the Rule action.
`RuleBuilder`	`setAutoDisable(boolean autoDisable)` Defines whether the Rule should be automatically disabled once all targets from the Scope pass through the triggering conditions.
`RuleBuilder`	`setConcurrency(int limit)` Defines concurrency limit execution option.
`RuleBuilder`	`setDeviceCustomScope(java.lang.String listingScript, java.lang.String isMemberScript)` Sets the built-up Rule to have Device scope with custom involving of devices.
`RuleBuilder`	`setDeviceScope(java.lang.String deviceType, java.lang.String groupId, java.lang.String deviceFilter)` Sets the built-up Rule to have Device scope with default involving of devices.
`RuleBuilder`	`setDeviceScopeIsMemberCheck(java.lang.String isMemberScript)` Sets the built-up Rule with already defined Device scope (see `setDeviceScope(String, String, String)`) to have a custom groovy 'is-member' verification.
`RuleBuilder`	`setGeneralCondition(java.lang.String triggerConditionScript)` Sets the general condition for the Rule triggers.
`RuleBuilder`	`setOncePerDeviceFlag(boolean oncePerDevice)` Defines whether the Rule can be executed multiple times on a given device, or should be executed only once, skipping subsequent triggers for that device.
`RuleBuilder`	`setOverlapping(ExecOptions.Overlapping option)` Sets `ExecOptions.Overlapping` execution option to the created Rule.
`RuleBuilder`	`setSystemScope(boolean singleHostPerRole, java.lang.String[] beHostRoles)` Sets the built-up Rule to have System scope.
`RuleBuilder`	`setTimeConstraint(TimeConstraint timeConstraint)` Defines at what time-schedule it is permitted for the Rule to act.

- Method Detail
  - setSystemScope
```
RuleBuilder setSystemScope(boolean singleHostPerRole,
                           java.lang.String[] beHostRoles)
```
    Sets the built-up Rule to have System scope.
    
    Parameters:
    
    singleBeHost - defines whether single or all backend hosts with the supplied (by beHostRoles parameter) role(s) should execute the Rule.
    
    beTargets - array of the target backend host roles. Elements of the array can be one of Roles.CC, Roles.MS, Roles.RAS, or id of particular Management Server. Also, array of concrete backend host ids can be provided - in such a case, the singleHostPerRole parameter is ignored.
    
    Returns:
    
    the same RuleBuilder having the changes applied.
  - setDeviceScope
```
RuleBuilder setDeviceScope(java.lang.String deviceType,
                           java.lang.String groupId,
                           java.lang.String deviceFilter)
```
    Sets the built-up Rule to have Device scope with default involving of devices.
    
    Parameters:
    
    deviceType - specifies the type of devices to be in the execution scope.
    
    groupId - specifies the device group, whose member devices to be in the execution scope.
    
    deviceFilter - devices that satisfy this device filter will be in the execution scope.
    
    Returns:
    
    the same RuleBuilder having the changes applied.
  - setDeviceScopeIsMemberCheck
```
RuleBuilder setDeviceScopeIsMemberCheck(java.lang.String isMemberScript)
```
    Sets the built-up Rule with already defined Device scope (see setDeviceScope(String, String, String)) to have a custom groovy 'is-member' verification.
    
    Parameters:
    
    isMemberScript - should be a groovy script that will be executed for each device (restricted by deviceType and deviceGroupId) bound as 'target'; the script must return boolean value specifying if the target device to be or not to be included in the execution scope.
    
    Returns:
    
    the same RuleBuilder having the changes applied.
  - setDeviceCustomScope
```
RuleBuilder setDeviceCustomScope(java.lang.String listingScript,
                                 java.lang.String isMemberScript)
```
    Sets the built-up Rule to have Device scope with custom involving of devices.
    
    Parameters:
    
    listingScript - groovy script that lists devices. The device objects must have methods getDeviceType and getDeviceId in order to determine the target device.
    
    isMemberScript - should be a groovy script that will be executed for each device (listed by the targetsListScript script) bound as 'target'; the script must return boolean value specifying if the target device to be or not to be included in the execution scope.
    
    Returns:
    
    the same RuleBuilder having the changes applied.
  - addTriger
```
RuleBuilder addTriger(TriggerEvent fire,
                      java.lang.String triggerConditionScript,
                      boolean sync)
```
    Adds a trigger definition to this Rule. A Rule can have one or more triggers each of which having TriggerEvent, condition and sync option. All triggers then go under an option general condtion specified via the setGeneralCondition(String) method.
    
    Parameters:
    
    fire - Fire definition.
    
    triggerConditionScript - trigger condition.
    
    sync - flag stating whether rule processing should be done synchronously in the thread of the firing event.
    
    Returns:
    
    the same RuleBuilder having the changes applied.
    
    Throws:
    
    java.lang.IllegalArgumentException - if fire supplied parameter is null.
  - setGeneralCondition
```
RuleBuilder setGeneralCondition(java.lang.String triggerConditionScript)
```
    Sets the general condition for the Rule triggers. Should be a groovy script that could be evaluated to boolean value true or false.
    
    Parameters:
    
    generalCondition - general condition in the form of a groovy script.
    
    Returns:
    
    the same RuleBuilder having the changes applied.
  - setOverlapping
```
RuleBuilder setOverlapping(ExecOptions.Overlapping option)
```
    Sets ExecOptions.Overlapping execution option to the created Rule.
    
    Parameters:
    
    option - overlapping option.
    
    Returns:
    
    the same RuleBuilder having the changes applied.
  - setConcurrency
```
RuleBuilder setConcurrency(int limit)
```
    Defines concurrency limit execution option. Concurrency limit restricts the maximum number of devices concurrently executing the Rule.
    
    Parameters:
    
    limit - concurrency limit number.
    
    Returns:
    
    the same RuleBuilder having the changes applied.
  - setOncePerDeviceFlag
```
RuleBuilder setOncePerDeviceFlag(boolean oncePerDevice)
```
    Defines whether the Rule can be executed multiple times on a given device, or should be executed only once, skipping subsequent triggers for that device.
    
    Parameters:
    
    oncePerDevice - flag indicating whether the Rule should be triggered no more than once for the same device.
    
    Returns:
    
    the same RuleBuilder having the changes applied.
  - setAutoDisable
```
RuleBuilder setAutoDisable(boolean autoDisable)
```
    Defines whether the Rule should be automatically disabled once all targets from the Scope pass through the triggering conditions. The benefit to enable this option is knowing when a given mass operation is finished and no more devices are expected to trigger execution from that Rule. Usually, this option is combined with setOncePerDeviceFlag(boolean) set to true.
    
    Parameters:
    
    autoDisable - flag indicating whether autoDisable option is switched on.
    
    Returns:
    
    the same RuleBuilder having the changes applied.
  - setTimeConstraint
```
RuleBuilder setTimeConstraint(TimeConstraint timeConstraint)
```
    Defines at what time-schedule it is permitted for the Rule to act. Long-running tasks might need to interrupt and resume at certain time-schedules. For instance users might require updates to run only during the night, but due to the huge number of devices, the update process to not be able to finish in one night.
    
    Parameters:
    
    timeConstraint - time schedule constraint definition.
    
    Returns:
    
    the same RuleBuilder having the changes applied.
  - setAction
```
RuleBuilder setAction(java.lang.String action)
```
    Defines the Rule action.
    
    Parameters:
    
    action - the Rule action provided as groovy script.
    
    Returns:
    
    the same RuleBuilder having the changes applied.
  - buildRule
```
Rule buildRule()
        throws ManagementException
```
    Assembles all Rule parameters set via this builder and creates the built Rule object.
    
    Returns:
    
    a Rule object representing built up Rule.
    
    Throws:
    
    ManagementException - if system error occurs.
    
    java.lang.IllegalArgumentException - if Task parameters are inconsistent or not correct.

Interface RuleBuilder

Method Summary

Method Detail

setSystemScope

setDeviceScope

setDeviceScopeIsMemberCheck

setDeviceCustomScope

addTriger

setGeneralCondition

setOverlapping

setConcurrency

setOncePerDeviceFlag

setAutoDisable

setTimeConstraint

setAction

buildRule