org.exoplatform.services.organization

Interface MembershipHandler

public interface MembershipHandler

Created by The eXo Platform SAS
This interface is a sub part of the organization service. It is used to manage the memberships - the relation of user , group, and membership type - and broadcast the membership events to all the registered listeners in the organization service. The membership event can be: new linked membership and delete the membership type event. Each event should have 2 phases: pre event and post event. The method linkMembership(..) and removeMembership(..) broadcast the event at each phase so the listeners can handle the event properly

Author:

Tuan Nguyen

Level API:

Platform

Method Summary

Methods

Modifier and Type	Method and Description
void	addMembershipEventListener(MembershipEventListener listener) Use this method to register a membership event listener.
void	createMembership(Membership m, boolean broadcast) Deprecated. This method should no be called, use the linkMembership(..) instead
Membership	createMembershipInstance() Deprecated. This method should not be called, use the linkMembership instead.
ListAccess<Membership>	findAllMembershipsByGroup(Group group) Use this method to find all the membership in a group.
Membership	findMembership(String id) Use this method to search for an mebership record with the given id
Membership	findMembershipByUserGroupAndType(String userName, String groupId, String type) Use this method to search for a specific membership type of an user in a group.
Collection	findMembershipsByGroup(Group group) Deprecated. This method should no be called, use findAllMembershipsByGroup(Group) instead
Collection	findMembershipsByUser(String userName) Use this method to find all the memberships of an user in any group.
Collection	findMembershipsByUserAndGroup(String userName, String groupId) Use this method to find all the memberships of an user in a group
void	linkMembership(User user, Group group, MembershipType m, boolean broadcast) Use this method to create a membership record, a relation of the user, group and membership type.
Membership	removeMembership(String id, boolean broadcast) Use this method to remove a membership.
Collection	removeMembershipByUser(String username, boolean broadcast) Use this method to remove all user's membership.
void	removeMembershipEventListener(MembershipEventListener listener) Use this method to unregister a membership event listener.

Method Detail

createMembershipInstance

Membership createMembershipInstance()

Deprecated. This method should not be called, use the linkMembership instead.

createMembership

void createMembership(Membership m,
                    boolean broadcast)
                      throws Exception

Deprecated. This method should no be called, use the linkMembership(..) instead

Throws:

Exception

linkMembership

void linkMembership(User user,
                  Group group,
                  MembershipType m,
                  boolean broadcast)
                    throws Exception

Use this method to create a membership record, a relation of the user, group and membership type. Doesn't throw an Exception if membership record with the same user, group and membership type exists.

Parameters:

user - The user of the membership

group - The group of the membership

m - The MembershipType of the membership

broadcast - Broadcast the event if the value of the broadcast is 'true'

Throws:

Exception - An exception is thrown if the method is fail to access the database, membership type not existed or any listener fail to handle the event.

removeMembership

Membership removeMembership(String id,
                          boolean broadcast)
                            throws Exception

Use this method to remove a membership. Usually you need to call the method findMembershipByUserGroupAndType(..) to find the membership and remove.

Parameters:

id - The id of the membership

broadcast - Broadcast the event to the registered listeners if the broadcast event is 'true'

Returns:

The membership object which has been removed from the database

Throws:

Exception - An exception is throwed if the method cannot access the database or any listener fail to handle the event.

removeMembershipByUser

Collection removeMembershipByUser(String username,
                                boolean broadcast)
                                  throws Exception

Use this method to remove all user's membership.

Parameters:

username - The username which user object need remove memberships

broadcast - Broadcast the event to the registered listeners if the broadcast event is 'true'

Returns:

The membership object which has been removed from the database

Throws:

Exception - An exception is throwed if the method cannot access the database or any listener fail to handle the event.

findMembership

Membership findMembership(String id)
                          throws Exception

Use this method to search for an mebership record with the given id

Parameters:

id - The id of the mebership

Returns:

Return The membership object that matched the id

Throws:

Exception - An exception is throwed if the method fail to access the database or no membership is found.

findMembershipByUserGroupAndType

Membership findMembershipByUserGroupAndType(String userName,
                                          String groupId,
                                          String type)
                                            throws Exception

Use this method to search for a specific membership type of an user in a group.

Parameters:

userName - The username of the user.

groupId - The group identifier

type - The membership type

Returns:

Null if no such memberhsip record or a membership object.

Throws:

Exception - Usually an exception is thrown if the method cannot access the database

findMembershipsByUserAndGroup

Collection findMembershipsByUserAndGroup(String userName,
                                       String groupId)
                                         throws Exception

Use this method to find all the memberships of an user in a group

Parameters:

userName -

groupId -

Returns:

A collection of the membership of an user in a group. The collection cannot be null and the collection should be empty is no membership is found

Throws:

Exception - Usually an exception is thrown if the method cannot access the database.

findMembershipsByUser

Collection findMembershipsByUser(String userName)
                                 throws Exception

Use this method to find all the memberships of an user in any group.

Parameters:

userName -

Returns:

A collection of the memebership. The collection cannot be null and if no membership is found , the collection should be empty

Throws:

Exception - Usually an exception is throwed if the method cannot access the database.

findMembershipsByGroup

Collection findMembershipsByGroup(Group group)
                                  throws Exception

Deprecated. This method should no be called, use findAllMembershipsByGroup(Group) instead

Use this method to find all the membership in a group. Note that an user can have more than one membership in a group. For example , user admin can have meberhsip 'member' and 'admin' in the group '/users'

Parameters:

group -

Returns:

A collection of the memberships. The collection cannot be none and empty if no membership is found.

Throws:

Exception

findAllMembershipsByGroup

ListAccess<Membership> findAllMembershipsByGroup(Group group)
                                                 throws Exception

Use this method to find all the membership in a group. Note that an user can have more than one membership in a group. For example , user admin can have meberhsip 'member' and 'admin' in the group '/users'

Parameters:

group -

Returns:

the list of the memberships

Throws:

Exception

addMembershipEventListener

void addMembershipEventListener(MembershipEventListener listener)

Use this method to register a membership event listener.

Parameters:

listener - the listener instance.

removeMembershipEventListener

void removeMembershipEventListener(MembershipEventListener listener)

Use this method to unregister a membership event listener.

Parameters:

listener - the listener instance.