Package de.xima.fc.interfaces.plugin.retval.auth

Interface IPluginGenericAuthenticatorRetVal

  • All Known Implementing Classes:
    PluginGenericAuthenticatorRetVal
    public interface IPluginGenericAuthenticatorRetVal
    Interface for the return value of an authenticator type plugin, when used as an authenticator for a generic authentication context.
    Since:
    8.0.0
    Author:
    XIMA MEDIA GmbH

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default boolean autoExecuteIndirectClient()
      Determines whether or not the provided indirect client should be executed automatically iff there is only one authenticator configured for access to a protected resource (e.g.
      default Iterable<? extends org.pac4j.core.client.DirectClient> getDirectClients()
      Direct clients to be used for authentication.
      default org.pac4j.core.client.IndirectClient getIndirectClient()
      The indirect client to be used for authentication.

    • Method Detail

      • getDirectClients

        @Nullable
default Iterable<? extends org.pac4j.core.client.DirectClient> getDirectClients()
        Direct clients to be used for authentication. Direct clients generally bring authentication information with the request to a protected resource (i.e. as Request-Headers).
        Returns:
        The DirectClients created by the plugin.

      • getIndirectClient

        @Nullable
default org.pac4j.core.client.IndirectClient getIndirectClient()
        The indirect client to be used for authentication. Indirect clients work with an authorization flow that redirects the user to the IDP where they authenticate. The result of the authentication is then returned to the callback URL.
        Returns:
        The IndirectClient created by the plugin.

      • autoExecuteIndirectClient

        default boolean autoExecuteIndirectClient()
        Determines whether or not the provided indirect client should be executed automatically iff there is only one authenticator configured for access to a protected resource (e.g. form, backend). Automatic execution of the client will result in immediate redirection to the IDP defined by the client when accessing the protected resource.
        Returns:
        true if the provided indirect client should be automatically executed and false otherwise.
        Since:
        8.0.0