org.deepamehta.plugins.signup

Class SignupPlugin

Show UML class diagram

java.lang.Object

de.deepamehta.core.osgi.PluginActivator

de.deepamehta.plugins.webactivator.WebActivatorPlugin

org.deepamehta.plugins.signup.SignupPlugin

All Implemented Interfaces:

PluginContext, PostUpdateTopicListener, ServiceRequestFilterListener, EventListener, SignupPluginService, org.osgi.framework.BundleActivator

public class SignupPlugin
extends de.deepamehta.plugins.webactivator.WebActivatorPlugin
implements SignupPluginService, PostUpdateTopicListener

Routes registerd by this plugin are: / => login-form /sign-up => signup-form /ok => info-page after account creation

Version:

1.1-SNAPSHOT

Author:

Malte Reissig;

Field Summary

Fields

Modifier and Type	Field and Description
private AccessControlService	acService
private String	CONFIG_CSS_PATH
private String	CONFIG_LOGO_PATH
private String	CONFIG_PAGES_FOOTER
private String	CONFIG_PD_DETAILS
private String	CONFIG_PD_LABEL
private String	CONFIG_PROJECT_TITLE
private String	CONFIG_READ_MORE_URL
private String	CONFIG_TOS_DETAILS
private String	CONFIG_TOS_LABEL
private String	CONFIG_WEBAPP_TITLE
private Topic	currentModuleConfiguration
private static Logger	log
static String	MAILBOX_TYPE_URI
private String	SIGN_UP_CONFIG_TYPE_URI
private String	SIGN_UP_PLUGIN_TOPIC_URI
(package private) HashMap<String,org.codehaus.jettison.json.JSONObject>	token
(package private) javax.ws.rs.core.UriInfo	uri
(package private) static DeepaMehtaEvent	USER_ACCOUNT_CREATE_LISTENER
static String	WS_DM_DEFAULT_URI
private WorkspacesService	wsService

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

bundle, dms

Constructor Summary

Constructors

Constructor and Description
SignupPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
private String	createSimpleUserAccount(String username, String password, String mailbox)
String	createUserValidationToken(String username, String password, String mailbox) Creates a token for username and "E Mail Address" for the creation of a new "User Account" topic.
com.sun.jersey.api.view.Viewable	getAccountCreationOKView()
com.sun.jersey.api.view.Viewable	getConfirmationInfoView()
private Topic	getCurrentSignupConfiguration() The sign-up configuration object is loaded once when this bundle/plugin is initialized by the framework and as soon as one configuration was edited.
com.sun.jersey.api.view.Viewable	getFailureView()
com.sun.jersey.api.view.Viewable	getLoginFormView() --- Sign-up Routes ---
String	getMailboxAvailability(String email)
com.sun.jersey.api.view.Viewable	getSignupFormView()
String	getUsernameAvailability(String username) Plugin Service Implementation
com.sun.jersey.api.view.Viewable	handleTokenRequest(String key)
void	init()
private boolean	isMailboxTaken(String email)
private boolean	isUsernameTaken(String username)
void	postUpdateTopic(Topic topic, TopicModel tm, TopicModel tm1)
private void	prepareSignupPage()
private Topic	reloadConfiguration() Loads the next sign-up configuration topic for this plugin.
private void	sendConfirmationMail(String key, String username, String mailbox)
private void	sendNotificationMail(String username, String mailbox)
private void	sendSystemMail(String subject, String message, String recipient)

Methods inherited from class de.deepamehta.plugins.webactivator.WebActivatorPlugin

getTemplateEngine, initTemplateEngine, 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

log

private static Logger log

MAILBOX_TYPE_URI

public static final String MAILBOX_TYPE_URI

See Also:

Constant Field Values

WS_DM_DEFAULT_URI

public static final String WS_DM_DEFAULT_URI

See Also:

Constant Field Values

SIGN_UP_PLUGIN_TOPIC_URI

private final String SIGN_UP_PLUGIN_TOPIC_URI

See Also:

Constant Field Values

SIGN_UP_CONFIG_TYPE_URI

private final String SIGN_UP_CONFIG_TYPE_URI

See Also:

Constant Field Values

CONFIG_PROJECT_TITLE

private final String CONFIG_PROJECT_TITLE

See Also:

Constant Field Values

CONFIG_WEBAPP_TITLE

private final String CONFIG_WEBAPP_TITLE

See Also:

Constant Field Values

CONFIG_LOGO_PATH

private final String CONFIG_LOGO_PATH

See Also:

Constant Field Values

CONFIG_CSS_PATH

private final String CONFIG_CSS_PATH

See Also:

Constant Field Values

CONFIG_READ_MORE_URL

private final String CONFIG_READ_MORE_URL

See Also:

Constant Field Values

CONFIG_PAGES_FOOTER

private final String CONFIG_PAGES_FOOTER

See Also:

Constant Field Values

CONFIG_TOS_LABEL

private final String CONFIG_TOS_LABEL

See Also:

Constant Field Values

CONFIG_TOS_DETAILS

private final String CONFIG_TOS_DETAILS

See Also:

Constant Field Values

CONFIG_PD_LABEL

private final String CONFIG_PD_LABEL

See Also:

Constant Field Values

CONFIG_PD_DETAILS

private final String CONFIG_PD_DETAILS

See Also:

Constant Field Values

currentModuleConfiguration

private Topic currentModuleConfiguration

acService

private AccessControlService acService

wsService

private WorkspacesService wsService

uri

@Context
javax.ws.rs.core.UriInfo uri

token

HashMap<String,org.codehaus.jettison.json.JSONObject> token

USER_ACCOUNT_CREATE_LISTENER

static DeepaMehtaEvent USER_ACCOUNT_CREATE_LISTENER

Constructor Detail

SignupPlugin

public SignupPlugin()

Method Detail

init

public void init()

Specified by:

init in interface PluginContext

Overrides:

init in class PluginActivator

getUsernameAvailability

public String getUsernameAvailability(String username)

Plugin Service Implementation

Specified by:

getUsernameAvailability in interface SignupPluginService

Returns:

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

getMailboxAvailability

public String getMailboxAvailability(String email)

createSimpleUserAccount

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

createUserValidationToken

public String createUserValidationToken(String username,
                               String password,
                               String mailbox)

Description copied from interface: SignupPluginService

Creates a token for username and "E Mail Address" for the creation of a new "User Account" topic.

Specified by:

createUserValidationToken in interface SignupPluginService

password - String Password in cleartext.

Returns:

String username

handleTokenRequest

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

reloadConfiguration

private Topic reloadConfiguration()

Loads the next sign-up configuration topic for this plugin.

See Also:

init(), postUpdateTopic()

sendConfirmationMail

private void sendConfirmationMail(String key,
                        String username,
                        String mailbox)

sendNotificationMail

private void sendNotificationMail(String username,
                        String mailbox)

sendSystemMail

private void sendSystemMail(String subject,
                  String message,
                  String recipient)

isUsernameTaken

private boolean isUsernameTaken(String username)

isMailboxTaken

private boolean isMailboxTaken(String email)

getCurrentSignupConfiguration

private Topic getCurrentSignupConfiguration()

The sign-up configuration object is loaded once when this bundle/plugin is initialized by the framework and as soon as one configuration was edited.

See Also:

reloadConfiguration()

getLoginFormView

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

--- Sign-up Routes ---

getSignupFormView

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

getAccountCreationOKView

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

getFailureView

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

getConfirmationInfoView

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

prepareSignupPage

private void prepareSignupPage()

postUpdateTopic

public void postUpdateTopic(Topic topic,
                   TopicModel tm,
                   TopicModel tm1)

Specified by:

postUpdateTopic in interface PostUpdateTopicListener