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

Class AutoSecurityFilter

java.lang.Object

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

All Implemented Interfaces:

org.eclipse.microprofile.openapi.OASFilter

Direct Known Subclasses:

AutoBasicSecurityFilter, AutoJWTSecurityFilter, OpenIDConnectSecurityFilter

public abstract class AutoSecurityFilter
extends Object
implements org.eclipse.microprofile.openapi.OASFilter

Auto add security

Constructor Summary

Constructors

Constructor	Description
AutoSecurityFilter()
AutoSecurityFilter(String securitySchemeName, String securitySchemeDescription)

Method Summary

Modifier and Type	Method	Description
void	filterOpenAPI(org.eclipse.microprofile.openapi.models.OpenAPI openAPI)
protected abstract org.eclipse.microprofile.openapi.models.security.SecurityScheme	getSecurityScheme()
String	getSecuritySchemeDescription()
String	getSecuritySchemeName()
protected String	getUrl(String configKey, String defaultValue, String shouldEndWith)
void	setSecuritySchemeDescription(String securitySchemeDescription)
void	setSecuritySchemeName(String securitySchemeName)

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 Detail

AutoSecurityFilter

public AutoSecurityFilter()

AutoSecurityFilter

public AutoSecurityFilter(String securitySchemeName,
                          String securitySchemeDescription)

Method Detail

getSecuritySchemeName

public String getSecuritySchemeName()

setSecuritySchemeName

public void setSecuritySchemeName(String securitySchemeName)

getSecuritySchemeDescription

public String getSecuritySchemeDescription()

setSecuritySchemeDescription

public void setSecuritySchemeDescription(String securitySchemeDescription)

filterOpenAPI

public void filterOpenAPI(org.eclipse.microprofile.openapi.models.OpenAPI openAPI)

Specified by:

filterOpenAPI in interface org.eclipse.microprofile.openapi.OASFilter

getSecurityScheme

protected abstract org.eclipse.microprofile.openapi.models.security.SecurityScheme getSecurityScheme()

getUrl

protected String getUrl(String configKey,
                        String defaultValue,
                        String shouldEndWith)