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

Interface IPluginFormAuthenticatorRetVal

All Known Implementing Classes:
PluginAuthenticatorRetVal
@Deprecated public interface IPluginFormAuthenticatorRetVal
Deprecated.
Since version 8.0.0. IPluginGenericAuthenticatorRetVal should always be used instead.
Interface for the return value of an authenticator type plugin, when used as an authenticator in a form authentication context.
Author:
XIMA MEDIA GmbH

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    autoExecuteIndirectClient()
    Deprecated.
    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 org.pac4j.core.client.IndirectClient
    getClient()
    Deprecated.
    Since 7.2.0.
    default org.pac4j.core.client.DirectClient
    getDirectClient()
    Deprecated.
    The direct client to be used for authentication.
    default Collection<org.pac4j.core.client.DirectClient>
    getDirectClients()
    Deprecated.
    Direct clients to be used for authentication.
    default org.pac4j.core.client.IndirectClient
    getIndirectClient()
    Deprecated.
    The indirect client to be used for authentication.
    default boolean
    isIndirectClientSupportsDirectAuthentication()
    Deprecated.
    Use getDirectClient() or getDirectClients() if you want to create direct clients and autoExecuteIndirectClient() if the indirect client should be executed automatically if it is the only one configured.

  • Method Details

    • getDirectClient

      @Nullable default org.pac4j.core.client.DirectClient getDirectClient()
      Deprecated.
      The direct client 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 DirectClient created by the plugin.
      Since:
      7.2.0

    • getDirectClients

      @Nullable default Collection<org.pac4j.core.client.DirectClient> getDirectClients()
      Deprecated.
      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 DirectClient created by the plugin.
      Since:
      7.4.0

    • getIndirectClient

      @Nullable default org.pac4j.core.client.IndirectClient getIndirectClient()
      Deprecated.
      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.
      Since:
      7.2.0

    • autoExecuteIndirectClient

      default boolean autoExecuteIndirectClient()
      Deprecated.
      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

    • isIndirectClientSupportsDirectAuthentication

      @Deprecated default boolean isIndirectClientSupportsDirectAuthentication()
      Deprecated.
      Use getDirectClient() or getDirectClients() if you want to create direct clients and autoExecuteIndirectClient() if the indirect client should be executed automatically if it is the only one configured.
      Determines whether or not the indirect client (i.e. getIndirectClient() should be handled as a direct client. This means that the security logic of the client should be performed directly if the authenticator is the only authenticator configured for a protected resource (see #getDirectClient()). If a direct client is given then the direct client will be tried first.
      Returns:
      true if the indirect client should be treated as a direct client in the security logic of a protected resource and false otherwise.
      Since:
      7.2.0

    • getClient

      @Deprecated default org.pac4j.core.client.IndirectClient getClient()
      Deprecated.
      Since 7.2.0. Use getIndirectClient() instead for producing an indirect client.
      The client to be used for authenticating the user.
      Returns:
      The IndirectClient created by the plugin.