Interface AuthenticationHandler


  • public interface AuthenticationHandler
    This interface is used by the Authentication Service to have the Principal authenticated by the realm. A realm provides an implementation of this interface.
    Author:
    Harish Prabandham, Harpreet Singh
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean doAuthentication​(String principalName, byte[] authData)
      This method authenticates the given principal using the specified authentication data and the Principal's Credentials.
      Realm getRealm()
      Returns the Realm that this Authentication Handler is authenticating in.
    • Method Detail

      • getRealm

        Realm getRealm()
        Returns the Realm that this Authentication Handler is authenticating in.
        Returns:
        The Realm object in which this handler is authenticating in.
      • doAuthentication

        boolean doAuthentication​(String principalName,
                                 byte[] authData)
        This method authenticates the given principal using the specified authentication data and the Principal's Credentials. The result of the authentication is returned back.
        Parameters:
        The - principal (user) being authenticated.
        The - data needed for authentication.
        Returns:
        boolean denoting true for success and false for failure authentication.