org.hawkular.accounts.api

Interface OrganizationMembershipService

All Known Implementing Classes:

OrganizationMembershipServiceImpl

public interface OrganizationMembershipService

Service intended to manage the memberships that a Persona holds in an Organization. Can be injected via CDI into managed beans as follows:

         @Inject OrganizationMembershipService organizationMembershipService;
     

Concrete implementations do not hold any state, but it's advised to get an instance through CDI or as an EJB.

Author:

Juraci Paixão Kröhling

Method Summary

Modifier and Type	Method and Description
OrganizationMembership	changeRole(OrganizationMembership membership, Role role) Changes the membership and all related data so that the member only has the given role.
OrganizationMembership	create(Organization organization, Persona persona, Role role)
OrganizationMembership	getById(UUID id) Retrieves an OrganizationMembership by its ID.
OrganizationMembership	getMembershipById(String id) Deprecated. Use getById(UUID) instead
List<OrganizationMembership>	getMembershipsForOrganization(Organization organization) Retrieves the memberships for a given Organization.
List<OrganizationMembership>	getMembershipsForPersona(Persona persona) Retrieves the memberships that a given Persona has across all Organizations.
List<OrganizationMembership>	getPersonaMembershipsForOrganization(Persona persona, Organization organization) Retrieves the memberships for a given Organization.
void	remove(OrganizationMembership organizationMembership) Removes the membership from the storage.
void	remove(UUID id) Removes the membership from the storage based on its ID

Method Detail

create

OrganizationMembership create(Organization organization,
                              Persona persona,
                              Role role)

getMembershipsForPersona

List<OrganizationMembership> getMembershipsForPersona(Persona persona)

Retrieves the memberships that a given Persona has across all Organizations.

Example:
User "jdoe" is member of "Operations" with the role "SuperUser"
Organization "Operations" is a member of "Acme, Inc"
Only jdoe's membership as "SuperUser" on "Operations" is returned by this method.

Parameters:

persona - the persona

Returns:

the memberships of this persona across all organizations

getMembershipsForOrganization

List<OrganizationMembership> getMembershipsForOrganization(Organization organization)

Retrieves the memberships for a given Organization.

Parameters:

organization - the organization

Returns:

the memberships of this persona across all organizations

getPersonaMembershipsForOrganization

List<OrganizationMembership> getPersonaMembershipsForOrganization(Persona persona,
                                                                  Organization organization)

Retrieves the memberships for a given Organization.

Parameters:

organization - the organization

Returns:

the memberships of this persona across all organizations

getMembershipById

@Deprecated
OrganizationMembership getMembershipById(String id)

Deprecated. Use getById(UUID) instead

Retrieves an OrganizationMembership by its ID.

Parameters:

id - the ID of the organization membership

Returns:

the membership, or null if it's not found.

getById

OrganizationMembership getById(UUID id)

Retrieves an OrganizationMembership by its ID.

Parameters:

id - the ID of the organization membership

Returns:

the membership, or null if it's not found.

changeRole

OrganizationMembership changeRole(OrganizationMembership membership,
                                  Role role)

Changes the membership and all related data so that the member only has the given role.

Parameters:

membership - the membership to be changed

role - the new role for the membership.

Returns:

an updated membership, which might or not be the same as the original membership.

remove

void remove(OrganizationMembership organizationMembership)

Removes the membership from the storage.

Parameters:

organizationMembership - the membership to remove.

remove

void remove(UUID id)

Removes the membership from the storage based on its ID

Parameters:

id - the membership's ID