Package com.atlassian.crowd.service

Interface SignupSettingsService

All Known Implementing Classes:
SignupSettingsServiceImpl
public interface SignupSettingsService

  • Method Details

    • isEmailSentOnSignUp

      boolean isEmailSentOnSignUp()
      Returns:
      true if notification emails should be sent to admins when a user signs themselves up.

    • setEmailSentOnSignUp

      void setEmailSentOnSignUp(boolean notify)
      Parameters:
      notify - true if notification emails should be sent to admins when a user signs themselves up, false if not

    • setSignupEnabled

      void setSignupEnabled(boolean enabled)
      Parameters:
      enabled - true if users can sign themselves up

    • isSignupEnabled

      boolean isSignupEnabled()
      Returns:
      true if users can sign themselves up, false if not

    • setRestrictedDomains

      void setRestrictedDomains(List<String> allowedDomains)
      Set the domains that user's email address should belong to to be able to sign up.
      Parameters:
      allowedDomains - list of domains

    • getRestrictedDomains

      List<String> getRestrictedDomains()
      Returns list of domains. Users with email in those domains are allowed to sign up. Provided domain restricted sign up is enabled.
      Returns:
      list of domains

    • isEmailAllowed

      boolean isEmailAllowed(String email)
      Checks if the given email address is allowed to sign up. This will be true if:
      • The email address' domain is in the list of restricted domains, or
      • There are no restricted domains.
      This is always false if signup is disabled.
      Parameters:
      email - the email address, which must be valid (a string containing one "@").