Interface Saml2LogoutRequestRepository

All Known Implementing Classes:
HttpSessionLogoutRequestRepository
public interface Saml2LogoutRequestRepository
Implementations of this interface are responsible for the persistence of Saml2LogoutRequest between requests.

Used by the Saml2RelyingPartyInitiatedLogoutSuccessHandler for persisting the Logout Request before it initiates the SAML 2.0 SLO flow. As well, used by OpenSamlLogoutResponseHandler for resolving the Logout Request associated with that Logout Response.

Since:
5.6
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Saml2LogoutRequest
    loadLogoutRequest(jakarta.servlet.http.HttpServletRequest request)
    Returns the Saml2LogoutRequest associated to the provided HttpServletRequest or null if not available.
    @Nullable Saml2LogoutRequest
    removeLogoutRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    Removes and returns the Saml2LogoutRequest associated to the provided HttpServletRequest and HttpServletResponse or if not available returns null.
    void
    saveLogoutRequest(@Nullable Saml2LogoutRequest logoutRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    Persists the Saml2LogoutRequest associating it to the provided HttpServletRequest and/or HttpServletResponse.

  • Method Details

    • loadLogoutRequest

      @Nullable Saml2LogoutRequest loadLogoutRequest(jakarta.servlet.http.HttpServletRequest request)
      Returns the Saml2LogoutRequest associated to the provided HttpServletRequest or null if not available.
      Parameters:
      request - the HttpServletRequest
      Returns:
      the Saml2LogoutRequest or null if not available

    • saveLogoutRequest

      void saveLogoutRequest(@Nullable Saml2LogoutRequest logoutRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Persists the Saml2LogoutRequest associating it to the provided HttpServletRequest and/or HttpServletResponse.
      Parameters:
      logoutRequest - the Saml2LogoutRequest, if null, then remove logout request
      request - the HttpServletRequest
      response - the HttpServletResponse

    • removeLogoutRequest

      @Nullable Saml2LogoutRequest removeLogoutRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      Removes and returns the Saml2LogoutRequest associated to the provided HttpServletRequest and HttpServletResponse or if not available returns null.
      Parameters:
      request - the HttpServletRequest
      response - the HttpServletResponse
      Returns:
      the Saml2LogoutRequest or null if not available