org.deepamehta.plugins.signup.service

Interface SignupPluginService

All Known Implementing Classes:

SignupPlugin

public interface SignupPluginService

A plugin service to check username or mailbox availability and to send out system or user mailbox notifications.

Version:

1.5.1

Author:

Malte Reiß

Method Summary

Modifier and Type	Method and Description
void	addTemplateResolverBundle(org.osgi.framework.Bundle bundle) IMPORTANT: If you register your own bundle as a resource for thymeleaf templates you must call reinitTemplateEngine afterwards.
String	createAPIWorkspaceMembershipRequest()
String	createSimpleUserAccount(String username, String password, String mailbox) Creates a new user account with mailbox.
String	getUsernameAvailability(String username) Checks for a Topic with the exact "username" value.
com.sun.jersey.api.view.Viewable	handleSignupRequest(String username, String password, String mailbox) Handles a sign-up request in regards to whether an Email based confirmation process is configured (true|false) in the resp.
com.sun.jersey.api.view.Viewable	handleSignupRequest(String username, String password, String mailbox, boolean skipConfirmation) Handles a sign-up request in regards to whether an Email based confirmation process is configured (true|false) in the resp.
javax.ws.rs.core.Response	initiatePasswordReset(String email) Sends out a valid password-reset token (if the email address is known to the system).
boolean	isMailboxTaken(String value)
boolean	isUsernameTaken(String value)
boolean	isValidEmailAddress(String value)
void	reinitTemplateEngine()
void	removeTemplateResolverBundle(org.osgi.framework.Bundle bundle)
void	sendSystemMailboxNotification(String subject, String message) Send notification email to system administrator mailbox configured in current \"Sign-up Configuration\" topic.
void	sendUserMailboxNotification(String mailboxes, String subject, String message) Send notification email to all mailboxes in String (many are seperated by a simple ";" and without spaces.

Method Detail

getUsernameAvailability

String getUsernameAvailability(String username)

Checks for a Topic with the exact "username" value.

Returns:

String JSON-Object with property "isAvailable" set to true or false

createAPIWorkspaceMembershipRequest

String createAPIWorkspaceMembershipRequest()

Returns:

String Workspace Topic ID

handleSignupRequest

com.sun.jersey.api.view.Viewable handleSignupRequest(String username,
                                                     String password,
                                                     String mailbox)

Handles a sign-up request in regards to whether an Email based confirmation process is configured (true|false) in the resp. Sign-up Configuration topic. To check whether a username is already taken you *must* use the getUsernameAvailability() call before issueing an account creation request via this method.

Parameters:

username - String Unique username.

password - String SHA256 encoded password with a prefix of "-SHA26-"

mailbox - String containing a valid Email address related to the account creation request.

Returns:

String username

handleSignupRequest

com.sun.jersey.api.view.Viewable handleSignupRequest(String username,
                                                     String password,
                                                     String mailbox,
                                                     boolean skipConfirmation)

Handles a sign-up request in regards to whether an Email based confirmation process is configured (true|false) in the resp. Sign-up Configuration topic. To check whether a username is already taken you *must* use the getUsernameAvailability() call before issueing an account creation request via this method.

Parameters:

username - String Unique username.

password - String SHA256 encoded password with a prefix of "-SHA26-"

mailbox - String containing a valid Email address related to the account creation request.

skipConfirmation - Boolean if true skips email verification transaction and creates user immediately.

Returns:

String username

initiatePasswordReset

javax.ws.rs.core.Response initiatePasswordReset(String email)
                                         throws URISyntaxException

Sends out a valid password-reset token (if the email address is known to the system).

Parameters:

email -

Returns:

Redirects the request to either "/sign-up/token-info" or "/sign-up/error", depending on the address.

Throws:

URISyntaxException

createSimpleUserAccount

String createSimpleUserAccount(String username,
                               String password,
                               String mailbox)

Creates a new user account with mailbox. If configured, a custom workspace membership is created automatically.

Parameters:

username -

password -

mailbox -

Returns:

isValidEmailAddress

boolean isValidEmailAddress(String value)

isMailboxTaken

boolean isMailboxTaken(String value)

isUsernameTaken

boolean isUsernameTaken(String value)

sendSystemMailboxNotification

void sendSystemMailboxNotification(String subject,
                                   String message)

Send notification email to system administrator mailbox configured in current \"Sign-up Configuration\" topic.

sendUserMailboxNotification

void sendUserMailboxNotification(String mailboxes,
                                 String subject,
                                 String message)

Send notification email to all mailboxes in String (many are seperated by a simple ";" and without spaces.

addTemplateResolverBundle

void addTemplateResolverBundle(org.osgi.framework.Bundle bundle)

IMPORTANT: If you register your own bundle as a resource for thymeleaf templates you must call reinitTemplateEngine afterwards.

removeTemplateResolverBundle

void removeTemplateResolverBundle(org.osgi.framework.Bundle bundle)

reinitTemplateEngine

void reinitTemplateEngine()