org.hawkular.accounts.api

Interface OrganizationService

All Known Implementing Classes:

OrganizationServiceImpl

public interface OrganizationService

Service intended to handle data related to an Organization. Can be injected via CDI into managed beans as follows:

         @Inject OrganizationService organizationService;
     

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

NOTE: At this moment, it is possible to add organizations to other organizations, but this behavior is currently blocked on the main REST endpoint (see the 'accounts' module).

Author:

Juraci Paixão Kröhling

Method Summary

Modifier and Type	Method and Description
Organization	createOrganization(String name, String description, Persona owner) Creates a new organization and a "SuperUser" membership for the persona.
void	deleteOrganization(Organization organization) Removes the organization and all related memberships
Organization	get(String id) Deprecated. use getById(UUID) instead.
Organization	getById(UUID id) Retrieves an Organization based on its ID.
Organization	getByName(String name) Retrieves an Organization based on its name.
List<Organization>	getOrganizationsForPersona(Persona persona) Retrieves the Organizations to which a given Persona directly is member/owner of.
List<Organization>	getOrganizationsFromMemberships(List<OrganizationMembership> memberships) Extracts all organizations from a list of memberships.
List<Organization>	getSubOrganizations(Organization organization) Retrieves all the organizations whose parent is the given organization.
void	transfer(Organization organization, Persona newOwner) Transfers the organization from the current owner to the specified persona.

Method Detail

getOrganizationsForPersona

List<Organization> getOrganizationsForPersona(Persona persona)

Retrieves the Organizations to which a given Persona directly is member/owner of.

Example:
User "jdoe" is member of "Operations"
Organization "Operations" is a member of "Acme, Inc"
Only "Operations" is returned by this method.

Parameters:

persona - the persona

Returns:

the organizations this persona directly belongs to or null if this persona doesn't belongs to any organizations.

getOrganizationsFromMemberships

List<Organization> getOrganizationsFromMemberships(List<OrganizationMembership> memberships)

Extracts all organizations from a list of memberships.

Parameters:

memberships - the list of OrganizationMembership

Returns:

a collection of Organization extracted from the memberships

createOrganization

Organization createOrganization(String name,
                                String description,
                                Persona owner)

Creates a new organization and a "SuperUser" membership for the persona.

Parameters:

name - the organization's name

description - the organization's description

owner - the persona that owns the organization

Returns:

the newly created organization

deleteOrganization

void deleteOrganization(Organization organization)

Removes the organization and all related memberships

Parameters:

organization - the organization to be removed

transfer

void transfer(Organization organization,
              Persona newOwner)

Transfers the organization from the current owner to the specified persona.

Parameters:

organization - the organization to have the ownership changed

newOwner - the new owner

getById

Organization getById(UUID id)

Retrieves an Organization based on its ID.

Parameters:

id - the organization's ID

Returns:

the existing Organization or null if the resource doesn't exists.

Throws:

IllegalArgumentException - if the given ID is null

getByName

Organization getByName(String name)

Retrieves an Organization based on its name.

Parameters:

name - the organization's name

Returns:

the existing Organization or null if the resource doesn't exists.

Throws:

IllegalArgumentException - if the given name is null

get

@Deprecated
Organization get(String id)

Deprecated. use getById(UUID) instead.

Retrieves an Organization based on its ID.

Parameters:

id - the organization's ID

Returns:

the existing Organization or null if the resource doesn't exists.

Throws:

IllegalArgumentException - if the given ID is null

getSubOrganizations

List<Organization> getSubOrganizations(Organization organization)

Retrieves all the organizations whose parent is the given organization.

Parameters:

organization - the parent organization

Returns:

a list of direct sub organizations