|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SignupManager
Provides methods for adding users easily.
Method Summary | |
---|---|
boolean |
canSignUpWith(String token)
Return true if the given token is valid for a user to self-sign-up. |
String |
createUserPendingConfirmation(com.atlassian.user.User user,
String passw)
Creates a new user and marks her disabled pending her email confirmation? |
boolean |
doesUserHaveOutdatedSignupToken(com.atlassian.user.User user)
|
void |
enableConfirmedUser(com.atlassian.user.User user)
Enable previously disabled user who signed up and confirmed her email. |
String |
getRelativeSignupURL()
|
String |
getRestrictedDomains()
Returns comma separated list of domains. |
String |
getSignUpToken()
Gets the current sign-up token, or creates a new one and returns it. |
String |
getSignupURL()
|
boolean |
isDomainRestrictedSignupEnabled()
|
boolean |
isEmailSentOnInviteSignUp()
|
boolean |
isPendingConfirmation(com.atlassian.user.User user)
Is given user tried to sign up but hasn't confirmed her email yet? |
boolean |
isPublicSignupPermitted()
Returns true if users can sign themselves for this instance. |
boolean |
isTokenForUserValid(com.atlassian.user.User user,
String token)
|
String |
refreshAndGetToken()
Creates a new sign-up token and returns it. |
String |
restorePreviousToken()
Restore the previous private-signup token and returns it. |
NotificationSendResult |
sendInvites(SendUserInviteEvent event)
Send invitation emails with a message to a list of email addresses. |
void |
setDomainRestrictedSignupMode(String allowedDomains)
Set the domains that user's email address should belong to to be able to sign up. |
void |
setEmailSentOnInviteSignUp(boolean notify)
|
void |
setPrivateSignupMode()
|
void |
setPublicSignupMode()
|
Method Detail |
---|
String getSignUpToken()
boolean canSignUpWith(String token)
token
- a sign-up token from a URL given to an invited userString refreshAndGetToken()
boolean isEmailSentOnInviteSignUp()
void setEmailSentOnInviteSignUp(boolean notify)
notify
- true if notification emails should be sent to admins when a user signs themselves up, false if notString restorePreviousToken()
String getSignupURL()
String getRelativeSignupURL()
boolean isPublicSignupPermitted()
NotificationSendResult sendInvites(SendUserInviteEvent event)
void setPublicSignupMode()
void setPrivateSignupMode()
void setDomainRestrictedSignupMode(String allowedDomains)
allowedDomains
- comma separated list of domainsString getRestrictedDomains()
boolean isPendingConfirmation(com.atlassian.user.User user)
user
-
String createUserPendingConfirmation(com.atlassian.user.User user, String passw) throws com.atlassian.crowd.exception.runtime.OperationFailedException, com.atlassian.crowd.exception.InvalidUserException, com.atlassian.crowd.exception.InvalidCredentialException, com.atlassian.crowd.exception.OperationNotPermittedException
user
- passw
-
com.atlassian.crowd.exception.runtime.OperationFailedException
com.atlassian.crowd.exception.InvalidUserException
com.atlassian.crowd.exception.InvalidCredentialException
com.atlassian.crowd.exception.OperationNotPermittedException
void enableConfirmedUser(com.atlassian.user.User user) throws com.atlassian.crowd.exception.runtime.UserNotFoundException, com.atlassian.crowd.exception.runtime.OperationFailedException, com.atlassian.crowd.exception.InvalidUserException, com.atlassian.crowd.exception.OperationNotPermittedException
user
-
com.atlassian.crowd.exception.runtime.UserNotFoundException
com.atlassian.crowd.exception.runtime.OperationFailedException
com.atlassian.crowd.exception.InvalidUserException
com.atlassian.crowd.exception.OperationNotPermittedException
boolean isTokenForUserValid(com.atlassian.user.User user, String token)
user
- token
-
boolean doesUserHaveOutdatedSignupToken(com.atlassian.user.User user)
user
-
boolean isDomainRestrictedSignupEnabled()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |