Class OidcClientInitiatedLogoutSuccessHandler
- java.lang.Object
-
- org.springframework.security.web.authentication.AbstractAuthenticationTargetUrlRequestHandler
-
- org.springframework.security.web.authentication.logout.SimpleUrlLogoutSuccessHandler
-
- org.springframework.security.oauth2.client.oidc.web.logout.OidcClientInitiatedLogoutSuccessHandler
-
- All Implemented Interfaces:
LogoutSuccessHandler
public final class OidcClientInitiatedLogoutSuccessHandler extends SimpleUrlLogoutSuccessHandler
A logout success handler for initiating OIDC logout through the user agent.- Since:
- 5.2
- See Also:
- RP-Initiated
Logout,
LogoutSuccessHandler
-
-
Field Summary
-
Fields inherited from class org.springframework.security.web.authentication.AbstractAuthenticationTargetUrlRequestHandler
logger
-
-
Constructor Summary
Constructors Constructor Description OidcClientInitiatedLogoutSuccessHandler(ClientRegistrationRepository clientRegistrationRepository)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected java.lang.String
determineTargetUrl(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Authentication authentication)
Builds the target URL according to the logic defined in the main class Javadocvoid
setPostLogoutRedirectUri(java.lang.String postLogoutRedirectUri)
Set the post logout redirect uri template.void
setPostLogoutRedirectUri(java.net.URI postLogoutRedirectUri)
Deprecated.-
Methods inherited from class org.springframework.security.web.authentication.logout.SimpleUrlLogoutSuccessHandler
onLogoutSuccess
-
Methods inherited from class org.springframework.security.web.authentication.AbstractAuthenticationTargetUrlRequestHandler
determineTargetUrl, getDefaultTargetUrl, getRedirectStrategy, getTargetUrlParameter, handle, isAlwaysUseDefaultTargetUrl, setAlwaysUseDefaultTargetUrl, setDefaultTargetUrl, setRedirectStrategy, setTargetUrlParameter, setUseReferer
-
-
-
-
Constructor Detail
-
OidcClientInitiatedLogoutSuccessHandler
public OidcClientInitiatedLogoutSuccessHandler(ClientRegistrationRepository clientRegistrationRepository)
-
-
Method Detail
-
determineTargetUrl
protected java.lang.String determineTargetUrl(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Authentication authentication)
Description copied from class:AbstractAuthenticationTargetUrlRequestHandler
Builds the target URL according to the logic defined in the main class Javadoc- Overrides:
determineTargetUrl
in classAbstractAuthenticationTargetUrlRequestHandler
-
setPostLogoutRedirectUri
@Deprecated public void setPostLogoutRedirectUri(java.net.URI postLogoutRedirectUri)
Deprecated.Set the post logout redirect uri to use- Parameters:
postLogoutRedirectUri
- - A valid URL to which the OP should redirect after logging out the user
-
setPostLogoutRedirectUri
public void setPostLogoutRedirectUri(java.lang.String postLogoutRedirectUri)
Set the post logout redirect uri template.
The supported uri template variables are:{baseScheme}
,{baseHost}
,{basePort}
and{basePath}
.
NOTE:"{baseUrl}"
is also supported, which is the same as"{baseScheme}://{baseHost}{basePort}{basePath}"
handler.setPostLogoutRedirectUri("{baseUrl}");
will make so thatpost_logout_redirect_uri
will be set to the base url for the client application.- Parameters:
postLogoutRedirectUri
- - A template for creating thepost_logout_redirect_uri
query parameter- Since:
- 5.3
-
-