Interface OpenIdRegistrationService

All Known Implementing Classes:

OpenIdRegistrationServiceImpl

public interface OpenIdRegistrationService

Method Summary

Modifier and Type	Method	Description
Optional<Entity>	getMatchingPrincipal(@Nullable String emailAddress)	Searchs for a matching principal using a given emailAddress 1.
String	registerOpenIdUser(Entity provider, Entity principal, String subject, String sourceUrl)	Saves the registration data to a "Openid_link_information" entity and returns the generated uuid.
String	sendRegistrationMail(Entity principal, @Nullable String registrationIdentifier, String uuid)	Sends the registration mail (email template "sso_registration_mail") Resolves the user linked to the principal and uses this user as mail recipient.

Method Details

getMatchingPrincipal

Optional<Entity> getMatchingPrincipal(@Nullable String emailAddress)

Searchs for a matching principal using a given emailAddress 1. Checks if there is a principal with the emailAddress as 'username' if so, return this Principal 2. Checks if there exactly one Principal that is linked with a user using the given emailAddress. If so, return it.

Returns:

identified principal or absent if we were not able to find a unique match

registerOpenIdUser

String registerOpenIdUser(Entity provider,
 Entity principal,
 String subject,
 String sourceUrl)

Saves the registration data to a "Openid_link_information" entity and returns the generated uuid.

Returns:

the generated uuid

sendRegistrationMail

String sendRegistrationMail(Entity principal,
 @Nullable String registrationIdentifier,
 String uuid)
                     throws MailException

Sends the registration mail (email template "sso_registration_mail") Resolves the user linked to the principal and uses this user as mail recipient. If no email address is set on the user, the registrationIdentifier is used as fallback email address.

Parameters:

principal - the target principal to notify

registrationIdentifier - the registration identifier that was used to resolve the principal

uuid - the registration uuid (return value of registerOpenIdUser)

Returns:

the email address to which the email was sent

Throws:

MailException