Interface HTTPRequestHandlerInterface

  • All Known Implementing Classes:
    HTTPRequestHandler

    public interface HTTPRequestHandlerInterface
    HTTPRequestHandlerInterface provides the interfaces to process methods required by AMHttpAuthModule and implememted by HTTPRequestHandler
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getLoginURL​(jakarta.servlet.http.HttpServletRequest request)
      Returns Login URL for client to be redirected.
      void init​(Map config)
      Initialize the HTTP Request handler with a configuration map.
      boolean shouldAuthenticate​(Subject subject, jakarta.servlet.http.HttpServletRequest request)
      Checks whether client should be authenticated or not.
    • Method Detail

      • init

        void init​(Map config)
        Initialize the HTTP Request handler with a configuration map.
        Parameters:
        config - the configuration map.
      • shouldAuthenticate

        boolean shouldAuthenticate​(Subject subject,
                                   jakarta.servlet.http.HttpServletRequest request)
        Checks whether client should be authenticated or not.
        Parameters:
        subject - the subject that may be used by the callers to store Principals and credentials validated in the request.
        request - the HttpServletRequest associated with this Client message request.
        Returns:
        true if the client should be authenticated.
      • getLoginURL

        String getLoginURL​(jakarta.servlet.http.HttpServletRequest request)
        Returns Login URL for client to be redirected.
        Parameters:
        request - the HttpServletRequest.
        Returns:
        String Login URL