Interface AuthMethod<T>

Type Parameters:
T - type of the API provided by the engine

public interface AuthMethod<T>
An authentication method. Supported built-in methods are available as constants.
  • Method Summary

    Modifier and Type
    Method
    Description
    Implementation class of this authentication method.
    static <T> AuthMethod<T>
    create(Class<T> auth, String type, String defaultPath)
    Create an authentication method.
    Default path the authentication method is mounted to.
    Type of the auth as used in the REST API.
  • Method Details

    • create

      static <T> AuthMethod<T> create(Class<T> auth, String type, String defaultPath)
      Create an authentication method.
      Type Parameters:
      T - type of auth API
      Parameters:
      auth - auth API class
      type - type of auth
      defaultPath - default mount path of this method
      Returns:
      a new authentication method
    • type

      String type()
      Type of the auth as used in the REST API.
      Returns:
      type of the auth, such as token
    • apiType

      Class<T> apiType()
      Implementation class of this authentication method.
      Returns:
      API class
      See Also:
    • defaultPath

      String defaultPath()
      Default path the authentication method is mounted to.
      Returns:
      default path