org.springdoc.core

Class SecurityService

java.lang.Object

org.springdoc.core.SecurityService

public class SecurityService
extends Object

The type Security parser.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor and Description
SecurityService(PropertyResolverUtils propertyResolverUtils) Instantiates a new Security parser.

Method Summary

Modifier and Type	Method and Description
void	buildSecurityRequirement(io.swagger.v3.oas.annotations.security.SecurityRequirement[] securityRequirements, io.swagger.v3.oas.models.Operation operation) Build security requirement.
io.swagger.v3.oas.annotations.security.SecurityRequirement[]	getSecurityRequirements(org.springframework.web.method.HandlerMethod handlerMethod) Get security requirements io . swagger . v 3 . oas . annotations . security . security requirement [ ].
Optional<List<io.swagger.v3.oas.models.security.SecurityRequirement>>	getSecurityRequirements(io.swagger.v3.oas.annotations.security.SecurityRequirement[] securityRequirementsApi) Gets security requirements.
Set<io.swagger.v3.oas.annotations.security.SecurityRequirement>	getSecurityRequirementsForClass(Class<?> beanType) Gets security requirements for class.
Set<io.swagger.v3.oas.annotations.security.SecurityRequirement>	getSecurityRequirementsForMethod(Method method, Set<io.swagger.v3.oas.annotations.security.SecurityRequirement> allSecurityTags) Gets security requirements for method.
Optional<org.springdoc.core.SecuritySchemePair>	getSecurityScheme(io.swagger.v3.oas.annotations.security.SecurityScheme securityScheme, Locale locale) Gets security scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityService

public SecurityService(PropertyResolverUtils propertyResolverUtils)

Instantiates a new Security parser.

Parameters:

propertyResolverUtils - the property resolver utils

Method Detail

getSecurityRequirements

public io.swagger.v3.oas.annotations.security.SecurityRequirement[] getSecurityRequirements(org.springframework.web.method.HandlerMethod handlerMethod)

Get security requirements io . swagger . v 3 . oas . annotations . security . security requirement [ ].

Parameters:

handlerMethod - the handlerMethod

Returns:

the io . swagger . v 3 . oas . annotations . security . security requirement [ ]

getSecurityRequirementsForMethod

public Set<io.swagger.v3.oas.annotations.security.SecurityRequirement> getSecurityRequirementsForMethod(Method method,
                                                                                                        Set<io.swagger.v3.oas.annotations.security.SecurityRequirement> allSecurityTags)

Gets security requirements for method.

Parameters:

method - the method

allSecurityTags - the all security tags

Returns:

the security requirements for method

getSecurityRequirementsForClass

public Set<io.swagger.v3.oas.annotations.security.SecurityRequirement> getSecurityRequirementsForClass(Class<?> beanType)

Gets security requirements for class.

Parameters:

beanType - the bean type

Returns:

the security requirements for class

getSecurityRequirements

public Optional<List<io.swagger.v3.oas.models.security.SecurityRequirement>> getSecurityRequirements(io.swagger.v3.oas.annotations.security.SecurityRequirement[] securityRequirementsApi)

Gets security requirements.

Parameters:

securityRequirementsApi - the security requirements api

Returns:

the security requirements

getSecurityScheme

public Optional<org.springdoc.core.SecuritySchemePair> getSecurityScheme(io.swagger.v3.oas.annotations.security.SecurityScheme securityScheme,
                                                                         Locale locale)

Gets security scheme.

Parameters:

securityScheme - the security scheme

locale - the locale

Returns:

the security scheme

buildSecurityRequirement

public void buildSecurityRequirement(io.swagger.v3.oas.annotations.security.SecurityRequirement[] securityRequirements,
                                     io.swagger.v3.oas.models.Operation operation)

Build security requirement.

Parameters:

securityRequirements - the security requirements

operation - the operation