Interface OAuthServerDescription

public interface OAuthServerDescription
The description of an OAuth authentication server
Since:
4.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    OAuthServerDescription.Singleton
    cache for registered instances

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CLIENT_ID
    Key of the client-id property
    static final String
    CLIENT_SECRET
    Key of the client-secret property
    static final boolean
    OAUTH_CONNECTION
    if oauth.connection plugin is loaded
    static final String
    USE_OAUTH_CONNECTION
    Key if the setting from 'oauth.connection' plugin is used

  • Method Summary

    Modifier and Type
    Method
    Description
    static Map<String,String>
    applySettings(@Nonnull String loginType, @Nonnull Map<String,String> clientProperties)
    Convert the properties from the GUI to the properties that should be saved.
    default @Nonnull Map<String,String>
    applySettings(@Nonnull Map<String,String> clientProperties, @Nonnull com.inet.config.Configuration config, @Nonnull List<Map<String,String>> originalInConfig)
    Convert the properties from the GUI to the properties that should be saved.
    static OAuthServerDescription
    get(@Nonnull String name)
    FOR INTERNAL USE ONLY Get OAuthServerDescription with the given name from cache
    @Nonnull String
    getAuthenticationURL(@Nonnull com.inet.authentication.AuthenticationDescription config)
    The URL of the authentication redirect without parameters.
    default @Nonnull String
    getAuthenticationURL(@Nonnull com.inet.authentication.AuthenticationDescription config, String redirectURL, String state)
    Add the needed parameters to the authentication redirect URL.
    default @Nullable InputStream
    getAvatar(@Nonnull String accessToken)
    Alternative method to request the avatar icon.
    default @Nullable String
    getColor(@Nullable Map<String,String> settings)
    Get the color as hex value, e.g.
    default URLConnection
    getDataConnection(@Nonnull com.inet.authentication.AuthenticationDescription config, String accessToken)
    Get the URLConnection for user information.
    default @Nullable String
    getIconURL(@Nullable Map<String,String> settings)
    Get the Icon resource URL.
    default @Nullable String
    getLoginDisplayName(@Nullable String email, @Nullable String givenName, @Nullable String familyName, @Nullable String alternativeLoginID)
    Get the display name of the login in the user manager.
    default @Nullable String
    getOauthConnectionProvider()
    Get the name of the related OauthConnectionProvider from the 'oauth.connection' plugin.
    default @Nonnull String
    getScope(@Nonnull com.inet.authentication.AuthenticationDescription config)
    Get the scope value.
    default @Nonnull String
    getTokenData(@Nonnull com.inet.authentication.AuthenticationDescription config, String redirectURL, String code)
    The POST data to verify the login from the server
    String
    getTokenURL(@Nonnull com.inet.authentication.AuthenticationDescription config)
    The POST URL to verify the login from the server.
    default boolean
    hasOauthConnectionSettings()
    If this provider has related settings in the 'oauth.connection' plugin.
    default boolean
    isTrustAllCertificates(@Nonnull com.inet.authentication.AuthenticationDescription config)
    Determines whether all certificates should be trusted for the authentication server.
    @Nonnull String
    name()
    Get the loginSource/name for this server.
    default void
    transformGuiProperties(@Nonnull Map<String,Object> properties)
    Transform the loaded values to the format required for the configuration GUI
    default @Nullable Set<String>
    updateRoles(@Nonnull String accessToken, @Nonnull Set<String> roles)
    Optional method to update the roles received with the JWT login token.

  • Field Details

    • CLIENT_ID

      static final String CLIENT_ID
      Key of the client-id property
      See Also:

    • CLIENT_SECRET

      static final String CLIENT_SECRET
      Key of the client-secret property
      See Also:

    • USE_OAUTH_CONNECTION

      static final String USE_OAUTH_CONNECTION
      Key if the setting from 'oauth.connection' plugin is used
      See Also:

    • OAUTH_CONNECTION

      static final boolean OAUTH_CONNECTION
      if oauth.connection plugin is loaded

  • Method Details

    • get

      static OAuthServerDescription get(@Nonnull String name)
      FOR INTERNAL USE ONLY Get OAuthServerDescription with the given name from cache
      Parameters:
      name - the name
      Returns:
      OAuthServerDescription or null
      Since:
      23.10

    • name

      @Nonnull String name()
      Get the loginSource/name for this server.
      Returns:
      the login source
      Since:
      4.0

    • getColor

      default @Nullable String getColor(@Nullable Map<String,String> settings)
      Get the color as hex value, e.g. "#ff00ee". If null the default color is used.
      Parameters:
      settings - the settings in the configuration manager
      Returns:
      the color
      Since:
      21.4

    • getIconURL

      default @Nullable String getIconURL(@Nullable Map<String,String> settings)
      Get the Icon resource URL. If null the default Icon is used.
      Parameters:
      settings - the settings in the configuration manager
      Returns:
      the url
      Since:
      21.4

    • getScope

      default @Nonnull String getScope(@Nonnull com.inet.authentication.AuthenticationDescription config)
      Get the scope value. The scopes are the data to which access is requested.
      Parameters:
      config - the current oauth configuration
      Returns:
      the scope parameter
      Since:
      4.0

    • getAuthenticationURL

      @Nonnull String getAuthenticationURL(@Nonnull com.inet.authentication.AuthenticationDescription config)
      The URL of the authentication redirect without parameters. This is the first URL to which the browser will be redirected.
      Parameters:
      config - the current configuration
      Returns:
      the URL
      Since:
      4.0

    • getAuthenticationURL

      default @Nonnull String getAuthenticationURL(@Nonnull com.inet.authentication.AuthenticationDescription config, String redirectURL, String state)
      Add the needed parameters to the authentication redirect URL.
      Parameters:
      config - the current oauth configuration
      redirectURL - the return URL of this server
      state - a random state that must be verified later
      Returns:
      the URL
      Since:
      4.0

    • getTokenURL

      String getTokenURL(@Nonnull com.inet.authentication.AuthenticationDescription config)
      The POST URL to verify the login from the server.
      Parameters:
      config - the current oauth configuration
      Returns:
      the URL
      Since:
      4.0

    • getTokenData

      default @Nonnull String getTokenData(@Nonnull com.inet.authentication.AuthenticationDescription config, String redirectURL, String code)
      The POST data to verify the login from the server
      Parameters:
      config - the current OAuth configuration
      redirectURL - the used callback URL. Must be the same from the authentication request
      code - the code from the authentication server
      Returns:
      the POST data
      Since:
      4.0

    • getDataConnection

      default URLConnection getDataConnection(@Nonnull com.inet.authentication.AuthenticationDescription config, String accessToken) throws IOException
      Get the URLConnection for user information. This connection is only used if the provider does not support OpenID or if access tokens are used for web API requests.
      Parameters:
      config - the current OAuth configuration
      accessToken - the valid accessToken from a previous authentication
      Returns:
      The connection used to request the data.
      Throws:
      IOException - if any I/O error occurs
      Since:
      20.4

    • getAvatar

      default @Nullable InputStream getAvatar(@Nonnull String accessToken)
      Alternative method to request the avatar icon. Only called for new users
      Parameters:
      accessToken - the valid accessToken from a previous authentication
      Returns:
      the stream to an image
      Since:
      23.10

    • updateRoles

      default @Nullable Set<String> updateRoles(@Nonnull String accessToken, @Nonnull Set<String> roles)
      Optional method to update the roles received with the JWT login token.
      Parameters:
      accessToken - the valid accessToken from a previous authentication
      roles - the original requested roles
      Returns:
      the updated roles
      Since:
      24.10

    • isTrustAllCertificates

      default boolean isTrustAllCertificates(@Nonnull com.inet.authentication.AuthenticationDescription config)
      Determines whether all certificates should be trusted for the authentication server.

      This correctly spelled method is the preferred override and call site for new code. Its default implementation delegates to the legacy misspelled method so existing provider implementations continue to work.

      Parameters:
      config - the current OAuth configuration
      Returns:
      true for private certificates
      Since:
      26.10

    • getLoginDisplayName

      default @Nullable String getLoginDisplayName(@Nullable String email, @Nullable String givenName, @Nullable String familyName, @Nullable String alternativeLoginID)
      Get the display name of the login in the user manager. If null then the login ID will be shown. The default implementation will try to create a display name in the form:

      FirstName LastName <Email>

      • If only First or Last name are given, they will prefix the email (if given)
      • If only the email is given, then only the email will be returned.
      • If none of those are given, null is returned and results in the original login id
      Parameters:
      email - possible email
      givenName - possible given name
      familyName - possible family name
      alternativeLoginID - alternative login ID, depends on the provider
      Returns:
      alternative display name
      Since:
      23.10

    • getOauthConnectionProvider

      default @Nullable String getOauthConnectionProvider()
      Get the name of the related OauthConnectionProvider from the 'oauth.connection' plugin.
      Returns:
      the name or null
      Since:
      23.10

    • hasOauthConnectionSettings

      default boolean hasOauthConnectionSettings()
      If this provider has related settings in the 'oauth.connection' plugin.
      Returns:
      true, if plugin is available and there are configured settings in the 'oauth.connection' plugin.
      Since:
      23.10

    • transformGuiProperties

      default void transformGuiProperties(@Nonnull Map<String,Object> properties)
      Transform the loaded values to the format required for the configuration GUI
      Parameters:
      properties - the loaded properties
      Since:
      24.4

    • applySettings

      default @Nonnull Map<String,String> applySettings(@Nonnull Map<String,String> clientProperties, @Nonnull com.inet.config.Configuration config, @Nonnull List<Map<String,String>> originalInConfig)
      Convert the properties from the GUI to the properties that should be saved. Typical this is a filter only.
      Parameters:
      clientProperties - properties from the GUI
      config - the Configuration that will edit in the configuration manager GUI
      originalInConfig - the parsed, read only login settings in configuration
      Returns:
      the values to be saved
      Since:
      24.4

    • applySettings

      static Map<String,String> applySettings(@Nonnull String loginType, @Nonnull Map<String,String> clientProperties)
      Convert the properties from the GUI to the properties that should be saved. Typical this is a filter only.
      Parameters:
      loginType - the login type prefix name to check for additional settings
      clientProperties - properties from the GUI
      Returns:
      the values to be saved
      Since:
      24.4