com.prosyst.mprm.admin.rule

Interface TaskBuilder

public interface TaskBuilder

A builder utility for facilitating the launching of Tasks in a 'builder-like pattern'. Instances of TaskBuilder objects can be instantiated via the RuleEngine.createTaskBuilder(String) method. Example: RuleEngine engine = ... TaskBuilder builder = engine.createTaskBuilder("My Task"); builder.setDeviceScope("mprm.osgi.device", "ROOT/", null) .setAction("target.consoleCommand('config.ls')") .launchTask();

Method Summary

Modifier and Type	Method and Description
Task	launchTask() Assembles all Task parameters set via this builder and launches the built Task.
TaskBuilder	setAction(java.lang.String action) Defines the Task action.
TaskBuilder	setConcurrency(int limit) Defines concurrency limit execution option.
TaskBuilder	setDeviceCustomScope(java.lang.String listingScript, java.lang.String isMemberScript) Sets the built-up Task to have Device scope with custom involving of devices.
TaskBuilder	setDeviceScope(java.lang.String deviceType, java.lang.String groupId, java.lang.String deviceFilter) Sets the built-up Task to have Device scope with default involving of devices.
TaskBuilder	setDeviceScopeIsMemberCheck(java.lang.String isMemberScript) Sets the built-up Task with already defined Device scope (see setDeviceScope(String, String, String)) to have a custom groovy 'is-member' verification.
TaskBuilder	setSystemScope(boolean singleHostPerRole, java.lang.String[] beHostRoles) Sets the built-up Task to have System scope.
TaskBuilder	setTimeConstraint(TimeConstraint timeConstraint) Defines at what time-schedule it is permitted for the Task to act.

Method Detail

setSystemScope

TaskBuilder setSystemScope(boolean singleHostPerRole,
                           java.lang.String[] beHostRoles)

Sets the built-up Task to have System scope.

Parameters:

singleBeHost - defines whether single or all backend hosts with the supplied (by beHostRoles parameter) role(s) should execute the Task.

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 TaskBuilder having the changes applied.

setDeviceScope

TaskBuilder setDeviceScope(java.lang.String deviceType,
                           java.lang.String groupId,
                           java.lang.String deviceFilter)

Sets the built-up Task 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 TaskBuilder having the changes applied.

setDeviceScopeIsMemberCheck

TaskBuilder setDeviceScopeIsMemberCheck(java.lang.String isMemberScript)

Sets the built-up Task 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 TaskBuilder having the changes applied.

setDeviceCustomScope

TaskBuilder setDeviceCustomScope(java.lang.String listingScript,
                                 java.lang.String isMemberScript)

Sets the built-up Task 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 TaskBuilder having the changes applied.

setConcurrency

TaskBuilder setConcurrency(int limit)

Defines concurrency limit execution option. Concurrency limit restricts the maximum number of devices concurrently executing the Task.

Parameters:

limit - concurrency limit number.

Returns:

the same TaskBuilder having the changes applied.

setTimeConstraint

TaskBuilder setTimeConstraint(TimeConstraint timeConstraint)

Defines at what time-schedule it is permitted for the Task 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 TaskBuilder having the changes applied.

setAction

TaskBuilder setAction(java.lang.String action)

Defines the Task action.

Parameters:

action - the Task action provided as groovy script.

Returns:

the same TaskBuilder having the changes applied.

launchTask

Task launchTask()
         throws ManagementException

Assembles all Task parameters set via this builder and launches the built Task.

Returns:

a Task object representing the launched Task.

Throws:

ManagementException - if system error occurs.

java.lang.IllegalArgumentException - if Task parameters are inconsistent or not correct.