org.deepamehta.plugins.signup

Class SignupPlugin

java.lang.Object

de.deepamehta.core.osgi.PluginActivator

de.deepamehta.thymeleaf.ThymeleafPlugin

org.deepamehta.plugins.signup.SignupPlugin

All Implemented Interfaces:

de.deepamehta.core.osgi.PluginContext, de.deepamehta.core.service.event.PostUpdateTopicListener, de.deepamehta.core.service.event.ServiceRequestFilterListener, de.deepamehta.core.service.EventListener, SignupPluginService, org.osgi.framework.BundleActivator

public class SignupPlugin
extends de.deepamehta.thymeleaf.ThymeleafPlugin
implements SignupPluginService, de.deepamehta.core.service.event.PostUpdateTopicListener

This plugin enables anonymous users to create themselves a user account in DeepaMehta 4 through an (optional) Email based confirmation workflow and thus it critically depends on a e.g. postfix like "internet" installation for "localhost". Source code available at: https://github.com/mukil/dm4-sign-up

Version:

1.5.1

Author:

Malte Reiß

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_TOPIC_ACCOUNT_ENABLED
static boolean	DM4_ACCOUNTS_ENABLED
static String	DM4_HOST_URL
static String	MAILBOX_TYPE_URI

Fields inherited from class de.deepamehta.core.osgi.PluginActivator

bundle, dm4, mf

Constructor Summary

Constructors

Constructor and Description
SignupPlugin()

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()
com.sun.jersey.api.view.Viewable	getAccountCreationOKView(String username)
com.sun.jersey.api.view.Viewable	getAccountCreationPendingView()
com.sun.jersey.api.view.Viewable	getAccountDetailsView()
com.sun.jersey.api.view.Viewable	getConfirmationInfoView()
com.sun.jersey.api.view.Viewable	getFailureView()
com.sun.jersey.api.view.Viewable	getLoginView()
String	getMailboxAvailability(String email)
com.sun.jersey.api.view.Viewable	getPasswordResetView()
com.sun.jersey.api.view.Viewable	getSignupFormView()
String	getTranslationTable(String language)
String	getUsernameAvailability(String username) Checks for a Topic with the exact "username" value.
com.sun.jersey.api.view.Viewable	handlePasswordResetRequest(String token)
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)
void	init()
javax.ws.rs.core.Response	initiatePasswordReset(String email)
boolean	isMailboxTaken(String email)
boolean	isValidEmailAddress(String value)
void	postUpdateTopic(de.deepamehta.core.Topic topic, de.deepamehta.core.model.TopicModel tm, de.deepamehta.core.model.TopicModel tm1)
com.sun.jersey.api.view.Viewable	processPasswordUpdateRequest(String token, String password)
com.sun.jersey.api.view.Viewable	processSignupRequest(String key)
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 mailbox, String subject, String message) Send notification email to all mailboxes in String (many are seperated by a simple ";" and without spaces.

Methods inherited from class de.deepamehta.thymeleaf.ThymeleafPlugin

addTemplateResourceBundle, getTemplateEngine, initTemplateEngine, removeTemplateResourceBundle, serviceRequestFilter, view, viewData

Methods inherited from class de.deepamehta.core.osgi.PluginActivator

getBundleContext, getPluginName, getStaticResource, getUri, preInstall, publishFileSystem, serviceArrived, serviceGone, setCoreService, shutdown, start, stop, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAILBOX_TYPE_URI

public static final String MAILBOX_TYPE_URI

See Also:

Constant Field Values

DM4_HOST_URL

public static final String DM4_HOST_URL

DM4_ACCOUNTS_ENABLED

public static final boolean DM4_ACCOUNTS_ENABLED

CONFIG_TOPIC_ACCOUNT_ENABLED

public static final String CONFIG_TOPIC_ACCOUNT_ENABLED

See Also:

Constant Field Values

Constructor Detail

SignupPlugin

public SignupPlugin()

Method Detail

init

public void init()

Specified by:

init in interface de.deepamehta.core.osgi.PluginContext

Overrides:

init in class de.deepamehta.core.osgi.PluginActivator

getTranslationTable

public String getTranslationTable(String language)

getUsernameAvailability

public String getUsernameAvailability(String username)

Description copied from interface: SignupPluginService

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

Specified by:

getUsernameAvailability in interface SignupPluginService

Returns:

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

getMailboxAvailability

public String getMailboxAvailability(String email)

initiatePasswordReset

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

Throws:

URISyntaxException

handlePasswordResetRequest

public com.sun.jersey.api.view.Viewable handlePasswordResetRequest(String token)

processPasswordUpdateRequest

public com.sun.jersey.api.view.Viewable processPasswordUpdateRequest(String token,
                                                                     String password)

handleSignupRequest

public com.sun.jersey.api.view.Viewable handleSignupRequest(String username,
                                                            String password,
                                                            String mailbox,
                                                            boolean skipConfirmation)
                                                     throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException

handleSignupRequest

public com.sun.jersey.api.view.Viewable handleSignupRequest(String username,
                                                            String password,
                                                            String mailbox)
                                                     throws javax.ws.rs.WebApplicationException

Description copied from interface: SignupPluginService

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.

Specified by:

handleSignupRequest in interface SignupPluginService

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

Throws:

javax.ws.rs.WebApplicationException

processSignupRequest

public com.sun.jersey.api.view.Viewable processSignupRequest(String key)

createAPIWorkspaceMembershipRequest

public String createAPIWorkspaceMembershipRequest()

Specified by:

createAPIWorkspaceMembershipRequest in interface SignupPluginService

Returns:

String Workspace Topic ID

postUpdateTopic

public void postUpdateTopic(de.deepamehta.core.Topic topic,
                            de.deepamehta.core.model.TopicModel tm,
                            de.deepamehta.core.model.TopicModel tm1)

Specified by:

postUpdateTopic in interface de.deepamehta.core.service.event.PostUpdateTopicListener

getSignupFormView

public com.sun.jersey.api.view.Viewable getSignupFormView()

getLoginView

public com.sun.jersey.api.view.Viewable getLoginView()

getPasswordResetView

public com.sun.jersey.api.view.Viewable getPasswordResetView()

getAccountCreationOKView

public com.sun.jersey.api.view.Viewable getAccountCreationOKView(String username)

getAccountCreationPendingView

public com.sun.jersey.api.view.Viewable getAccountCreationPendingView()

getFailureView

public com.sun.jersey.api.view.Viewable getFailureView()

getConfirmationInfoView

public com.sun.jersey.api.view.Viewable getConfirmationInfoView()

getAccountDetailsView

public com.sun.jersey.api.view.Viewable getAccountDetailsView()

sendSystemMailboxNotification

public void sendSystemMailboxNotification(String subject,
                                          String message)

Description copied from interface: SignupPluginService

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

Specified by:

sendSystemMailboxNotification in interface SignupPluginService

sendUserMailboxNotification

public void sendUserMailboxNotification(String mailbox,
                                        String subject,
                                        String message)

Description copied from interface: SignupPluginService

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

Specified by:

sendUserMailboxNotification in interface SignupPluginService

isMailboxTaken

public boolean isMailboxTaken(String email)

Specified by:

isMailboxTaken in interface SignupPluginService

isValidEmailAddress

public boolean isValidEmailAddress(String value)

Specified by:

isValidEmailAddress in interface SignupPluginService

reinitTemplateEngine

public void reinitTemplateEngine()

Specified by:

reinitTemplateEngine in interface SignupPluginService

addTemplateResolverBundle

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

Description copied from interface: SignupPluginService

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

Specified by:

addTemplateResolverBundle in interface SignupPluginService

removeTemplateResolverBundle

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

Specified by:

removeTemplateResolverBundle in interface SignupPluginService