org.hawkular.accounts.api

Interface InvitationService

All Known Implementing Classes:

InvitationServiceImpl

public interface InvitationService

Author:

Juraci Paixão Kröhling

Method Summary

Modifier and Type	Method and Description
Invitation	accept(Invitation invitation, HawkularUser user) Marks an invitation as accepted, converting the data from Invitation into an OrganizationMembership
Invitation	create(String email, HawkularUser invitedBy, Organization organization, Role role) Stores an invitation with the given parameters.
Invitation	get(String id) Deprecated. Use getById(UUID) instead.
Invitation	getById(UUID token) Retrieves an Invitation based on the token.
Invitation	getByToken(String token) Deprecated. Use getById(UUID) instead.
List<Invitation>	getInvitationsForOrganization(Organization organization) Retrieves all invitations for the given organization.
List<Invitation>	getPendingInvitationsForOrganization(Organization organization) Retrieves the pending invitations for the given organization.
void	markAsDispatched(Invitation invitation) Marks the given invitation as dispatched.
void	remove(Invitation invitation) Remove the invitation from the storage.

Method Detail

getByToken

@Deprecated
Invitation getByToken(String token)

Deprecated. Use getById(UUID) instead.

Retrieves an Invitation based on the token.

Parameters:

token - the token that was received by the invited user

Returns:

the invitation related to the token

getById

Invitation getById(UUID token)

Retrieves an Invitation based on the token.

Parameters:

token - the token that was received by the invited user

Returns:

the invitation related to the token

get

@Deprecated
Invitation get(String id)

Deprecated. Use getById(UUID) instead.

Retrieves an Invitation based on the ID.

Parameters:

id - the invitation's ID

Returns:

the invitation

getPendingInvitationsForOrganization

List<Invitation> getPendingInvitationsForOrganization(Organization organization)

Retrieves the pending invitations for the given organization.

Parameters:

organization - the organization of which pending invitations are queried from.

Returns:

a List of Invitation which are not accepted yet.

getInvitationsForOrganization

List<Invitation> getInvitationsForOrganization(Organization organization)

Retrieves all invitations for the given organization.

Parameters:

organization - the organization of the invitations are queried from.

Returns:

a List of all Invitations

create

Invitation create(String email,
                  HawkularUser invitedBy,
                  Organization organization,
                  Role role)

Stores an invitation with the given parameters.

Parameters:

email - the user that has been invited

invitedBy - the user who sent the invitation

organization - the organization for which the user was invited to

role - the role on the organization for the invited user

Returns:

the persistent Invitation

accept

Invitation accept(Invitation invitation,
                  HawkularUser user)

Marks an invitation as accepted, converting the data from Invitation into an OrganizationMembership

Parameters:

invitation - the invitation to be accepted

user - the user that is accepting the invitation

Returns:

the updated invitation

remove

void remove(Invitation invitation)

Remove the invitation from the storage.

Parameters:

invitation - the invitation to be removed

markAsDispatched

void markAsDispatched(Invitation invitation)

Marks the given invitation as dispatched.

Parameters:

invitation - the invitation to mark as dispatched