|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.base.registration.RegistrationManagerImpl
public class RegistrationManagerImpl
Database implementation of the RegistrationManager interface. Support for validating user accounts can be enabled by setting the validation.enabled property to true. When validation is enabled, new user will have to verify their account before being allowed to access the system. An email will be sent to the account's email address containing a link that will validate their account.
Field Summary |
---|
Fields inherited from interface com.jivesoftware.base.registration.RegistrationManager |
---|
PROPERTY_EMAIL_ADDRESS, PROPERTY_EMAIL_BODY, PROPERTY_EMAIL_NAME, PROPERTY_EMAIL_SUBJECT, PROPERTY_HUMAN_VALIDATION_ENABLED, PROPERTY_TERMS_ENABLED, PROPERTY_TERMS_URL, PROPERTY_USER_VALIDATION_KEY, 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 |
static RegistrationManager |
getInstance()
Provides access to the single RegistrationManager instance |
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 enabled)
Enables or disables the validation feature. |
boolean |
validateAccount(long userID,
java.lang.String validationKey)
Validates a user account using a unique validation key |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static RegistrationManager getInstance()
public boolean isValidationEnabled()
RegistrationManager
isValidationEnabled
in interface RegistrationManager
public void setValidationEnabled(boolean enabled)
RegistrationManager
setValidationEnabled
in interface RegistrationManager
enabled
- true to enable the validation feature, false to disable.public boolean isHumanValidationEnabled()
RegistrationManager
isHumanValidationEnabled
in interface RegistrationManager
public void setHumanValidationEnabled(boolean humanValidationEnabled)
RegistrationManager
setHumanValidationEnabled
in interface RegistrationManager
humanValidationEnabled
- true to enable the human input validation feature, false to disable.public java.lang.String getEmailName()
RegistrationManager
getEmailName
in interface RegistrationManager
public void setEmailName(java.lang.String emailName)
RegistrationManager
setEmailName
in interface RegistrationManager
emailName
- the name that validation emails will appear to be frompublic java.lang.String getEmailAddress()
RegistrationManager
getEmailAddress
in interface RegistrationManager
public void setEmailAddress(java.lang.String emailAddress)
RegistrationManager
setEmailAddress
in interface RegistrationManager
emailAddress
- the email address that validation emails will appear to be frompublic java.lang.String getEmailSubject(java.util.Locale locale)
RegistrationManager
getEmailSubject
in interface RegistrationManager
public void setEmailSubject(java.lang.String emailSubject, java.util.Locale locale)
RegistrationManager
setEmailSubject
in interface RegistrationManager
emailSubject
- the text for the subject of validation emailspublic java.lang.String getEmailBody(java.util.Locale locale)
RegistrationManager
getEmailBody
in interface RegistrationManager
public void setEmailBody(java.lang.String emailBody, java.util.Locale locale)
RegistrationManager
setEmailBody
in interface RegistrationManager
emailBody
- the text for the body of the validation emailspublic boolean isTermsEnabled()
RegistrationManager
isTermsEnabled
in interface RegistrationManager
public void setTermsEnabled(boolean termsEnabled)
RegistrationManager
setTermsEnabled
in interface RegistrationManager
termsEnabled
- true to enavled terms and conditions; false to disabledpublic java.lang.String getTermsURL()
RegistrationManager
getTermsURL
in interface RegistrationManager
public void setTermsURL(java.lang.String termsURL)
RegistrationManager
setTermsURL
in interface RegistrationManager
termsURL
- the string url of the terms and conditions pagepublic void markAccountForValidation(User user)
RegistrationManager
markAccountForValidation
in interface RegistrationManager
public boolean validateAccount(long userID, java.lang.String validationKey) throws UserNotFoundException
RegistrationManager
validateAccount
in interface RegistrationManager
userID
- the userID representing the user account to validatevalidationKey
- the unique validation key
UserNotFoundException
- if the user object can not be foundpublic boolean isAccountValidated(long userID) throws UserNotFoundException
RegistrationManager
isAccountValidated
in interface RegistrationManager
userID
- the userID to check
UserNotFoundException
- if the user object can not be found
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |