SignupPlugin (DeepaMehta 4 Sign up 1.5.3-SNAPSHOT API)

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()

Constructors
Constructor and Description
`SignupPlugin()`

Method Summary

All Methods Instance Methods Concrete Methods
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()` A HTTP resource to associate the requesting username with the "Custom Membership Request" note topic and to inform the administrators by email.
`String`	`createSimpleUserAccount(String username, String password, String mailbox)` Creates a new user account with mailbox.
`com.sun.jersey.api.view.Viewable`	`getAccountCreationOKView(String username)` The route to the confirmation page for the account creation.
`com.sun.jersey.api.view.Viewable`	`getAccountCreationPendingView()` The route to the pending page, informing the user to wait for an administrator to activate the account.
`com.sun.jersey.api.view.Viewable`	`getAccountDetailsView()` The route to the users account edit page.
`com.sun.jersey.api.view.Viewable`	`getConfirmationInfoView()` The route informing users to please check their mail in the next 60mins to verify and activate their new account.
`com.sun.jersey.api.view.Viewable`	`getFailureView()` The route to the error message page.
`com.sun.jersey.api.view.Viewable`	`getLoginView()` The login resource, routing either the login or the logout dialog.
`String`	`getMailboxAvailability(String email)` A HTTP resource allowing existence check fors the given email address string.
`com.sun.jersey.api.view.Viewable`	`getPasswordResetView()` The route for the password forgotton page to initiate a reset sequence.
`com.sun.jersey.api.view.Viewable`	`getSignupFormView()` The root resource, routing either the sign-up or the logout dialog.
`String`	`getTranslationTable(String language)` Fetch all ui-labels in the language the plugins source code was compiled.
`String`	`getUsernameAvailability(String username)` A HTTP resource allowing existence checks for given username strings.
`com.sun.jersey.api.view.Viewable`	`handlePasswordResetRequest(String token)` Checks the given password-reset token for validity and return either the password-reset dialog or the error message page.
`com.sun.jersey.api.view.Viewable`	`handleSignupRequest(String username, String password, String mailbox)` A HTTP resource to create a new user account.
`com.sun.jersey.api.view.Viewable`	`handleSignupRequest(String username, String password, String mailbox, boolean skipConfirmation)` A HTTP resource to create a new user account.
`void`	`init()`
`javax.ws.rs.core.Response`	`initiatePasswordReset(String email)` A HTTP Resource to initiate a password-reset sequence.
`boolean`	`isMailboxTaken(String email)`
`boolean`	`isUsernameTaken(String username)`
`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)` Updates the user password.
`com.sun.jersey.api.view.Viewable`	`processSignupRequest(String key)` The HTTP resource to confirm the email address and acutally create an account.
`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)
```
    Fetch all ui-labels in the language the plugins source code was compiled.
    
    Parameters:
    
    language -
    
    Returns:
    
    A String containing a JSONObject with key-value pairs of all multilingual labels.
  - getUsernameAvailability
```
public String getUsernameAvailability(String username)
```
    A HTTP resource allowing existence checks for given username strings.
    
    Specified by:
    
    getUsernameAvailability in interface SignupPluginService
    
    Parameters:
    
    username -
    
    Returns:
    
    A String being a JSONObject with an "isAvailable" property being either "true" or "false". If the username is already taken isAvailable is set to false.
  - getMailboxAvailability
```
public String getMailboxAvailability(String email)
```
    A HTTP resource allowing existence check fors the given email address string.
    
    Parameters:
    
    email -
    
    Returns:
    
    A String being a JSONObject with an "isAvailable" property being either "true" or "false". If the email address is already known in the system isAvailable is set to false.
  - initiatePasswordReset
```
public javax.ws.rs.core.Response initiatePasswordReset(String email)
                                                throws URISyntaxException
```
    A HTTP Resource to initiate a password-reset sequence. Creates a password-reset token and sends it out as link via Email. Redirects the request to either the "token info" or the "error message" page.
    
    Specified by:
    
    initiatePasswordReset in interface SignupPluginService
    
    Parameters:
    
    email -
    
    Returns:
    
    A Response.temporaryRedirect to either the "token info" or the "error message" page.
    
    Throws:
    
    URISyntaxException
  - handlePasswordResetRequest
```
public com.sun.jersey.api.view.Viewable handlePasswordResetRequest(String token)
```
    Checks the given password-reset token for validity and return either the password-reset dialog or the error message page.
    
    Parameters:
    
    token -
    
    Returns:
    
    The correct dialog/template for the given password-reset token value.
  - processPasswordUpdateRequest
```
public com.sun.jersey.api.view.Viewable processPasswordUpdateRequest(String token,
                                                                     String password)
```
    Updates the user password.
    
    Parameters:
    
    token -
    
    password -
    
    Returns:
    
    Returns the correct template for the input.
  - handleSignupRequest
```
public com.sun.jersey.api.view.Viewable handleSignupRequest(String username,
                                                            String password,
                                                            String mailbox,
                                                            boolean skipConfirmation)
```
    A HTTP resource to create a new user account.
    
    Specified by:
    
    handleSignupRequest in interface SignupPluginService
    
    Parameters:
    
    username - String must be unique
    
    password - String must be SHA-256 encoded
    
    mailbox - String must be unique
    
    skipConfirmation - Flag if "true" skips intiating the email verification process (useful to allow admins to create new accounts without verifying users).
    
    Returns:
  - handleSignupRequest
```
public com.sun.jersey.api.view.Viewable handleSignupRequest(String username,
                                                            String password,
                                                            String mailbox)
```
    A HTTP resource to create a new user account.
    
    Specified by:
    
    handleSignupRequest in interface SignupPluginService
    
    Parameters:
    
    username - String must be unique
    
    password - String must be SHA-256 encoded
    
    mailbox - String must be unique
    
    Returns:
  - processSignupRequest
```
public com.sun.jersey.api.view.Viewable processSignupRequest(String key)
```
    The HTTP resource to confirm the email address and acutally create an account.
    
    Parameters:
    
    key - String must be a valid token
    
    Returns:
  - createAPIWorkspaceMembershipRequest
```
public String createAPIWorkspaceMembershipRequest()
```
    A HTTP resource to associate the requesting username with the "Custom Membership Request" note topic and to inform the administrators by email.
    
    Specified by:
    
    createAPIWorkspaceMembershipRequest in interface SignupPluginService
    
    Returns:
    
    String containing a JSONObject with an "membership_created" r´property representing the relation.
  - 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()
```
    The root resource, routing either the sign-up or the logout dialog.
    
    Returns:
  - getLoginView
```
public com.sun.jersey.api.view.Viewable getLoginView()
```
    The login resource, routing either the login or the logout dialog.
    
    Returns:
  - getPasswordResetView
```
public com.sun.jersey.api.view.Viewable getPasswordResetView()
```
    The route for the password forgotton page to initiate a reset sequence.
    
    Returns:
  - getAccountCreationOKView
```
public com.sun.jersey.api.view.Viewable getAccountCreationOKView(String username)
```
    The route to the confirmation page for the account creation.
    
    Parameters:
    
    username -
    
    Returns:
  - getAccountCreationPendingView
```
public com.sun.jersey.api.view.Viewable getAccountCreationPendingView()
```
    The route to the pending page, informing the user to wait for an administrator to activate the account.
    
    Returns:
  - getFailureView
```
public com.sun.jersey.api.view.Viewable getFailureView()
```
    The route to the error message page.
    
    Returns:
  - getConfirmationInfoView
```
public com.sun.jersey.api.view.Viewable getConfirmationInfoView()
```
    The route informing users to please check their mail in the next 60mins to verify and activate their new account.
    
    Returns:
  - getAccountDetailsView
```
public com.sun.jersey.api.view.Viewable getAccountDetailsView()
```
    The route to the users account edit page.
    
    Returns:
  - 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
  - createSimpleUserAccount
```
public String createSimpleUserAccount(String username,
                                      String password,
                                      String mailbox)
```
    Description copied from interface: SignupPluginService
    
    Creates a new user account with mailbox. If configured, a custom workspace membership is created automatically.
    
    Specified by:
    
    createSimpleUserAccount in interface SignupPluginService
    
    Returns:
  - isMailboxTaken
```
public boolean isMailboxTaken(String email)
```
    Specified by:
    
    isMailboxTaken in interface SignupPluginService
  - isUsernameTaken
```
public boolean isUsernameTaken(String username)
```
    Specified by:
    
    isUsernameTaken 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

Class SignupPlugin

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class de.deepamehta.thymeleaf.ThymeleafPlugin

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

Methods inherited from class java.lang.Object

Field Detail

MAILBOX_TYPE_URI

DM4_HOST_URL

DM4_ACCOUNTS_ENABLED

CONFIG_TOPIC_ACCOUNT_ENABLED

Constructor Detail

SignupPlugin

Method Detail

init

getTranslationTable

getUsernameAvailability

getMailboxAvailability

initiatePasswordReset

handlePasswordResetRequest

processPasswordUpdateRequest

handleSignupRequest

handleSignupRequest

processSignupRequest

createAPIWorkspaceMembershipRequest

postUpdateTopic

getSignupFormView

getLoginView

getPasswordResetView

getAccountCreationOKView

getAccountCreationPendingView

getFailureView

getConfirmationInfoView

getAccountDetailsView

sendSystemMailboxNotification

sendUserMailboxNotification

createSimpleUserAccount

isMailboxTaken

isUsernameTaken

isValidEmailAddress

reinitTemplateEngine

addTemplateResolverBundle

removeTemplateResolverBundle