Class UserAuthImpl

    • Constructor Detail

      • UserAuthImpl

        public UserAuthImpl​(Transport trans)
    • Method Detail

      • authenticate

        public boolean authenticate​(java.lang.String username,
                                    Service nextService,
                                    AuthMethod method,
                                    int timeoutMs)
                             throws UserAuthException,
                                    TransportException
        Description copied from interface: UserAuth
        Attempt to authenticate username using each of methods in order. nextService is the Service that will be enabled on successful authentication.

        Authentication fails if there are no method available, i.e. if all the method failed or there were method available but could not be attempted because the server did not allow them.

        Further attempts may also be made by catching UserAuthException and retrying with this method.

        Specified by:
        authenticate in interface UserAuth
        Parameters:
        username - the user to authenticate
        nextService - the service to set on successful authentication
        method - the AuthMethod's to try
        Returns:
        whether authentication was successful
        Throws:
        UserAuthException - in case of authentication failure
        TransportException - if there was a transport-layer error
      • getBanner

        public java.lang.String getBanner()
        Description copied from interface: UserAuth
        Returns the authentication banner (if any). In some cases this is available even before the first authentication request has been made.
        Specified by:
        getBanner in interface UserAuth
        Returns:
        the banner, or an empty string if none was received
      • hadPartialSuccess

        public boolean hadPartialSuccess()
        Specified by:
        hadPartialSuccess in interface UserAuth
        Returns:
        whether authentication was partially successful. Some server's may be configured to require multiple authentications; and this value will be true if at least one of the method supplied succeeded.
      • getAllowedMethods

        public java.util.Collection<java.lang.String> getAllowedMethods()
        Description copied from interface: UserAuth
        The available authentication methods. This is only defined once an unsuccessful authentication has taken place.
        Specified by:
        getAllowedMethods in interface UserAuth