Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.registration
Interface RegistrationManager

All Known Implementing Classes:
RegistrationManagerImpl, RegistrationManagerProxy

public interface RegistrationManager

Manages validation settings and validating new user accounts.


Field Summary
static java.lang.String PROPERTY_EMAIL_ADDRESS
           
static java.lang.String PROPERTY_EMAIL_BODY
           
static java.lang.String PROPERTY_EMAIL_NAME
           
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
           
 
Method Summary
 java.lang.String getEmailAddress()
          Gets the email address that validation emails will appear to be from
 java.lang.String getEmailBody(java.util.Locale locale)
          Gets the text for the body of the validation emails.
 java.lang.String getEmailName()
          Gets the name that validation emails will appear to be from
 java.lang.String getEmailSubject(java.util.Locale locale)
          Gets the text for the subject of validation emails
 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.
 void markAccountForValidation(User user)
          Marks the user account for validation and sends a validation request to the user.
 void setEmailAddress(java.lang.String emailAddress)
          Sets the email address that validation emails will appear to be from
 void setEmailBody(java.lang.String emailBody, java.util.Locale locale)
          Sets the text for the body of of validation emails.
 void setEmailName(java.lang.String emailName)
          Sets The name that validation emails will appear to be from
 void setEmailSubject(java.lang.String emailSubject, java.util.Locale locale)
          Sets the text for the subject of validation emails
 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.
 boolean validateAccount(long userID, java.lang.String validationKey)
          Validates a user account using a unique validation key
 

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_NAME

static final java.lang.String PROPERTY_EMAIL_NAME
See Also:
Constant Field Values

PROPERTY_EMAIL_ADDRESS

static final java.lang.String PROPERTY_EMAIL_ADDRESS
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_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.

getEmailName

java.lang.String getEmailName()
Gets the name that validation emails will appear to be from

Returns:
The name that validation emails will appear to be from

setEmailName

void setEmailName(java.lang.String emailName)
Sets The name that validation emails will appear to be from

Parameters:
emailName - the name that validation emails will appear to be from

getEmailAddress

java.lang.String getEmailAddress()
Gets the email address that validation emails will appear to be from

Returns:
the email address that validation emails will appear to be from

setEmailAddress

void setEmailAddress(java.lang.String emailAddress)
Sets the email address that validation emails will appear to be from

Parameters:
emailAddress - the email address that validation emails will appear to be from

getEmailSubject

java.lang.String getEmailSubject(java.util.Locale locale)
Gets the text for the subject of validation emails

Parameters:
locale -
Returns:
the text for the subject of validation emails

setEmailSubject

void setEmailSubject(java.lang.String emailSubject,
                     java.util.Locale locale)
Sets the text for the subject of validation emails

Parameters:
emailSubject - the text for the subject of validation emails
locale -

getEmailBody

java.lang.String getEmailBody(java.util.Locale locale)
Gets the text for the body of the validation emails. The body text should have a special token ${link} indicating where the validation link should be included in the body. The token will be dynamically replaced with a real value when emails are sent. If there is no ${link} token specified, the link will be included at the end of the email.

Parameters:
locale -
Returns:
the text for the body of the validation emails

setEmailBody

void setEmailBody(java.lang.String emailBody,
                  java.util.Locale locale)
Sets the text for the body of of validation emails. The body text should have a special token ${link} indicating where the validation link should be included in the body. The token will be dynamically replaced with a real value when emails are sent. If there is no ${link} token specified, the link will be included at the end of the email.

Parameters:
emailBody - the text for the body of the validation emails
locale -

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 enavled terms and conditions; false to disabled

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.


validateAccount

boolean validateAccount(long userID,
                        java.lang.String validationKey)
                        throws UserNotFoundException
Validates a user account using a unique validation key

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

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.