*
 * This exception is used to indicate various SSO authentication failures
 * including configuration errors, authentication token validation failures,
 * communication issues with SSO providers, and other SSO-related problems.
 */
public class SsoLoginException extends FessSystemException {

    /** Serial version UID for serialization compatibility. */
    private static final long serialVersionUID = 1L;

private RdmaProvider selectRdmaProvider() {
    // Try providers in order of preference
    List<RdmaProvider> providers = Arrays.asList(
        new DisniRdmaProvider(),      // InfiniBand/RoCE
        new JxioRdmaProvider(),       // Alternative RDMA library
        new TcpRdmaProvider()         // TCP fallback
    );
    
    for (RdmaProvider provider : providers) {
        if (provider.isAvailable()) {

 * of SSO authentication and authorization processes. It extends FessSystemException
 * to provide consistent error handling within the Fess system for SSO-related
 * processing failures such as token validation errors, communication failures
 * with SSO providers, or configuration issues.
 */
public class SsoProcessException extends FessSystemException {

 * base for all providers that register such extensions.
 * <p>
 * Implementations of this interface are discovered through the Java ServiceLoader mechanism.
 * Each implementation must be registered in a {@code META-INF/services/} file corresponding
 * to the specific provider interface being implemented.
 * <p>
 * Example implementation for a custom language provider:
 * <pre>

in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holders nor...

    - 'HTTPS': features/https.md
    - 'Interceptors': features/interceptors.md
    - 'R8/Proguard': features/r8_proguard.md
  - 'Recipes': recipes.md
  - 'Security':
    - 'Security': security/security.md
    - 'Providers': security/security_providers.md
    - 'Configuration History': security/tls_configuration_history.md
  - 'Works with OkHttp': works_with_okhttp.md
  - 'API': 5.x/okhttp/okhttp3/
  - 'Change Logs':

  // From "How Provider Implementations Are Requested and Supplied" from
  // https://docs.oracle.com/en/java/javase/25/security/java-cryptography-architecture-jca-reference-guide.html#:~:text=How%20Provider%20Implementations%20Are%20Requested%20and%20Supplied
  //  - Some providers may choose to also include alias names.

## Introduction

Returns a set of temporary security credentials for applications/clients who have been authenticated through client credential grants provided by identity provider. Example providers include KeyCloak, Okta etc.

Integrating other authentication/authorization providers like Google, Facebook, X (Twitter), GitHub, etc. is also possible and relatively easy.

The most complex problem is building an authentication/authorization provider like those, but **FastAPI** gives you the tools to do it easily, while doing the heavy lifting for you.

///

## **FastAPI** utilities { #fastapi-utilities }

     *
     * This method handles SSO logout requests, coordinating with the SSO provider
     * to properly terminate the user's SSO session. It may involve redirecting
     * to the SSO provider's logout endpoint or performing local logout operations.
     *
     * @return ActionResponse directing to the logout page or SSO provider logout endpoint
     */
    @Execute
    public ActionResponse logout() {