com.prosyst.mprm.admin.m2m.groups.spi

Interface GroupProvider

public interface GroupProvider

This interface must be implemented and registered as OSGi service to provide a third party group type and groups in mPRM. Providers have the responsibility to supply a group type with unique ID in the system. This group type is used to identify the provider. The group type meta-data can be used by the provider to define the supported actions over its groups (can the groups be edited, accepted group/component types) and required/optional properties for creating a group. Providers must make sure that their groups introduce no cycles in the hierarchy. Providers also have the responsibility to make sure that the IDs of the groups they provide are unique in the system. Providers should also implements LDAP searching over their groups' fields.

Method Summary

Modifier and Type	Method and Description
Group	createGroup(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties) Create group given name and construction properties.
<any>	filterGroups(<any> groupIDs, java.lang.String ldapFilter) Filter a set of groups.
Group	getGroup(java.lang.String groupID) Get group by ID.
GroupType	getType() Returns the type of groups supported by this provider.
boolean	hasGroup(java.lang.String groupID) Does the provider has a group with the given ID?
boolean	isInSubtree(java.lang.String groupID, java.lang.String deviceType, java.lang.String deviceID) Returns true if the given device is member of the sub-tree starting from the group with the given ID, otherwise - false.
<any>	listComponents(<any> groupIDs, java.lang.String cuFilter, boolean includeChildGroups) List components, contained in the specified groups (and optionally their sub-groups), that match given control unit filter.
<any>	listComponents(java.lang.String cuFilter) List all components, contained in groups by this provider, that match given control unit filter.
<any>	listComponents(java.lang.String groupID, java.lang.String cuType, java.lang.String cuFilter) List components from given type contained in specified group that match given control unit filter.
<any>	listGroups(java.lang.String ldapFilter) List groups matching given LDAP filter.
<any>	listRootGroups(java.lang.String ldapFilter) List groups from this provider which have no parent.
void	removeGroup(java.lang.String groupID) Remove the specified group.
void	setCallback(GroupAdminCallback callback) When this service is registered in the mPRM the group admin will use this method to pass the service callback through which it can notify the admin for changes in its group hierarchy.

Method Detail

setCallback

void setCallback(GroupAdminCallback callback)

When this service is registered in the mPRM the group admin will use this method to pass the service callback through which it can notify the admin for changes in its group hierarchy.

Parameters:

callback - callback to the group admin

getType

GroupType getType()

Returns the type of groups supported by this provider. The type must have unique ID in the mPRM.

Returns:

group type

listRootGroups

<any> listRootGroups(java.lang.String ldapFilter)
              throws ManagementException

List groups from this provider which have no parent. Such groups will be available under the root M2M group ( GroupAdmin.getRootGroup()). LDAP filter can be used to refine the result set.

Parameters:

ldapFilter - LDAP filter or null for all groups

Returns:

IDs of root groups matching the given criteria

Throws:

ManagementException - if system error occurs

listGroups

<any> listGroups(java.lang.String ldapFilter)
          throws ManagementException

List groups matching given LDAP filter. If filter is not specified all groups supported by this provider must be returned.

Parameters:

ldapFilter - LDAP filter or null for all groups

Returns:

IDs of root groups matching the given criteria

Throws:

ManagementException - if system error occurs

filterGroups

<any> filterGroups(<any> groupIDs,
                   java.lang.String ldapFilter)
            throws ManagementException

Filter a set of groups.

Parameters:

groupIDs - IDs of groups that must be filtered

ldapFilter - LDAP filter

Returns:

IDs of the groups matching the filter

Throws:

ManagementException - if system error occurs

listComponents

<any> listComponents(java.lang.String cuFilter)
              throws ManagementException

List all components, contained in groups by this provider, that match given control unit filter. If no filter is given all components must be returned.

Parameters:

cuFilter - control unit filter or null

Returns:

components matching the given criteria

Throws:

ManagementException - if system error occurs

listComponents

<any> listComponents(<any> groupIDs,
                     java.lang.String cuFilter,
                     boolean includeChildGroups)
              throws ManagementException

List components, contained in the specified groups (and optionally their sub-groups), that match given control unit filter. If no filter is given all components in the given groups must be returned.

Parameters:

groupIDs - group IDs

cuFilter - control unit filter or null

includeChildGroups - include components from sub-groups?

Returns:

components matching the given criteria

Throws:

ManagementException - if system error occurs

listComponents

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

List components from given type contained in specified group that match given control unit filter. If filter is not specified all control units of the given type contained in the group must be returned.

Parameters:

groupID - group ID

cuType - control unit type

cuFilter - control unit filter or null

Returns:

components matching the given criteria

Throws:

ManagementException - if system error occurs

hasGroup

boolean hasGroup(java.lang.String groupID)

Does the provider has a group with the given ID?

Parameters:

groupID - group ID

Returns:

true, if the provider has such group, otherwise false

isInSubtree

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

Returns true if the given device is member of the sub-tree starting from the group with the given ID, otherwise - false.

Parameters:

groupID - sub-tree root group ID

deviceType - device type

deviceID - device ID

Returns:

true if the device is in the sub-tree, otherwise - false

Throws:

ManagementException

getGroup

Group getGroup(java.lang.String groupID)
        throws ManagementException

Get group by ID.

Parameters:

groupID - group ID

Returns:

group with the given ID or null, if the provider has no such group

Throws:

ManagementException - if system error occurs

createGroup

Group createGroup(java.lang.String name,
                  java.util.Map<java.lang.String,java.lang.String> properties)
           throws ManagementException

Create group given name and construction properties. Required construction properties must be described in group type GroupMetaType.

Parameters:

name - group name, can not be null

properties - construction properties, may be null if not required

Returns:

newly created group

Throws:

ManagementException - if system error occurs

removeGroup

void removeGroup(java.lang.String groupID)
          throws ManagementException

Remove the specified group.

Parameters:

groupID - group ID

Throws:

ManagementException - if system error occurs