com.prosyst.mprm.admin.rule

Class ExecOptions

java.lang.Object

com.prosyst.mprm.admin.rule.ExecOptions

public final class ExecOptions
extends java.lang.Object

Execution options define execution behavior of Tasks and Rules, providing possible choices for various aspects of the execution. For instance, ExecOptions could define the allowed 'working time' for Tasks, maximum number of devices concurrently executing a Rule, etc. All of the defined options are valid for Rules, but only two of them (concurrency(int) and timeConstraint(TimeConstraint)) are applicable for Tasks. When a Task is automatically launched by a Rule trigger, those two execution options are also automatically taken by the triggering Rule. are applicable for Tasks.

Usage Example: new ExecOptions().oncePerDevice(true).timeConstraint( new DaylySchedule().addTimeSpan(new Date("00:00"), new Date("06:00")) )

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecOptions.Overlapping Defines whether multiple Tasks (launched out of the same Rule) over a particular device can be overlapped or should be replaced.

Method Summary

Modifier and Type	Method and Description
ExecOptions	autoDisable(boolean autoDisable) Defines whether the Rule should be automatically disabled once all targets from the Scope pass through the triggering conditions.
ExecOptions	concurrency(int limit) Defines concurrency limit execution option.
static ExecOptions	create() Creates ExecOptions instance ready to be filled with desired options.
int	getConcurrencyLimit() Returns the maximum number of concurrent device executions per backend host.
ExecOptions.Overlapping	getOverlapping() Returns the overlapping option.
TimeConstraint	getTimeConstraint() Returns the time constraint option.
boolean	isAutoDisable() Returns the autoDisable option for this ExecOptions object.
boolean	isOncePerDevice() Returns the oncePerDevice option for this ExecOptions object.
ExecOptions	oncePerDevice(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.
ExecOptions	overlap(ExecOptions.Overlapping option) Sets ExecOptions.Overlapping execution option.
ExecOptions	timeConstraint(TimeConstraint timeConstraint) Defines at what time-schedule it is permitted for the Task to act.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static ExecOptions create()

Creates ExecOptions instance ready to be filled with desired options.

Returns:

ExecOptions instance.

overlap

public ExecOptions overlap(ExecOptions.Overlapping option)

Sets ExecOptions.Overlapping execution option.

Parameters:

option - overlapping option. This option is applicable only for Rules.

Returns:

ExecOptions object having the provided option added.

concurrency

public ExecOptions concurrency(int limit)

Defines concurrency limit execution option. Concurrency limit restricts the maximum number of devices (per mPRM Backend Host) concurrently executing a Task or Rule. The total limitation number of concurrent devices then becomes: limit * N, where N is the Number of mPRM Backend Hosts with MS roles, each of which maintaining a maximum of limit active device execution among the set of devices handled by that that Backend Host.

Parameters:

limit - concurrency limit number.

Returns:

ExecOptions object having the provided option added.

oncePerDevice

public ExecOptions oncePerDevice(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. The option is not applicable for Tasks.

Parameters:

oncePerDevice - flag indicating whether the Rule should be triggered no more than once for the same device.

Returns:

ExecOptions object having the provided option added.

autoDisable

public ExecOptions autoDisable(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 oncePerDevice(boolean) set to true. The option is not applicable for Tasks.

Parameters:

autoDisable - flag indicating whether autoDisable option is switched on.

Returns:

ExecOptions object having the provided option added.

timeConstraint

public ExecOptions timeConstraint(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. This options could be supplied to Tasks and Rules. Supplied to Tasks, it will automatically be adopted by the undergoing Tasks and minded there.

Parameters:

timeConstraint - time schedule constraint definition.

Returns:

ExecOptions object having the provided option added.

getConcurrencyLimit

public int getConcurrencyLimit()

Returns the maximum number of concurrent device executions per backend host. The total number of concurrent devices limit is getConcurrencyLimit() * N, where N is the Number of mPRM Backend Hosts with MS roles, each of which maintaining a maximum of getConcurrencyLimit() active device execution among the set of devices handled by that that Backend Host.

Returns:

the concurrency limit option value, or -1 if such is not supplied.

getOverlapping

public ExecOptions.Overlapping getOverlapping()

Returns the overlapping option.

Returns:

overlapping option.

getTimeConstraint

public TimeConstraint getTimeConstraint()

Returns the time constraint option.

Returns:

the time constraint schedule for this ExecOptions object or null if such is not supplied.

isOncePerDevice

public boolean isOncePerDevice()

Returns the oncePerDevice option for this ExecOptions object.

Returns:

true if the Rule should be triggered no more than once for the same device, false otherwise.

isAutoDisable

public boolean isAutoDisable()

Returns the autoDisable option for this ExecOptions object.

Returns:

true if the Rule should be automatically disabled once all targets from the Scope pass through the triggering conditions, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object