Interface PasswordRecoveryService
public interface PasswordRecoveryService
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddConnector(ChangePasswordConnector connector) booleanallowChangePassword(String username) booleanchangePass(String tokenId, String tokenType, String username, String password) voiddeleteToken(String tokenId, String type) Remove used TokengetExternalRegistrationURL(String tokenId, String lang) getOnboardingURL(String tokenId, String lang) getPasswordRecoverURL(String tokenId, String lang) booleansendAccountCreatedConfirmationEmail(String sender, Locale locale, StringBuilder url) booleansendAccountVerificationEmail(String data, String username, String firstName, String lastName, String email, Locale locale, StringBuilder url) Sends verification email to user to continue registrationsendExternalRegisterEmail(String sender, String email, Locale locale, String space, StringBuilder url) default StringsendExternalRegisterEmail(String sender, String email, Locale locale, String space, StringBuilder url, boolean spaceInvitation) Send An Onboarding email to registered user on the platform.booleansendOnboardingEmail(org.exoplatform.services.organization.User user, Locale defaultLocale, StringBuilder url) booleansendRecoverPasswordEmail(org.exoplatform.services.organization.User user, Locale defaultLocale, jakarta.servlet.http.HttpServletRequest req) verifyToken(String tokenId) verifyToken(String tokenId, String type)
-
Method Details
-
addConnector
-
verifyToken
-
verifyToken
-
changePass
-
sendRecoverPasswordEmail
boolean sendRecoverPasswordEmail(org.exoplatform.services.organization.User user, Locale defaultLocale, jakarta.servlet.http.HttpServletRequest req) -
sendOnboardingEmail
boolean sendOnboardingEmail(org.exoplatform.services.organization.User user, Locale defaultLocale, StringBuilder url) -
sendExternalRegisterEmail
String sendExternalRegisterEmail(String sender, String email, Locale locale, String space, StringBuilder url) throws Exception - Throws:
Exception
-
sendExternalRegisterEmail
default String sendExternalRegisterEmail(String sender, String email, Locale locale, String space, StringBuilder url, boolean spaceInvitation) throws Exception Send An Onboarding email to registered user on the platform. The registration can be made through space invitation or through a register form, thus, the space and sender invitations can be null.- Parameters:
sender- Username who sent the invitation from spaceemail- the invited emaillocale- the userLocalespace- the space from which the user was invitedurl- the base url of the current installationspaceInvitation- whether this is a space invitation or not- Returns:
- generated token for external user registration
- Throws:
Exception- when IDM or any other exception occurs while generating token or sending email
-
sendAccountCreatedConfirmationEmail
-
allowChangePassword
- Throws:
Exception
-
getPasswordRecoverURL
-
getOnboardingURL
-
getExternalRegistrationURL
-
getActiveChangePasswordConnector
ChangePasswordConnector getActiveChangePasswordConnector() -
deleteToken
Remove used Token- Parameters:
tokenId-type-
-
sendAccountVerificationEmail
boolean sendAccountVerificationEmail(String data, String username, String firstName, String lastName, String email, Locale locale, StringBuilder url) Sends verification email to user to continue registration- Parameters:
data-username-firstName-lastName-email-locale-url-- Returns:
- true if sent, else false
-