Package io.quarkus.smallrye.openapi.runtime.filter

Class OpenIDConnectSecurityFilter

java.lang.Object

io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

io.quarkus.smallrye.openapi.runtime.filter.OpenIDConnectSecurityFilter

All Implemented Interfaces:

org.eclipse.microprofile.openapi.OASFilter

public class OpenIDConnectSecurityFilter
extends AutoSecurityFilter

Add OAuth 2 (Implicit) Authentication security automatically based on the added security extensions

Constructor Summary

Constructors

Constructor	Description
OpenIDConnectSecurityFilter()
OpenIDConnectSecurityFilter(String securitySchemeName, String securitySchemeDescription, Map<String,String> securitySchemeExtensions, AutoUrl openIdConnectUrl)

Method Summary

Modifier and Type	Method	Description
AutoUrl	getOpenIdConnectUrl()
boolean	runtimeRequired()
void	setOpenIdConnectUrl(AutoUrl openIdConnectUrl)
protected void	updateSecurityScheme(org.eclipse.microprofile.openapi.models.security.SecurityScheme securityScheme)

Methods inherited from class io.quarkus.smallrye.openapi.runtime.filter.AutoSecurityFilter

filterOpenAPI, getSecuritySchemeDescription, getSecuritySchemeExtensions, getSecuritySchemeName, getUrl, setSecuritySchemeDescription, setSecuritySchemeExtensions, setSecuritySchemeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.microprofile.openapi.OASFilter

filterAPIResponse, filterCallback, filterHeader, filterLink, filterOperation, filterParameter, filterPathItem, filterRequestBody, filterSchema, filterSecurityScheme, filterServer, filterTag

Constructor Details

OpenIDConnectSecurityFilter

public OpenIDConnectSecurityFilter()

OpenIDConnectSecurityFilter

public OpenIDConnectSecurityFilter(String securitySchemeName,
 String securitySchemeDescription,
 Map<String,String> securitySchemeExtensions,
 AutoUrl openIdConnectUrl)

Method Details

getOpenIdConnectUrl

public AutoUrl getOpenIdConnectUrl()

setOpenIdConnectUrl

public void setOpenIdConnectUrl(AutoUrl openIdConnectUrl)

runtimeRequired

public boolean runtimeRequired()

Overrides:

runtimeRequired in class AutoSecurityFilter

updateSecurityScheme

protected void updateSecurityScheme(org.eclipse.microprofile.openapi.models.security.SecurityScheme securityScheme)

Specified by:

updateSecurityScheme in class AutoSecurityFilter