Class FederatedLoginService.FederatedIdentity

    • Constructor Detail

      • FederatedIdentity

        public FederatedIdentity()
    • Method Detail

      • getIdentifier

        public abstract String getIdentifier()
        Gets the string representation of the identity in the form that makes sense to the enclosing FederatedLoginService, such as full OpenID URL.
        must not be null.
      • getNickname

        public abstract String getNickname()
        Gets a short ID of this user, as a suitable candidate for User.getId(). This should be Unix username like token.
        null if this information is not available.
      • getFullName

        public abstract String getFullName()
        Gets a human readable full name of this user. Maps to User.getDisplayName()
        null if this information is not available.
      • getEmailAddress

        public abstract String getEmailAddress()
        Gets the e-mail address of this user, like ""
        null if this information is not available.
      • getPronoun

        public abstract String getPronoun()
        Returns a human-readable pronoun that describes this kind of identifier. This is used for rendering UI. For example, "OpenID", "Twitter ID", etc.
      • locateUser

        public final User locateUser()
        Locates the user who owns this identifier.
      • signin

        public User signin()
                    throws FederatedLoginService.UnclaimedIdentityException
        Call this method to authenticate the user when you confirmed (via your protocol specific work) that the current HTTP request indeed owns this identifier.

        This method will locate the user who owns this identifier, associate the credential with the current session. IOW, it signs in the user.

        FederatedLoginService.UnclaimedIdentityException - If this identifier is not claimed by anyone. If you just let this exception propagate to the caller of your "doXyz" method, it will either render an error page or initiate a user registration session (provided that SecurityRealm supports that.)
      • addToCurrentUser

        public void addToCurrentUser()
                              throws IOException
        Your implementation will call this method to add this identifier to the current user of an already authenticated session.

        This method will record the identifier in FederatedLoginServiceUserProperty so that in the future the user can login to Hudson with the identifier.