Package org.apache.storm.security.auth

# Interface IHttpCredentialsPlugin

All Known Implementing Classes:
  `DefaultHttpCredentialsPlugin`

public interface IHttpCredentialsPlugin
Interface for handling credentials in an HttpServletRequest.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getUserName(jakarta.servlet.http.HttpServletRequest req)`
  Gets the user name from the request.
  `ReqContext`
  `populateContext(ReqContext context, jakarta.servlet.http.HttpServletRequest req)`
  Populates a given context with credentials information from an HTTP request.
  `void`
  `prepare(Map<String,Object> topoConf)`
  Invoked once immediately after construction.

- ## Method Details

  - ### prepare

    void prepare(Map<String,Object> topoConf)
    Invoked once immediately after construction.
    Parameters:
      `topoConf` - Storm configuration

  - ### getUserName

    String getUserName(jakarta.servlet.http.HttpServletRequest req)
    Gets the user name from the request.
    Parameters:
      `req` - the servlet request
    Returns:
      the authenticated user, or null if none is authenticated.

  - ### populateContext

    ReqContext populateContext(ReqContext context, jakarta.servlet.http.HttpServletRequest req)
    Populates a given context with credentials information from an HTTP request.
    Parameters:
      `req` - the servlet request
    Returns:
      the context