Package org.codelibs.fess.sso

Interface SsoAuthenticator

All Known Implementing Classes:
EntraIdAuthenticator, OpenIdConnectAuthenticator, SamlAuthenticator, SpnegoAuthenticator
public interface SsoAuthenticator
Interface for SSO (Single Sign-On) authenticator implementations. This interface defines the contract for SSO authentication providers that can be integrated with Fess. Implementations handle specific SSO protocols like SAML, OAuth, SPNEGO, or other authentication mechanisms. Each authenticator is responsible for obtaining login credentials, resolving user information, and managing SSO lifecycle operations like logout and metadata exchange.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.lastaflute.web.login.credential.LoginCredential
    getLoginCredential()
    Gets the login credential for SSO authentication.
    org.lastaflute.web.response.ActionResponse
    getResponse(SsoResponseType responseType)
    Gets the action response for the specified SSO response type.
    String
    logout(org.codelibs.fess.mylasta.action.FessUserBean user)
    Performs logout for the specified user.
    void
    resolveCredential(FessLoginAssist.LoginCredentialResolver resolver)
    Resolves credential using the provided resolver.

  • Method Details

    • getLoginCredential

      org.lastaflute.web.login.credential.LoginCredential getLoginCredential()
      Gets the login credential for SSO authentication.
      Returns:
      The login credential.

    • resolveCredential

      void resolveCredential(FessLoginAssist.LoginCredentialResolver resolver)
      Resolves credential using the provided resolver.
      Parameters:
      resolver - The login credential resolver.

    • getResponse

      org.lastaflute.web.response.ActionResponse getResponse(SsoResponseType responseType)
      Gets the action response for the specified SSO response type.
      Parameters:
      responseType - The type of SSO response required.
      Returns:
      The action response.

    • logout

      String logout(org.codelibs.fess.mylasta.action.FessUserBean user)
      Performs logout for the specified user.
      Parameters:
      user - The user to logout.
      Returns:
      The logout URL or null if not applicable.