com.jivesoftware.community
Interface RegistrationManager

All Superinterfaces:

JiveManager

public interface RegistrationManager
extends JiveManager

Manages validation settings and validating new user accounts.

Field Summary

static java.lang.String	PROPERTY_EMAIL_BODY
static java.lang.String	PROPERTY_EMAIL_SUBJECT
static java.lang.String	PROPERTY_HUMAN_VALIDATION_ENABLED
static java.lang.String	PROPERTY_TERMS_ENABLED
static java.lang.String	PROPERTY_TERMS_URL
static java.lang.String	PROPERTY_USER_VALIDATION_KEY
static java.lang.String	PROPERTY_VALIDATION_ENABLED
static java.lang.String	PROPERTY_WELCOME_EMAIL_BODY
static java.lang.String	PROPERTY_WELCOME_EMAIL_SUBJECT
static java.lang.String	PROPERTY_WELCOME_ENABLED

Method Summary

java.lang.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	isTermsEnabled() Returns true if terms and conditions is enabled
boolean	isValidationEnabled() Returns true if the 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.
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	setTermsEnabled(boolean termsEnabled) Sets terms and conditions to be enabled / disabled
void	setTermsURL(java.lang.String termsURL) Sets the string url representing the terms and conditions page
void	setValidationEnabled(boolean validationEnabled) Enables or disables the validation feature.
void	setWelcomeEnabled(boolean welcomeEnabled) Sets welcome email to be enabled / disabled
boolean	validateAccount(long userID, java.lang.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, initialize

Field Detail

PROPERTY_VALIDATION_ENABLED

static final java.lang.String PROPERTY_VALIDATION_ENABLED

See Also:

Constant Field Values

PROPERTY_HUMAN_VALIDATION_ENABLED

static final java.lang.String PROPERTY_HUMAN_VALIDATION_ENABLED

See Also:

Constant Field Values

PROPERTY_EMAIL_SUBJECT

static final java.lang.String PROPERTY_EMAIL_SUBJECT

See Also:

Constant Field Values

PROPERTY_EMAIL_BODY

static final java.lang.String PROPERTY_EMAIL_BODY

See Also:

Constant Field Values

PROPERTY_USER_VALIDATION_KEY

static final java.lang.String PROPERTY_USER_VALIDATION_KEY

See Also:

Constant Field Values

PROPERTY_WELCOME_ENABLED

static final java.lang.String PROPERTY_WELCOME_ENABLED

See Also:

Constant Field Values

PROPERTY_WELCOME_EMAIL_SUBJECT

static final java.lang.String PROPERTY_WELCOME_EMAIL_SUBJECT

See Also:

Constant Field Values

PROPERTY_WELCOME_EMAIL_BODY

static final java.lang.String PROPERTY_WELCOME_EMAIL_BODY

See Also:

Constant Field Values

PROPERTY_TERMS_ENABLED

static final java.lang.String PROPERTY_TERMS_ENABLED

See Also:

Constant Field Values

PROPERTY_TERMS_URL

static final java.lang.String PROPERTY_TERMS_URL

See Also:

Constant Field Values

Method Detail

isValidationEnabled

boolean isValidationEnabled()

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

Returns:

true if the validation is enabled.

setValidationEnabled

void setValidationEnabled(boolean validationEnabled)

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

Parameters:

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

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

java.lang.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(java.lang.String termsURL)

Sets the string url representing the terms and conditions page

Parameters:

termsURL - the string url of the terms and conditions page

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,
                        java.lang.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

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