Package io.smallrye.openapi.runtime.io.securityrequirement

Class SecurityRequirementReader

java.lang.Object

io.smallrye.openapi.runtime.io.securityrequirement.SecurityRequirementReader

public class SecurityRequirementReader
extends Object

Reading the Security from annotations or json

Author:

Phillip Kruger (phillip.kruger@redhat.com), Eric Wittmann (eric.wittmann@gmail.com)

See Also:

• security-requirement-object

Method Summary

Modifier and Type	Method	Description
static List<org.jboss.jandex.AnnotationInstance>	getSecurityRequirementAnnotations(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget target)
static org.jboss.jandex.AnnotationInstance	getSecurityRequirementsAnnotation(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget target)
static List<org.jboss.jandex.AnnotationInstance>	getSecurityRequirementsSetAnnotations(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget target)
static org.jboss.jandex.AnnotationInstance	getSecurityRequirementsSetsAnnotation(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget target)
static org.eclipse.microprofile.openapi.models.security.SecurityRequirement	readSecurityRequirement(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance)	Reads a single SecurityRequirement annotation.
static Optional<List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement>>	readSecurityRequirements(com.fasterxml.jackson.databind.JsonNode node)	Reads a list of SecurityRequirement OpenAPI nodes.
static Optional<List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement>>	readSecurityRequirements(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue securityRequirements, org.jboss.jandex.AnnotationValue securityRequirementsSets)	Reads any SecurityRequirement and SecurityRequirementsSet annotations.
static org.eclipse.microprofile.openapi.models.security.SecurityRequirement	readSecurityRequirementsSet(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotationInstance)	Reads a single SecurityRequirementsSet annotation

Methods inherited from class java.lang.Object

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

Method Details

readSecurityRequirements

public static Optional<List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement>> readSecurityRequirements(AnnotationScannerContext context,
 org.jboss.jandex.AnnotationValue securityRequirements,
 org.jboss.jandex.AnnotationValue securityRequirementsSets)

Reads any SecurityRequirement and SecurityRequirementsSet annotations.

Parameters:

securityRequirements - Array of @SecurityRequirement annotations

securityRequirementsSets - Array of @SecurityRequirementsSet annotation

Returns:

List of SecurityRequirement models

readSecurityRequirements

public static Optional<List<org.eclipse.microprofile.openapi.models.security.SecurityRequirement>> readSecurityRequirements(com.fasterxml.jackson.databind.JsonNode node)

Reads a list of SecurityRequirement OpenAPI nodes.

Parameters:

node - the json array

Returns:

List of SecurityRequirement models

readSecurityRequirement

public static org.eclipse.microprofile.openapi.models.security.SecurityRequirement readSecurityRequirement(AnnotationScannerContext context,
 org.jboss.jandex.AnnotationInstance annotationInstance)

Reads a single SecurityRequirement annotation.

Parameters:

annotationInstance - the @SecurityRequirement annotation

Returns:

SecurityRequirement model

readSecurityRequirementsSet

public static org.eclipse.microprofile.openapi.models.security.SecurityRequirement readSecurityRequirementsSet(AnnotationScannerContext context,
 org.jboss.jandex.AnnotationInstance annotationInstance)

Reads a single SecurityRequirementsSet annotation

Parameters:

annotationInstance - the @SecurityRequirementsSet annotation

Returns:

SecurityRequirement model

getSecurityRequirementsAnnotation

public static org.jboss.jandex.AnnotationInstance getSecurityRequirementsAnnotation(AnnotationScannerContext context,
 org.jboss.jandex.AnnotationTarget target)

getSecurityRequirementAnnotations

public static List<org.jboss.jandex.AnnotationInstance> getSecurityRequirementAnnotations(AnnotationScannerContext context,
 org.jboss.jandex.AnnotationTarget target)

getSecurityRequirementsSetsAnnotation

public static org.jboss.jandex.AnnotationInstance getSecurityRequirementsSetsAnnotation(AnnotationScannerContext context,
 org.jboss.jandex.AnnotationTarget target)

getSecurityRequirementsSetAnnotations

public static List<org.jboss.jandex.AnnotationInstance> getSecurityRequirementsSetAnnotations(AnnotationScannerContext context,
 org.jboss.jandex.AnnotationTarget target)