com.prosyst.mprm.backend.m2m.groups

Interface GroupBeAdmin

public interface GroupBeAdmin

Interface used for integration Device Groups with GDM Rules Engine.

Method Summary

Modifier and Type	Method and Description
boolean	isMember(java.lang.String groupID, java.lang.String deviceType, java.lang.String deviceID) Check if device is a member of given group
<any>	listComponents(java.lang.String groupID, java.lang.String cuType, java.lang.String cuFilter, ClusterContext context) Lists control units on given group Id, control unit type and control unit filter.
boolean	supportsMSLoadDistribution(java.lang.String groupId) Tests if the provider for a given group id can list its components considering the cluster load balance distribution.

Method Detail

supportsMSLoadDistribution

boolean supportsMSLoadDistribution(java.lang.String groupId)
                            throws ManagementException

Tests if the provider for a given group id can list its components considering the cluster load balance distribution. If yes, the call to method listComponents(String, String, String, ClusterContext) is expected to return only the set of control units for which the current backend host is responsible for.

Parameters:

groupId - group ID

Returns:

true, if provider supports load distribution, false - otherwise

Throws:

ManagementException

listComponents

<any> listComponents(java.lang.String groupID,
                     java.lang.String cuType,
                     java.lang.String cuFilter,
                     ClusterContext context)
              throws ManagementException

Lists control units on given group Id, control unit type and control unit filter. A ClusterContext parameter is provided to be passed to Group Providers and used further by them in system-utilities like:

GroupAdminSystemSupport#amIResponisbleFor(ControlUnitID, ClusterContext) GroupAdminSystemSupport.listComponents(String, String, String, ClusterContext) GroupAdminUtils#makeLoadBalanceRestrictionSQL(String, ClusterContext)

Parameters:

groupId - group ID

cuType - control unit type

cuFilter - control unit filter

context - cluster context

Returns:

list of control units matching the filtering criteria

Throws:

ManagementException

isMember

boolean isMember(java.lang.String groupID,
                 java.lang.String deviceType,
                 java.lang.String deviceID)
          throws ManagementException

Check if device is a member of given group

Parameters:

groupID - group ID

deviceType - device type

deviceID - device ID

Returns:

true if the given dives is member of the specified group, false - otherwise

Throws:

ManagementException - if system error occurs