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, AutoBearerTokenSecurityFilter, OpenIDConnectSecurityFilter

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

Auto add security

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AutoSecurityFilter()
protected	AutoSecurityFilter(String securitySchemeName, String securitySchemeDescription, Map<String,String> securitySchemeExtensions)

Method Summary

Modifier and Type	Method	Description
void	filterOpenAPI(org.eclipse.microprofile.openapi.models.OpenAPI openAPI)
String	getSecuritySchemeDescription()
Map<String,String>	getSecuritySchemeExtensions()
String	getSecuritySchemeName()
protected String	getUrl(String configKey, String defaultValue, String shouldEndWith)
boolean	runtimeRequired()
void	setSecuritySchemeDescription(String securitySchemeDescription)
void	setSecuritySchemeExtensions(Map<String,String> securitySchemeExtensions)
void	setSecuritySchemeName(String securitySchemeName)
protected abstract void	updateSecurityScheme(org.eclipse.microprofile.openapi.models.security.SecurityScheme securityScheme)

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

AutoSecurityFilter

protected AutoSecurityFilter()

AutoSecurityFilter

protected AutoSecurityFilter(String securitySchemeName,
 String securitySchemeDescription,
 Map<String,String> securitySchemeExtensions)

Method Details

getSecuritySchemeName

public String getSecuritySchemeName()

setSecuritySchemeName

public void setSecuritySchemeName(String securitySchemeName)

getSecuritySchemeDescription

public String getSecuritySchemeDescription()

setSecuritySchemeDescription

public void setSecuritySchemeDescription(String securitySchemeDescription)

getSecuritySchemeExtensions

public Map<String,String> getSecuritySchemeExtensions()

setSecuritySchemeExtensions

public void setSecuritySchemeExtensions(Map<String,String> securitySchemeExtensions)

runtimeRequired

public boolean runtimeRequired()

filterOpenAPI

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

Specified by:

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

updateSecurityScheme

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

getUrl

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