Module one.jpro.platform.auth.routing
Package one.jpro.platform.auth.routing

Interface AuthOAuth2Filter

public interface AuthOAuth2Filter
Defines Route filters using OAuth2 authentication mechanism.

  • Method Summary

    Static Methods
    Modifier and Type
    Method
    Description
    static void
    authorize(@NotNull javafx.scene.Node node, @NotNull one.jpro.platform.auth.core.oauth2.OAuth2AuthenticationProvider authProvider, @NotNull one.jpro.platform.auth.core.oauth2.OAuth2Credentials credentials)
    Initiates the authorization process for a given OAuth2 authentication provider, updating the provided JavaFX Node with the authorization URL.
    static void
    authorize(@NotNull javafx.scene.Node node, @NotNull one.jpro.platform.auth.core.oauth2.provider.OpenIDAuthenticationProvider openidAuthProvider)
    Initiates the authorization process for a given OpenID authentication provider.
    static one.jpro.platform.routing.Filter
    create(@NotNull one.jpro.platform.auth.core.oauth2.OAuth2AuthenticationProvider authProvider, @Nullable UserSession userSession, @NotNull one.jpro.platform.auth.core.oauth2.OAuth2Credentials credentials, @NotNull Function<one.jpro.platform.auth.core.authentication.User,one.jpro.platform.routing.Response> userFunction, @NotNull Function<Throwable,one.jpro.platform.routing.Response> errorFunction)
    Creates Route filter from a given OAuth2AuthenticationProvider, OAuth2Credentials and functions for handling successful and error cases.
    static one.jpro.platform.routing.Filter
    create(@NotNull one.jpro.platform.auth.core.oauth2.provider.OpenIDAuthenticationProvider openidAuthProvider, @NotNull Function<one.jpro.platform.auth.core.authentication.User,one.jpro.platform.routing.Response> userFunction, @NotNull Function<Throwable,one.jpro.platform.routing.Response> errorFunction)
    Creates Route filter from a given OAuth2AuthenticationProvider, OAuth2Credentials and functions for handling successful and error cases.
    static one.jpro.platform.routing.Filter
    create(@NotNull one.jpro.platform.auth.core.oauth2.provider.OpenIDAuthenticationProvider openidAuthProvider, @NotNull UserSession userSession, @NotNull Function<one.jpro.platform.auth.core.authentication.User,one.jpro.platform.routing.Response> userFunction, @NotNull Function<Throwable,one.jpro.platform.routing.Response> errorFunction)
    Creates Route filter from a given OAuth2AuthenticationProvider, OAuth2Credentials and functions for handling successful and error cases.

  • Method Details

    • create

      static one.jpro.platform.routing.Filter create(@NotNull @NotNull one.jpro.platform.auth.core.oauth2.provider.OpenIDAuthenticationProvider openidAuthProvider, @NotNull @NotNull Function<one.jpro.platform.auth.core.authentication.User,one.jpro.platform.routing.Response> userFunction, @NotNull @NotNull Function<Throwable,one.jpro.platform.routing.Response> errorFunction)
      Creates Route filter from a given OAuth2AuthenticationProvider, OAuth2Credentials and functions for handling successful and error cases.
      Parameters:
      openidAuthProvider - the OpenID authentication provider
      userFunction - operation on the given user argument
      errorFunction - operation on the given error argument
      Returns:
      a Filter object

    • create

      static one.jpro.platform.routing.Filter create(@NotNull @NotNull one.jpro.platform.auth.core.oauth2.provider.OpenIDAuthenticationProvider openidAuthProvider, @NotNull @NotNull UserSession userSession, @NotNull @NotNull Function<one.jpro.platform.auth.core.authentication.User,one.jpro.platform.routing.Response> userFunction, @NotNull @NotNull Function<Throwable,one.jpro.platform.routing.Response> errorFunction)
      Creates Route filter from a given OAuth2AuthenticationProvider, OAuth2Credentials and functions for handling successful and error cases.
      Parameters:
      openidAuthProvider - the OpenID authentication provider
      userSession - the user session, when null the user will not be stored in the session
      userFunction - operation on the given user argument
      errorFunction - operation on the given error argument
      Returns:
      a Filter object

    • create

      static one.jpro.platform.routing.Filter create(@NotNull @NotNull one.jpro.platform.auth.core.oauth2.OAuth2AuthenticationProvider authProvider, @Nullable @Nullable UserSession userSession, @NotNull @NotNull one.jpro.platform.auth.core.oauth2.OAuth2Credentials credentials, @NotNull @NotNull Function<one.jpro.platform.auth.core.authentication.User,one.jpro.platform.routing.Response> userFunction, @NotNull @NotNull Function<Throwable,one.jpro.platform.routing.Response> errorFunction)
      Creates Route filter from a given OAuth2AuthenticationProvider, OAuth2Credentials and functions for handling successful and error cases.
      Parameters:
      authProvider - an OAuth2 authentication provider
      userSession - the user session, when null the user will not be stored in the session
      credentials - an OAuth2 credentials
      userFunction - operation on the given user argument
      errorFunction - operation on the given error argument
      Returns:
      a Filter object

    • authorize

      static void authorize(@NotNull @NotNull javafx.scene.Node node, @NotNull @NotNull one.jpro.platform.auth.core.oauth2.OAuth2AuthenticationProvider authProvider, @NotNull @NotNull one.jpro.platform.auth.core.oauth2.OAuth2Credentials credentials)
      Initiates the authorization process for a given OAuth2 authentication provider, updating the provided JavaFX Node with the authorization URL.
      Parameters:
      node - the JavaFX node context for the authorization
      authProvider - the OAuth2 authentication provider
      credentials - the OAuth2 credentials

    • authorize

      static void authorize(@NotNull @NotNull javafx.scene.Node node, @NotNull @NotNull one.jpro.platform.auth.core.oauth2.provider.OpenIDAuthenticationProvider openidAuthProvider)
      Initiates the authorization process for a given OpenID authentication provider.
      Parameters:
      node - the JavaFX node context for the authorization
      openidAuthProvider - the OpenID authentication provider