001package org.deepamehta.plugins.signup.service;
002
003
004
005/**
006 *
007 * @name dm4-sign-up
008 * @website https://github.com/mukil/dm4-sign-up
009 * @version 1.1-SNAPSHOT
010 * @author <a href="mailto:malte@mikromedia.de">Malte Reissig</a>;
011 */
012
013public interface SignupPluginService {
014
015    /** 
016     * Checks for a Topic with the exact "username" value. 
017     * 
018     * @return  String  JSON-Object with property "isAvailable" set to true or false
019     */
020    String getUsernameAvailability(String username);
021    
022    /** 
023     * Creates a token for username and "E Mail Address" for the creation of a 
024         * new "User Account" topic.
025     * 
026     * @param   password    String Password in cleartext.
027     * 
028     * @return  String  username
029     */
030    String createUserValidationToken(String username, String password, String mailbox);
031
032}