Package de.xima.fc.interfaces.auth

Interface IAuthenticatorClients

  • All Known Implementing Classes:
    DefaultAuthenticatorClients
    public interface IAuthenticatorClients
    Common interface for clients of an authenticator. Every authenticator may produce different clients for different authentication flows (i.e. direct / indirect / silent SSO).
    Since:
    7.2.0
    Author:
    XIMA Media GmbH

    • Method Detail

      • getClientDescriptor

        @NotNull
@NotNull IClientDescriptor getClientDescriptor()
        Returns the descriptor for these client.
        Returns:
        the descriptor for these clients.
        Since:
        8.0.0

      • getDirectClients

        Collection<org.pac4j.core.client.Client> getDirectClients()
        Returns the direct clients of this authenticator configuration.
        Returns:
        a collection of all direct clients of this authenticator configuration.
        Since:
        8.0.0

      • getIndirectClient

        @Nullable
org.pac4j.core.client.Client getIndirectClient()
        Returns the indirect client of this authenticator configuration.
        Returns:
        the indirect client of this authenticator configuration if it exists and null otherwise.
        Since:
        8.0.0

      • getClients

        Collection<org.pac4j.core.client.Client> getClients​(EAuthenticationFlow authFlow)
        Gets all clients for the given authentication flow.
        Parameters:
        authFlow - authentication flow for which a clients are requested.
        Returns:
        A collection of clients for the given authentication flow.

      • getAllClients

        Collection<org.pac4j.core.client.Client> getAllClients()
        Returns:
        A collection of all clients regardless of authentication flow.

      • autoExecuteIndirectClient

        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