Package io.quarkus.oidc

Class OidcTenantConfig.Logout

java.lang.Object

io.quarkus.oidc.OidcTenantConfig.Logout

Enclosing class:

OidcTenantConfig

public static class OidcTenantConfig.Logout
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
OidcTenantConfig.Backchannel	backchannel	Back-Channel Logout configuration
Map<String,String>	extraParams	Additional properties which will be added as the query parameters to the logout redirect URI.
OidcTenantConfig.Frontchannel	frontchannel	Front-Channel Logout configuration
Optional<String>	path	The relative path of the logout endpoint at the application.
Optional<String>	postLogoutPath	Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider.
String	postLogoutUriParam	Name of the post logout URI parameter which will be added as a query parameter to the logout redirect URI.

Constructor Summary

Constructors

Constructor	Description
Logout()

Method Summary

Modifier and Type	Method	Description
OidcTenantConfig.Backchannel	getBackchannel()
Map<String,String>	getExtraParams()
OidcTenantConfig.Frontchannel	getFrontchannel()
Optional<String>	getPath()
Optional<String>	getPostLogoutPath()
String	getPostLogoutUriParam()
void	setBackchannel(OidcTenantConfig.Backchannel backchannel)
void	setExtraParams(Map<String,String> extraParams)
void	setFrontchannel(OidcTenantConfig.Frontchannel frontchannel)
void	setPath(Optional<String> path)
void	setPostLogoutPath(Optional<String> postLogoutPath)
void	setPostLogoutUriParam(String postLogoutUriParam)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

path

@ConfigItem
public Optional<String> path

The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification.

postLogoutPath

@ConfigItem
public Optional<String> postLogoutPath

Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI.

postLogoutUriParam

@ConfigItem(defaultValue="post_logout_redirect_uri")
public String postLogoutUriParam

Name of the post logout URI parameter which will be added as a query parameter to the logout redirect URI.

extraParams

@ConfigItem
public Map<String,String> extraParams

Additional properties which will be added as the query parameters to the logout redirect URI.

backchannel

@ConfigItem
public OidcTenantConfig.Backchannel backchannel

Back-Channel Logout configuration

frontchannel

@ConfigItem
public OidcTenantConfig.Frontchannel frontchannel

Front-Channel Logout configuration

Constructor Detail

Logout

public Logout()

Method Detail

setPath

public void setPath(Optional<String> path)

getPath

public Optional<String> getPath()

setPostLogoutPath

public void setPostLogoutPath(Optional<String> postLogoutPath)

getPostLogoutPath

public Optional<String> getPostLogoutPath()

getExtraParams

public Map<String,String> getExtraParams()

setExtraParams

public void setExtraParams(Map<String,String> extraParams)

getPostLogoutUriParam

public String getPostLogoutUriParam()

setPostLogoutUriParam

public void setPostLogoutUriParam(String postLogoutUriParam)

getBackchannel

public OidcTenantConfig.Backchannel getBackchannel()

setBackchannel

public void setBackchannel(OidcTenantConfig.Backchannel backchannel)

getFrontchannel

public OidcTenantConfig.Frontchannel getFrontchannel()

setFrontchannel

public void setFrontchannel(OidcTenantConfig.Frontchannel frontchannel)