Package io.quarkus.smallrye.openapi.deployment.filter

Class AutoRolesAllowedFilter

java.lang.Object

io.quarkus.smallrye.openapi.deployment.filter.AutoRolesAllowedFilter

All Implemented Interfaces:

org.eclipse.microprofile.openapi.OASFilter

public class AutoRolesAllowedFilter
extends Object
implements org.eclipse.microprofile.openapi.OASFilter

Automatically add security requirement to RolesAllowed methods

Constructor Summary

Constructors

Constructor	Description
AutoRolesAllowedFilter()
AutoRolesAllowedFilter(String defaultSecuritySchemeName, Map<String,List<String>> rolesAllowedMethodReferences, List<String> authenticatedMethodReferences)

Method Summary

Modifier and Type	Method	Description
void	filterOpenAPI(org.eclipse.microprofile.openapi.models.OpenAPI openAPI)
List<String>	getAuthenticatedMethodReferences()
String	getDefaultSecuritySchemeName()
Map<String,List<String>>	getRolesAllowedMethodReferences()
boolean	hasAuthenticatedMethodReference(String methodRef)
boolean	hasAuthenticatedMethodReferences()
boolean	hasRolesAllowedMethodReference(String methodRef)
boolean	hasRolesAllowedMethodReferences()
void	setAuthenticatedMethodReferences(List<String> authenticatedMethodReferences)
void	setDefaultSecuritySchemeName(String defaultSecuritySchemeName)
void	setRolesAllowedMethodReferences(Map<String,List<String>> rolesAllowedMethodReferences)

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

AutoRolesAllowedFilter

public AutoRolesAllowedFilter()

AutoRolesAllowedFilter

public AutoRolesAllowedFilter(String defaultSecuritySchemeName,
 Map<String,List<String>> rolesAllowedMethodReferences,
 List<String> authenticatedMethodReferences)

Method Details

getRolesAllowedMethodReferences

public Map<String,List<String>> getRolesAllowedMethodReferences()

setRolesAllowedMethodReferences

public void setRolesAllowedMethodReferences(Map<String,List<String>> rolesAllowedMethodReferences)

hasRolesAllowedMethodReferences

public boolean hasRolesAllowedMethodReferences()

hasRolesAllowedMethodReference

public boolean hasRolesAllowedMethodReference(String methodRef)

getAuthenticatedMethodReferences

public List<String> getAuthenticatedMethodReferences()

setAuthenticatedMethodReferences

public void setAuthenticatedMethodReferences(List<String> authenticatedMethodReferences)

hasAuthenticatedMethodReferences

public boolean hasAuthenticatedMethodReferences()

hasAuthenticatedMethodReference

public boolean hasAuthenticatedMethodReference(String methodRef)

getDefaultSecuritySchemeName

public String getDefaultSecuritySchemeName()

setDefaultSecuritySchemeName

public void setDefaultSecuritySchemeName(String defaultSecuritySchemeName)

filterOpenAPI

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

Specified by:

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