com.jivesoftware.community
Interface RegistrationManager

All Superinterfaces:

JiveManager

public interface RegistrationManager
extends JiveManager

Manages validation settings and validating new user accounts.

Field Summary

static String	PROPERTY_ACCOUNT_CREATION_ENABLED
static String	PROPERTY_EMAIL_BODY
static String	PROPERTY_EMAIL_SUBJECT
static String	PROPERTY_HUMAN_VALIDATION_ENABLED
static String	PROPERTY_TERMS_ENABLED
static String	PROPERTY_TERMS_URL
static String	PROPERTY_USER_VALIDATION_KEY
static String	PROPERTY_VALIDATION_ENABLED
static String	PROPERTY_VALIDATION_EXPIRATION_PERIOD
static String	PROPERTY_WELCOME_EMAIL_BODY
static String	PROPERTY_WELCOME_EMAIL_SUBJECT
static String	PROPERTY_WELCOME_ENABLED

Method Summary

long	getRegistrationExpirationPeriod() Returns the period of time from a users time of registration at which their account will be removed if they have not responded to their validation email.
Collection<com.jivesoftware.community.user.profile.RegistrationProfileField>	getRegistrationFields() Returns the collection of fields displayed at registration.
com.jivesoftware.community.user.profile.RegistrationProfileField	getRegistrationProfileField(int profileFieldName)
String	getTermsURL() Gets the string url representing the terms and conditions page
boolean	isAccountValidated(long userID) Checks if a user account has been validated
boolean	isHumanValidationEnabled() Returns true if the human input validation feature is turned on.
boolean	isNewAccountCreationEnabled() Returns true if new account creation is enabled.
boolean	isNewAccountCreationSupported() Returns true if Clearspace currently supports creation of new accounts.
boolean	isRegistrationModerationEnabled()
boolean	isTermsEnabled() Returns true if terms and conditions is enabled
boolean	isValidationEnabled() Returns true if the email validation feature is turned on.
boolean	isWelcomeEnabled() Returns true if welcome email is enabled
void	markAccountForValidation(User user) Marks the user account for validation and sends a validation request to the user.
User	registerUser(UserTemplate user)
void	sendWelcomeEmail(User user) Sends a welcome email to the given user.
void	setHumanValidationEnabled(boolean humanValidationEnabled) Enables or disables the human input validation feature.
void	setNewAccountCreationEnabled(boolean newAccountCreationEnabled) Enables or disbales new account creation.
void	setRegistrationExpirationPeriod(long registrationExpirationPeriod) Sets the period of time from a users time of registration at which their account will be removed if they have not responded to their validation email.
void	setRegistrationModerationEnabled(boolean isRegistrationModerationEnabled)
void	setTermsEnabled(boolean termsEnabled) Sets terms and conditions to be enabled / disabled
void	setTermsURL(String termsURL) Sets the string url representing the terms and conditions page
void	setValidationEnabled(boolean validationEnabled) Enables or disables the email validation feature.
void	setWelcomeEnabled(boolean welcomeEnabled) Sets welcome email to be enabled / disabled
void	updateRegistrationFields(Collection<com.jivesoftware.community.user.profile.RegistrationProfileField> registrationFields) Updates the ordering of registration profile fields with the ordering specified.
boolean	validateAccount(long userID, String validationKey) Validates a user account using a unique validation key and sends a welcome email if welcome email is enabled.

Methods inherited from interface com.jivesoftware.community.JiveManager

destroy

Field Detail

PROPERTY_VALIDATION_ENABLED

static final String PROPERTY_VALIDATION_ENABLED

See Also:

Constant Field Values

PROPERTY_VALIDATION_EXPIRATION_PERIOD

static final String PROPERTY_VALIDATION_EXPIRATION_PERIOD

See Also:

Constant Field Values

PROPERTY_HUMAN_VALIDATION_ENABLED

static final String PROPERTY_HUMAN_VALIDATION_ENABLED

See Also:

Constant Field Values

PROPERTY_EMAIL_SUBJECT

static final String PROPERTY_EMAIL_SUBJECT

See Also:

Constant Field Values

PROPERTY_EMAIL_BODY

static final String PROPERTY_EMAIL_BODY

See Also:

Constant Field Values

PROPERTY_USER_VALIDATION_KEY

static final String PROPERTY_USER_VALIDATION_KEY

See Also:

Constant Field Values

PROPERTY_WELCOME_ENABLED

static final String PROPERTY_WELCOME_ENABLED

See Also:

Constant Field Values

PROPERTY_WELCOME_EMAIL_SUBJECT

static final String PROPERTY_WELCOME_EMAIL_SUBJECT

See Also:

Constant Field Values

PROPERTY_WELCOME_EMAIL_BODY

static final String PROPERTY_WELCOME_EMAIL_BODY

See Also:

Constant Field Values

PROPERTY_TERMS_ENABLED

static final String PROPERTY_TERMS_ENABLED

See Also:

Constant Field Values

PROPERTY_TERMS_URL

static final String PROPERTY_TERMS_URL

See Also:

Constant Field Values

PROPERTY_ACCOUNT_CREATION_ENABLED

static final String PROPERTY_ACCOUNT_CREATION_ENABLED

See Also:

Constant Field Values

Method Detail

isNewAccountCreationEnabled

boolean isNewAccountCreationEnabled()

Returns true if new account creation is enabled. When new account creation is disabled, no new registrations will be permitted.

Returns:

true if new account creation is enabled.

setNewAccountCreationEnabled

void setNewAccountCreationEnabled(boolean newAccountCreationEnabled)

Enables or disbales new account creation. When new account creation is disabled, no new registrations will be permitted.

Parameters:

newAccountCreationEnabled - true to enable new account creation and false to disable it.

isNewAccountCreationSupported

boolean isNewAccountCreationSupported()

Returns true if Clearspace currently supports creation of new accounts. This is irrespective of whether or not it is currently enabled.

Returns:

true if Clearspace currently supports creation of new accounts.

isValidationEnabled

boolean isValidationEnabled()

Returns true if the email validation feature is turned on. When validation is disabled, all accounts will be created without any validation.

When this feature is enabled users are forced to respond to an email sent to their specified email address, which contains a link. Before the email is recieved and the link clicked users cannot login to the system.

Returns:

true if the validation is enabled.

setValidationEnabled

void setValidationEnabled(boolean validationEnabled)

Enables or disables the email validation feature. When validation is disabled, ll accounts will be created without any email validation.

Parameters:

validationEnabled - true to enable the validation feature, false to disable.

See Also:

isValidationEnabled()

setRegistrationExpirationPeriod

void setRegistrationExpirationPeriod(long registrationExpirationPeriod)

Sets the period of time from a users time of registration at which their account will be removed if they have not responded to their validation email.

Parameters:

registrationExpirationPeriod - the period of time from a users time of registration at which their account will be removed if they have not responded to their validation email. This value is measured in milliseconds

getRegistrationExpirationPeriod

long getRegistrationExpirationPeriod()

Returns the period of time from a users time of registration at which their account will be removed if they have not responded to their validation email.

Returns:

the period of time from a users time of registration at which their account will be removed if they have not responded to their validation email.

isHumanValidationEnabled

boolean isHumanValidationEnabled()

Returns true if the human input validation feature is turned on. When human input validation is disabled, all accounts will be created without any human input validation.

Returns:

true if the human input validation is enabled.

setHumanValidationEnabled

void setHumanValidationEnabled(boolean humanValidationEnabled)

Enables or disables the human input validation feature. When human input validation is disabled, all accounts will be created without any human input validation.

Parameters:

humanValidationEnabled - true to enable the human input validation feature, false to disable.

isTermsEnabled

boolean isTermsEnabled()

Returns true if terms and conditions is enabled

Returns:

true if terms and condiations is enabled; false otherwise

setTermsEnabled

void setTermsEnabled(boolean termsEnabled)

Sets terms and conditions to be enabled / disabled

Parameters:

termsEnabled - true to enable terms and conditions; false to disable

isWelcomeEnabled

boolean isWelcomeEnabled()

Returns true if welcome email is enabled

Returns:

true if welcome email is enabled; false otherwise

setWelcomeEnabled

void setWelcomeEnabled(boolean welcomeEnabled)

Sets welcome email to be enabled / disabled

Parameters:

welcomeEnabled - true to enable welcome email; false to disable

getTermsURL

String getTermsURL()

Gets the string url representing the terms and conditions page

Returns:

the string url of the terms and conditions page

setTermsURL

void setTermsURL(String termsURL)

Sets the string url representing the terms and conditions page

Parameters:

termsURL - the string url of the terms and conditions page

isRegistrationModerationEnabled

boolean isRegistrationModerationEnabled()

setRegistrationModerationEnabled

void setRegistrationModerationEnabled(boolean isRegistrationModerationEnabled)

registerUser

User registerUser(UserTemplate user)
                  throws UserAlreadyExistsException,
                         EmailAlreadyExistsException

Throws:

UserAlreadyExistsException

EmailAlreadyExistsException

markAccountForValidation

void markAccountForValidation(User user)

Marks the user account for validation and sends a validation request to the user. The user account will not be activated until a response validating the account is received.

Parameters:

user - the user to mark as needing validation

sendWelcomeEmail

void sendWelcomeEmail(User user)

Sends a welcome email to the given user.

Parameters:

user - the user to send a welcome email to

validateAccount

boolean validateAccount(long userID,
                        String validationKey)
                        throws UserNotFoundException

Validates a user account using a unique validation key and sends a welcome email if welcome email is enabled.

Parameters:

userID - the userID representing the user account to validate

validationKey - the unique validation key

Returns:

true if the user account was validated; false otherwise

Throws:

UserNotFoundException - if the user object can not be found

IllegalStateException - if the provider user is not currently awaiting validation.

isAccountValidated

boolean isAccountValidated(long userID)
                           throws UserNotFoundException

Checks if a user account has been validated

Parameters:

userID - the userID to check

Returns:

true if the user account has been validated; false otherwise

Throws:

UserNotFoundException - if the user object can not be found

getRegistrationFields

Collection<com.jivesoftware.community.user.profile.RegistrationProfileField> getRegistrationFields()

Returns the collection of fields displayed at registration.

Returns:

the collection of fields displayed at registration.

getRegistrationProfileField

com.jivesoftware.community.user.profile.RegistrationProfileField getRegistrationProfileField(int profileFieldName)

updateRegistrationFields

void updateRegistrationFields(Collection<com.jivesoftware.community.user.profile.RegistrationProfileField> registrationFields)

Updates the ordering of registration profile fields with the ordering specified.

Parameters:

registrationFields - the collection which provides the ordering