Interface LogoutProvider


  • @ConsumerType
    public interface LogoutProvider
    The LogoutProvider interface provides the ability to perform a log-out operation.

    If a registered Provider service implements this interface the logout(HttpServletRequest,ProviderConfig) method is called during the dropCredentials execution.

    Since:
    3.13
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String logout​(javax.servlet.http.HttpServletRequest request, ProviderConfig providerConfig)
      This method will perform all the backend steps of the logout process.
    • Method Detail

      • logout

        java.lang.String logout​(javax.servlet.http.HttpServletRequest request,
                                ProviderConfig providerConfig)
        This method will perform all the backend steps of the logout process.
        Parameters:
        request - The request to the logout URL. Used to correctly build the callback URL.
        providerConfig - The OAuth Provider configuration
        Returns:
        the URL where to redirect after logout
        Since:
        3.13