net.bluemind.group.service.internal

Class GroupService

java.lang.Object

net.bluemind.group.service.internal.GroupService

All Implemented Interfaces:

IDirEntryExtIdSupport, IGroup, IGroupMember, IInCoreGroupMember, IInCoreGroup

public class GroupService
extends java.lang.Object
implements IGroup, IInCoreGroup

Constructor Summary

Constructors

Constructor and Description
GroupService(BmContext context, ItemValue<Domain> domain, Container container, java.util.List<IGroupHook> groupsHooks)

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String uid, java.util.List<Member> members)
java.util.List<java.lang.String>	allUids()
ItemValue<Group>	byEmail(java.lang.String email) Get group from its email
ItemValue<Group>	byName(java.lang.String name) Get group from its name
void	create(java.lang.String uid, Group group) Create group
void	createWithExtId(java.lang.String uid, java.lang.String extId, Group group) Create group with external ID
void	createWithItem(ItemValue<Group> groupItem) Create group from a given item value
TaskRef	delete(java.lang.String uid) Delete group
ItemValue<Group>	getByExtId(java.lang.String extId) Get group from external ID
ItemValue<Group>	getComplete(java.lang.String uid) Get group from UID
java.util.List<Member>	getExpandedMembers(java.lang.String uid) Get all expanded group members
java.util.List<Member>	getExpandedUserMembers(java.lang.String uid) Get User type expanded group members
java.util.Set<java.lang.String>	getGroupsWithRoles(java.util.List<java.lang.String> roles)
java.util.List<Member>	getMembers(java.lang.String uid) Get all group members
java.util.List<ItemValue<Group>>	getParents(java.lang.String uid) Get all group parents UID
java.util.Set<java.lang.String>	getRoles(java.lang.String uid)
java.util.List<ItemValue<Group>>	memberOf(java.lang.String uid) Retrieves a list of all Groups this uid is member of.
java.util.List<java.lang.String>	memberOfGroups(java.lang.String uid) Retrieves a list of all Group uids this uid is member of.
void	remove(java.lang.String uid, java.util.List<Member> members)
java.util.List<ItemValue<Group>>	search(GroupSearchQuery query) Search a group
void	setExtId(java.lang.String uid, java.lang.String extId) Adds an external id to a DirEntry
void	setRoles(java.lang.String uid, java.util.Set<java.lang.String> roles)
void	touch(java.lang.String uid) Touch group (update direntry, vcard etc..)
void	update(java.lang.String uid, Group group) Update group
void	updateWithItem(ItemValue<Group> groupItem) Update group from a given item value
ValidationResult	validate(java.lang.String[] groupUids) Check that every uid corresponds to an existing group member

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupService

public GroupService(BmContext context,
                    ItemValue<Domain> domain,
                    Container container,
                    java.util.List<IGroupHook> groupsHooks)
             throws ServerFault

Throws:

ServerFault

Method Detail

create

public void create(java.lang.String uid,
                   Group group)
            throws ServerFault

Description copied from interface: IGroup

Create group

Specified by:

create in interface IGroup

Throws:

ServerFault

createWithExtId

public void createWithExtId(java.lang.String uid,
                            java.lang.String extId,
                            Group group)
                     throws ServerFault

Description copied from interface: IGroup

Create group with external ID

Specified by:

createWithExtId in interface IGroup

Throws:

ServerFault

createWithItem

public void createWithItem(ItemValue<Group> groupItem)
                    throws ServerFault

Description copied from interface: IGroup

Create group from a given item value

Specified by:

createWithItem in interface IGroup

Throws:

ServerFault

update

public void update(java.lang.String uid,
                   Group group)
            throws ServerFault

Description copied from interface: IGroup

Update group

Specified by:

update in interface IGroup

Throws:

ServerFault

updateWithItem

public void updateWithItem(ItemValue<Group> groupItem)
                    throws ServerFault

Description copied from interface: IGroup

Update group from a given item value

Specified by:

updateWithItem in interface IGroup

Throws:

ServerFault

touch

public void touch(java.lang.String uid)
           throws ServerFault

Description copied from interface: IGroup

Touch group (update direntry, vcard etc..)

Specified by:

touch in interface IGroup

Throws:

ServerFault

getComplete

public ItemValue<Group> getComplete(java.lang.String uid)
                             throws ServerFault

Description copied from interface: IGroup

Get group from UID

Specified by:

getComplete in interface IGroup

Returns:

Throws:

ServerFault

byEmail

public ItemValue<Group> byEmail(java.lang.String email)
                         throws ServerFault

Description copied from interface: IGroup

Get group from its email

Specified by:

byEmail in interface IGroup

Returns:

Throws:

ServerFault

byName

public ItemValue<Group> byName(java.lang.String name)
                        throws ServerFault

Description copied from interface: IGroup

Get group from its name

Specified by:

byName in interface IGroup

Returns:

Throws:

ServerFault

delete

public TaskRef delete(java.lang.String uid)
               throws ServerFault

Description copied from interface: IGroup

Delete group

Specified by:

delete in interface IGroup

Throws:

ServerFault

getByExtId

public ItemValue<Group> getByExtId(java.lang.String extId)
                            throws ServerFault

Description copied from interface: IGroup

Get group from external ID

Specified by:

getByExtId in interface IGroup

Returns:

Throws:

ServerFault

add

public void add(java.lang.String uid,
                java.util.List<Member> members)
         throws ServerFault

Specified by:

add in interface IGroup

Throws:

ServerFault

getMembers

public java.util.List<Member> getMembers(java.lang.String uid)
                                  throws ServerFault

Description copied from interface: IGroup

Get all group members

Specified by:

getMembers in interface IGroup

Returns:

members belonging to this group

Throws:

ServerFault

getExpandedMembers

public java.util.List<Member> getExpandedMembers(java.lang.String uid)
                                          throws ServerFault

Description copied from interface: IGroup

Get all expanded group members

Specified by:

getExpandedMembers in interface IGroup

Returns:

members belonging to this group or its sub-groups

Throws:

ServerFault

getExpandedUserMembers

public java.util.List<Member> getExpandedUserMembers(java.lang.String uid)
                                              throws ServerFault

Description copied from interface: IGroup

Get User type expanded group members

Specified by:

getExpandedUserMembers in interface IGroup

Returns:

members of type User belonging to this group or its sub-groups

Throws:

ServerFault

remove

public void remove(java.lang.String uid,
                   java.util.List<Member> members)
            throws ServerFault

Specified by:

remove in interface IGroup

Throws:

ServerFault

getParents

public java.util.List<ItemValue<Group>> getParents(java.lang.String uid)
                                            throws ServerFault

Description copied from interface: IGroup

Get all group parents UID

Specified by:

getParents in interface IGroup

Returns:

parents

Throws:

ServerFault

allUids

public java.util.List<java.lang.String> allUids()
                                         throws ServerFault

Specified by:

allUids in interface IGroup

Throws:

ServerFault

getRoles

public java.util.Set<java.lang.String> getRoles(java.lang.String uid)
                                         throws ServerFault

Specified by:

getRoles in interface IGroup

Parameters:

uid - Group uid

Returns:

Throws:

ServerFault

setRoles

public void setRoles(java.lang.String uid,
                     java.util.Set<java.lang.String> roles)
              throws ServerFault

Specified by:

setRoles in interface IGroup

Parameters:

uid - Group uid

Throws:

ServerFault

getGroupsWithRoles

public java.util.Set<java.lang.String> getGroupsWithRoles(java.util.List<java.lang.String> roles)
                                                   throws ServerFault

Specified by:

getGroupsWithRoles in interface IGroup

Throws:

ServerFault

search

public java.util.List<ItemValue<Group>> search(GroupSearchQuery query)
                                        throws ServerFault

Description copied from interface: IGroup

Search a group

Specified by:

search in interface IGroup

Parameters:

query - group query

Returns:

list of matching groups

Throws:

ServerFault

setExtId

public void setExtId(java.lang.String uid,
                     java.lang.String extId)
              throws ServerFault

Description copied from interface: IDirEntryExtIdSupport

Adds an external id to a DirEntry

Specified by:

setExtId in interface IDirEntryExtIdSupport

Parameters:

uid - the DirEntryQuery's UID

extId - the external id

Throws:

ServerFault - common error object

validate

public ValidationResult validate(java.lang.String[] groupUids)
                          throws ServerFault

Description copied from interface: IInCoreGroupMember

Check that every uid corresponds to an existing group member

Specified by:

validate in interface IInCoreGroupMember

Returns:

Throws:

ServerFault

memberOf

public java.util.List<ItemValue<Group>> memberOf(java.lang.String uid)
                                          throws ServerFault

Description copied from interface: IGroupMember

Retrieves a list of all Groups this uid is member of.

Specified by:

memberOf in interface IGroupMember

Parameters:

uid - the member's unique id

Returns:

a list of groups

Throws:

ServerFault - standard error object (unchecked exception)

memberOfGroups

public java.util.List<java.lang.String> memberOfGroups(java.lang.String uid)
                                                throws ServerFault

Description copied from interface: IGroupMember

Retrieves a list of all Group uids this uid is member of.

Specified by:

memberOfGroups in interface IGroupMember

Parameters:

uid - the member's unique id

Returns:

a list of Group uids

Throws:

ServerFault - standard error object (unchecked exception)