com.prosyst.mprm.admin.m2m.groups

Interface GroupAdmin

public interface GroupAdmin

Interface for managing M2M groups. Service implementing this interface can be obtained from mPRM registry or through RAC.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROOT_GROUP_ID ID of the root group (getRootGroup()).

Method Summary

Modifier and Type	Method and Description
void	addGroupAdminListener(GroupAdminListener listener) Register listener which will receive events about group and group type adding/removal.
void	addGroupListener(GroupChangeListener listener) Register listener which will receive group change events.
Group	createGroup(GroupType type, java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties) Creates group of the specified type with the given name and construction properties.
GroupType	createGroupType(java.lang.String name, java.io.InputStream icon, GroupMetaType metaInfo) Creates a custom group type with the given name, icon and meta-type.
GroupType	createGroupType(java.lang.String id, java.lang.String name, java.io.InputStream icon, GroupMetaType metaInfo) Creates a custom group type with the given ID, name, icon and meta-type.
Group	findGroupByID(java.lang.String groupID) Find group by its ID.
Group	getGroup(GroupType groupType, java.lang.String groupID) Get group of given type with given ID.
GroupType	getGroupType(java.lang.String typeID) Returns the group type with the given ID.
Group	getRootGroup() Root group of the groups hierarchy.
GroupType	getSystemGroupType() Returns the system groups type.
boolean	isGroupTypeUserCreated(java.lang.String typeID) Returns true if the given type is created by the user.
<any>	listGroups(java.lang.String ldapFilter) List IDs groups matching given LDAP filter.
<any>	listGroupsByType(java.lang.String typeID) List IDs of groups of the given type.
<any>	listGroupTypes() List group types registered in the system.
void	removeGroup(GroupType groupType, java.lang.String groupID) Remove group from given type with given ID.
void	removeGroupAdminListener(GroupAdminListener listener) Remove previously registered with addGroupAdminListener(GroupAdminListener) listener.
void	removeGroupListener(GroupChangeListener listener) Remove listener previously registered with addGroupListener(GroupChangeListener) method.
void	removeGroupType(java.lang.String typeID) Remove custom group type and all groups of this type.
void	updateGroupType(java.lang.String id, java.lang.String name, java.io.InputStream icon, GroupMetaType metaInfo) Updates group type name, icon and meta-type.

Field Detail

ROOT_GROUP_ID

static final java.lang.String ROOT_GROUP_ID

ID of the root group (getRootGroup()).

See Also:

Constant Field Values

Method Detail

getRootGroup

Group getRootGroup()
            throws ManagementException

Root group of the groups hierarchy. All other groups, that have no parent group assigned, are children of this group.

Returns:

root group

Throws:

ManagementException - is system error occurs

getSystemGroupType

GroupType getSystemGroupType()
                      throws ManagementException

Returns the system groups type. This type can be used to create fully editable groups.

Returns:

system type

Throws:

ManagementException - is system error occurs

createGroup

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

Creates group of the specified type with the given name and construction properties. If the group type is of a third party GroupProvider creation will be delegated to the corresponding provider. For system groups the construction properties (if not null) will be set as properties for the group. Third party group types may require specific properties to be able to create a group (for example gateway ID or parent group ID). Required (and optional) properties should be described in group type's GroupMetaType.

Parameters:

type - group type

name - group name

properties - construction properties

Returns:

newly created group

Throws:

ManagementException - is system error occurs

getGroup

Group getGroup(GroupType groupType,
               java.lang.String groupID)
        throws ManagementException

Get group of given type with given ID.

Parameters:

groupType - group type

groupID - group ID

Returns:

group or null, if no such group is found

Throws:

ManagementException - is system error occurs

removeGroup

void removeGroup(GroupType groupType,
                 java.lang.String groupID)
          throws ManagementException

Remove group from given type with given ID. If the group type is provided by a third party GroupProvider the removal will be delegated to the corresponding provider.

Parameters:

groupType - group type

groupID - group ID

Throws:

ManagementException - if system error occurs

findGroupByID

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

Find group by its ID. This methods can be used to find a group when only its ID (and not its type) is known.

Parameters:

groupID - group id

Returns:

group with the corresponding ID or null if such group can not be found

Throws:

ManagementException - if system error occurs

createGroupType

GroupType createGroupType(java.lang.String name,
                          java.io.InputStream icon,
                          GroupMetaType metaInfo)
                   throws ManagementException

Creates a custom group type with the given name, icon and meta-type. The group type will be assigned an unique system generated ID.

Parameters:

name - type name

icon - type icon

metaInfo - type meta-data

Returns:

the created group type

Throws:

ManagementException - if system error occurs

createGroupType

GroupType createGroupType(java.lang.String id,
                          java.lang.String name,
                          java.io.InputStream icon,
                          GroupMetaType metaInfo)
                   throws ManagementException

Creates a custom group type with the given ID, name, icon and meta-type. If there is already a group type with the given ID the existing type will be returned (instead of creating new one).

Parameters:

id - type ID

name - type name

icon - type icon

metaInfo - type meta-data

Returns:

the created group type

Throws:

ManagementException - if system error occurs

updateGroupType

void updateGroupType(java.lang.String id,
                     java.lang.String name,
                     java.io.InputStream icon,
                     GroupMetaType metaInfo)
              throws ManagementException

Updates group type name, icon and meta-type.

Parameters:

id - group type id

name - type name

icon - type icon

metaInfo - type meta-info

Throws:

ManagementException - if system error occurs

getGroupType

GroupType getGroupType(java.lang.String typeID)
                throws ManagementException

Returns the group type with the given ID.

Parameters:

typeID - type ID

Returns:

group type with the given ID or null, if no such type is found

Throws:

ManagementException - if system error occurs

removeGroupType

void removeGroupType(java.lang.String typeID)
              throws ManagementException

Remove custom group type and all groups of this type. Third party group types can not be removed.

Parameters:

typeID - ID of the type to be removed

Throws:

ManagementException - if system error occurs

isGroupTypeUserCreated

boolean isGroupTypeUserCreated(java.lang.String typeID)
                        throws ManagementException

Returns true if the given type is created by the user.

Parameters:

typeID - type id

Returns:

true, if the type is created by the user, false - otherwise

Throws:

ManagementException - if system error occurs

listGroups

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

List IDs groups matching given LDAP filter. If no filter is given all group IDs will be returned. All properties from (@link GroupFilterPropertyConstants} can be used in the filter in addition to custom group properties ( Group.getProperties()).

Parameters:

ldapFilter - LDAP filter or null

Returns:

IDs of groups matching the filter

Throws:

ManagementException - if system error occurs

listGroupsByType

<any> listGroupsByType(java.lang.String typeID)
                throws ManagementException

List IDs of groups of the given type.

Parameters:

typeID - group type ID

Returns:

IDs of groups of the given type

Throws:

ManagementException - if system error occurs

listGroupTypes

<any> listGroupTypes()
              throws ManagementException

List group types registered in the system.

Returns:

list of group types

Throws:

ManagementException - if system error occurs

addGroupAdminListener

void addGroupAdminListener(GroupAdminListener listener)

Register listener which will receive events about group and group type adding/removal.

Parameters:

listener - listener

removeGroupAdminListener

void removeGroupAdminListener(GroupAdminListener listener)

Remove previously registered with addGroupAdminListener(GroupAdminListener) listener.

Parameters:

listener - listener

addGroupListener

void addGroupListener(GroupChangeListener listener)

Register listener which will receive group change events.

Parameters:

listener - listener

removeGroupListener

void removeGroupListener(GroupChangeListener listener)

Remove listener previously registered with addGroupListener(GroupChangeListener) method.

Parameters:

listener - listener