Class AbstractUserAuth

    • Field Detail

      • name

        private final java.lang.String name
      • service

        private java.lang.String service
      • username

        private java.lang.String username
    • Constructor Detail

      • AbstractUserAuth

        protected AbstractUserAuth​(java.lang.String name)
    • Method Detail

      • getName

        public final java.lang.String getName()
        Specified by:
        getName in interface NamedResource
        Returns:
        The resource name
      • getUsername

        public java.lang.String getUsername()
        Specified by:
        getUsername in interface UsernameHolder
        Returns:
        The attached username - may be null/empty if holder not yet initialized
      • getService

        public java.lang.String getService()
      • auth

        public java.lang.Boolean auth​(ServerSession session,
                                      java.lang.String username,
                                      java.lang.String service,
                                      Buffer buffer)
                               throws java.lang.Exception
        Description copied from interface: UserAuth
        Try to authenticate the user. This methods should return a non null value indicating if the authentication succeeded. If the authentication is still ongoing, a null value should be returned.
        Specified by:
        auth in interface UserAuth
        Parameters:
        session - the current ServerSession session
        username - the user trying to log in
        service - the requested service name
        buffer - the request buffer containing parameters specific to this request
        Returns:
        true if the authentication succeeded, false if the authentication failed and null if not finished yet
        Throws:
        AsyncAuthException - if the service is willing to perform an asynchronous authentication
        java.lang.Exception - if the authentication fails
      • next

        public java.lang.Boolean next​(Buffer buffer)
                               throws java.lang.Exception
        Description copied from interface: UserAuth
        Handle another step in the authentication process.
        Specified by:
        next in interface UserAuth
        Parameters:
        buffer - the request buffer containing parameters specific to this request
        Returns:
        true if the authentication succeeded, false if the authentication failed and null if not finished yet
        Throws:
        AsyncAuthException - if the service is willing to perform an asynchronous authentication
        java.lang.Exception - if the authentication fails
      • destroy

        public void destroy()
        Description copied from interface: UserAuth
        Free any system resources used by the module.
        Specified by:
        destroy in interface UserAuth
      • doAuth

        protected abstract java.lang.Boolean doAuth​(Buffer buffer,
                                                    boolean init)
                                             throws java.lang.Exception
        Throws:
        java.lang.Exception
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object