com.prosyst.mprm.admin.rule

Class DeviceScope

java.lang.Object

com.prosyst.mprm.admin.rule.Scope

com.prosyst.mprm.admin.rule.DeviceScope

public final class DeviceScope
extends Scope

Represents Device scope.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE The constant for Scope.getScopeType().

Method Summary

Modifier and Type	Method and Description
static DeviceScope	create(java.lang.String deviceType, java.lang.String deviceGroupId, java.lang.String deviceFilter) Creates device scope determined by given device-type, device-group and device-filter.
static DeviceScope	createWithCustomListing(java.lang.String targetsListScript, java.lang.String isMemberCheckScript) Creates device scope determined by custom groovy listing and custom groovy filter.
static DeviceScope	createWithIsMemberAndFilter(java.lang.String deviceType, java.lang.String deviceGroupId, java.lang.String isMemberCheckScript, java.lang.String filter) Creates device scope determined by given device-type, device-group, custom groovy filter and system-defined device filter.
static DeviceScope	createWithIsMemberCheck(java.lang.String deviceType, java.lang.String deviceGroupId, java.lang.String isMemberCheckScript) Creates device scope determined by given device-type, device-group and custom groovy filter.
java.lang.String	getDeviceFilter() Returns the device filter specified in this scope.
java.lang.String	getDeviceGroupId() Returns the id of the device group specified in this scope.
java.lang.String	getDeviceType() Returns the device type specified in this scope.
java.lang.String	getIsMemberCheckScript() Returns the custom groovy script for filtering the device targets defined in this scope.
java.lang.String	getScopeType() Returns a string identification of the scope type.
java.lang.String	getTargetsListScript() Returns the custom groovy scropt for listing the device targets defined in this scope.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

The constant for Scope.getScopeType().

See Also:

Constant Field Values

Method Detail

create

public static DeviceScope create(java.lang.String deviceType,
                                 java.lang.String deviceGroupId,
                                 java.lang.String deviceFilter)

Creates device scope determined by given device-type, device-group and device-filter. That means devices from the supplied device-type that are members of the supplied device-group and match the supplied device-filter will be the scope of execution.

Parameters:

deviceType - specifies the type of devices to be in the execution scope.

deviceGroupId - 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:

Scope object equipped with supplied targets.

createWithIsMemberCheck

public static DeviceScope createWithIsMemberCheck(java.lang.String deviceType,
                                                  java.lang.String deviceGroupId,
                                                  java.lang.String isMemberCheckScript)

Creates device scope determined by given device-type, device-group and custom groovy filter. That means devices from the supplied device-type that are members of the supplied device-group and match the supplied filter will be scope of execution.

Parameters:

deviceType - specifies the type of devices to be in the execution scope.

deviceGroupId - specifies the device group, whose member devices to be in the execution scope.

isMemberCheckScript - 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:

Scope object equipped with supplied targets.

createWithIsMemberAndFilter

public static DeviceScope createWithIsMemberAndFilter(java.lang.String deviceType,
                                                      java.lang.String deviceGroupId,
                                                      java.lang.String isMemberCheckScript,
                                                      java.lang.String filter)

Creates device scope determined by given device-type, device-group, custom groovy filter and system-defined device filter. That means the scope of the execution will be over the devices from the supplied device-type that are members of the supplied device-group and match both: the system-supported filter - filter and the custom defined one - isMemberCheckScript.

Parameters:

deviceType - specifies the type of devices to be in the execution scope.

deviceGroupId - specifies the device group, whose member devices to be in the execution scope.

isMemberCheckScript - 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:

Scope object equipped with supplied targets.

createWithCustomListing

public static DeviceScope createWithCustomListing(java.lang.String targetsListScript,
                                                  java.lang.String isMemberCheckScript)

Creates device scope determined by custom groovy listing and custom groovy filter.

Parameters:

targetsListScript - groovy script that lists devices. The device objects must have methods getDeviceType and getDeviceId in order to determine the target device.

isMemberCheckScript - 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:

Scope object equipped with supplied targets.

getDeviceGroupId

public java.lang.String getDeviceGroupId()

Returns the id of the device group specified in this scope.

Returns:

id of device group.

getDeviceType

public java.lang.String getDeviceType()

Returns the device type specified in this scope.

Returns:

device type.

getDeviceFilter

public java.lang.String getDeviceFilter()

Returns the device filter specified in this scope.

Returns:

device filter.

getTargetsListScript

public java.lang.String getTargetsListScript()

Returns the custom groovy scropt for listing the device targets defined in this scope.

Returns:

custom groovy scropt for listing the device targets.

getIsMemberCheckScript

public java.lang.String getIsMemberCheckScript()

Returns the custom groovy script for filtering the device targets defined in this scope.

Returns:

custom groovy script for filtering the device targets.

getScopeType

public java.lang.String getScopeType()

Description copied from class: Scope

Returns a string identification of the scope type.

Specified by:

getScopeType in class Scope

Returns:

scope type.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object