Uses of Class
io.smallrye.openapi.runtime.scanner.spi.AnnotationScannerContext

Packages that use AnnotationScannerContext

Package	Description
io.smallrye.openapi.runtime.io
io.smallrye.openapi.runtime.io.schema
io.smallrye.openapi.runtime.scanner
io.smallrye.openapi.runtime.scanner.dataobject
io.smallrye.openapi.runtime.scanner.processor
io.smallrye.openapi.runtime.scanner.spi
io.smallrye.openapi.runtime.util

Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io

Methods in io.smallrye.openapi.runtime.io that return AnnotationScannerContext

Modifier and Type	Method	Description
AnnotationScannerContext	IOContext.scannerContext()
AnnotationScannerContext	ModelIO.scannerContext()

Methods in io.smallrye.openapi.runtime.io with parameters of type AnnotationScannerContext

Modifier and Type	Method	Description
static IOContext<?,?,?,?,?>	IOContext.forScanning(AnnotationScannerContext context)
void	IOContext.scannerContext(AnnotationScannerContext scannerContext)

Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io.schema

Methods in io.smallrye.openapi.runtime.io.schema with parameters of type AnnotationScannerContext

Modifier and Type	Method	Description
static org.eclipse.microprofile.openapi.models.media.Schema	SchemaFactory.enumToSchema(AnnotationScannerContext context, org.jboss.jandex.Type enumType)	Convert a Jandex enum class type to a Schema model.
static org.eclipse.microprofile.openapi.models.media.Schema	SchemaFactory.includeTypeSchema(AnnotationScannerContext context, org.eclipse.microprofile.openapi.models.media.Schema schema, org.jboss.jandex.Type type)
static org.eclipse.microprofile.openapi.models.media.Schema	SchemaFactory.readSchema(AnnotationScannerContext context, org.eclipse.microprofile.openapi.models.media.Schema schema, org.jboss.jandex.AnnotationInstance annotation, Map<String,Object> defaults)
static org.eclipse.microprofile.openapi.models.media.Schema	SchemaFactory.readSchema(AnnotationScannerContext context, org.eclipse.microprofile.openapi.models.media.Schema schema, org.jboss.jandex.AnnotationInstance annotation, org.jboss.jandex.ClassInfo clazz, boolean registerSchema)	Populates the schema using the @Schema on the provided class.
static org.eclipse.microprofile.openapi.models.media.Schema	SchemaFactory.readSchema(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance schemaAnnotation)	Reads a Schema annotation into a model.
static org.eclipse.microprofile.openapi.models.media.Schema	SchemaFactory.readSchema(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue value)	Reads a Schema annotation into a model.
static org.eclipse.microprofile.openapi.models.media.Schema	SchemaFactory.schemaRegistration(AnnotationScannerContext context, org.jboss.jandex.Type type, org.eclipse.microprofile.openapi.models.media.Schema schema)	Register the provided schema in the SchemaRegistry if allowed.
static org.eclipse.microprofile.openapi.models.media.Schema	SchemaFactory.typeToSchema(AnnotationScannerContext context, org.jboss.jandex.Type type)	Converts a Jandex type to a Schema model.
static org.eclipse.microprofile.openapi.models.media.Schema	SchemaFactory.typeToSchema(AnnotationScannerContext context, org.jboss.jandex.Type type, org.jboss.jandex.AnnotationInstance schemaAnnotation)	Converts a Jandex type to a Schema model.

Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.scanner

Methods in io.smallrye.openapi.runtime.scanner with parameters of type AnnotationScannerContext

Modifier and Type	Method	Description
static List<AnnotationScannerExtension>	AnnotationScannerExtension.defaultExtension(AnnotationScannerContext scannerContext)	Deprecated.
static org.eclipse.microprofile.openapi.models.media.Schema	OpenApiDataObjectScanner.process(AnnotationScannerContext context, org.jboss.jandex.Type type)	Build a Schema with ClassType as root.

Constructors in io.smallrye.openapi.runtime.scanner with parameters of type AnnotationScannerContext

Modifier	Constructor	Description
	OpenApiAnnotationScanner(AnnotationScannerContext context, Supplier<Iterable<AnnotationScanner>> scannerSupplier)	Deprecated.
	OpenApiDataObjectScanner(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget annotationTarget, org.jboss.jandex.Type classType)
	OpenApiDataObjectScanner(AnnotationScannerContext context, org.jboss.jandex.Type classType)	Constructor for data object scanner.
	SchemaRegistry(AnnotationScannerContext context)

Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.scanner.dataobject

Methods in io.smallrye.openapi.runtime.scanner.dataobject with parameters of type AnnotationScannerContext

Modifier and Type	Method	Description
static void	BeanValidationScanner.applyConstraints(AnnotationScannerContext context, org.jboss.jandex.Type type, org.eclipse.microprofile.openapi.models.media.Schema schema)	Apply validation constraints found on the type to the schema, if bean validation scanning is enabled on the given context.
static boolean	IgnoreResolver.configuresVisibility(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget target)	Check whether the given target contains annotations that configure the visibility of the properties of the type annotated.
static List<Object>	EnumProcessor.enumConstants(AnnotationScannerContext context, org.jboss.jandex.Type enumType)
static TypeResolver	TypeResolver.forClass(AnnotationScannerContext context, org.jboss.jandex.ClassInfo clazz, org.jboss.jandex.Type leaf)	Create a new TypeResolver for the given ClassInfo clazz and type.
static Map<String,TypeResolver>	TypeResolver.getAllFields(AnnotationScannerContext context, org.jboss.jandex.Type leaf, org.jboss.jandex.ClassInfo leafKlazz, org.jboss.jandex.AnnotationTarget reference)
static org.eclipse.microprofile.openapi.models.media.Schema	AnnotationTargetProcessor.process(AnnotationScannerContext context, DataObjectDeque objectStack, TypeResolver typeResolver, DataObjectDeque.PathEntry parentPathEntry)
static org.eclipse.microprofile.openapi.models.media.Schema	AnnotationTargetProcessor.process(AnnotationScannerContext context, DataObjectDeque objectStack, TypeResolver typeResolver, DataObjectDeque.PathEntry parentPathEntry, org.jboss.jandex.Type type)
static Optional<org.jboss.jandex.ParameterizedType>	TypeResolver.resolveParameterizedAncestor(AnnotationScannerContext context, org.jboss.jandex.Type type, org.jboss.jandex.Type seekType)

Constructors in io.smallrye.openapi.runtime.scanner.dataobject with parameters of type AnnotationScannerContext

Modifier	Constructor	Description
	BeanValidationScanner(AnnotationScannerContext context)
	IgnoreResolver(AnnotationScannerContext context)
	TypeProcessor(AnnotationScannerContext context, DataObjectDeque objectStack, DataObjectDeque.PathEntry parentPathEntry, TypeResolver typeResolver, org.jboss.jandex.Type type, org.eclipse.microprofile.openapi.models.media.Schema schema, org.jboss.jandex.AnnotationTarget annotationTarget)

Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.scanner.processor

Constructors in io.smallrye.openapi.runtime.scanner.processor with parameters of type AnnotationScannerContext

Modifier	Constructor	Description
	JavaSecurityProcessor(AnnotationScannerContext context)

Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.scanner.spi

Fields in io.smallrye.openapi.runtime.scanner.spi declared as AnnotationScannerContext

Modifier and Type	Field	Description
protected AnnotationScannerContext	AbstractAnnotationScanner.context
protected final AnnotationScannerContext	AbstractParameterProcessor.scannerContext

Methods in io.smallrye.openapi.runtime.scanner.spi with parameters of type AnnotationScannerContext

Modifier and Type	Method	Description
default void	AnnotationScanner.clearJsonViewContext(AnnotationScannerContext context)
default void	AnnotationScanner.createResponseFromRestMethod(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation)	Called when a scanner (jax-rs, spring) method's APIResponse annotations have all been processed but no response was actually created for the operation.This method will create a response from the method information and add it to the given operation.
default String[]	AnnotationScanner.getConsumes(AnnotationScannerContext context)
default String[]	AnnotationScanner.getConsumesForRequestBody(AnnotationScannerContext context)
String[]	AbstractAnnotationScanner.getDefaultConsumes(AnnotationScannerContext context, org.jboss.jandex.MethodInfo methodInfo, ResourceParameters params)
String[]	AnnotationScanner.getDefaultConsumes(AnnotationScannerContext context, org.jboss.jandex.MethodInfo methodInfo, ResourceParameters params)
String[]	AbstractAnnotationScanner.getDefaultProduces(AnnotationScannerContext context, org.jboss.jandex.MethodInfo methodInfo)
String[]	AnnotationScanner.getDefaultProduces(AnnotationScannerContext context, org.jboss.jandex.MethodInfo methodInfo)
default org.jboss.jandex.Type	AnnotationScanner.getKotlinContinuationArgument(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method)
default org.jboss.jandex.Type	AnnotationScanner.getRequestBodyParameterClassType(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, ResourceParameters params)	Go through the method parameters looking for one that is not a Kotlin Continuation, is not annotated with a jax-rs/spring annotation, and is not a known path parameter.
default List<org.jboss.jandex.MethodInfo>	AnnotationScanner.getResourceMethods(AnnotationScannerContext context, org.jboss.jandex.ClassInfo resource)	Extracts all methods from the provided class and its ancestors that are known to the instance's index
default boolean	AnnotationScanner.isEmptySecurityRequirements(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget target)	Determines whether the target is annotated with an empty @SecurityRequirements or @SecurityRequirementsSets annotation.
default boolean	AnnotationScanner.isPathParameter(AnnotationScannerContext context, String name, ResourceParameters params)
default boolean	AnnotationScanner.isScannerInternalResponse(org.jboss.jandex.Type returnType, AnnotationScannerContext context, org.jboss.jandex.MethodInfo method)
default org.eclipse.microprofile.openapi.models.media.Schema	AnnotationScanner.kotlinContinuationToSchema(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method)
default void	AnnotationScanner.processCallback(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation)	Process a callback annotation
default org.eclipse.microprofile.openapi.models.OpenAPI	AnnotationScanner.processDefinitionAnnotation(AnnotationScannerContext context, org.jboss.jandex.ClassInfo targetClass)	Process a certain class for OpenApiDefinition annotations.
default void	AnnotationScanner.processExtensions(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation)	Process the Extensions annotations
default void	AnnotationScanner.processJavaSecurity(AnnotationScannerContext context, org.jboss.jandex.ClassInfo resourceClass, org.eclipse.microprofile.openapi.models.OpenAPI openApi)	Process Java security (roles allowed and declared roles)
default Optional<org.eclipse.microprofile.openapi.models.Operation>	AnnotationScanner.processOperation(AnnotationScannerContext context, org.jboss.jandex.ClassInfo resourceClass, org.jboss.jandex.MethodInfo method)	While scanning JAX-RS/Spring method, find the operations
default void	AnnotationScanner.processOperationTags(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.OpenAPI openApi, Set<String> resourceTags, org.eclipse.microprofile.openapi.models.Operation operation)	Process tags.
default org.eclipse.microprofile.openapi.models.parameters.RequestBody	AnnotationScanner.processRequestBody(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, ResourceParameters params)	Process the request body
default void	AnnotationScanner.processResponse(AnnotationScannerContext context, org.jboss.jandex.ClassInfo resourceClass, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation, Map<org.jboss.jandex.DotName,Map<String,org.eclipse.microprofile.openapi.models.responses.APIResponse>> exceptionResponseMap)
default void	AnnotationScanner.processScannerExtensions(AnnotationScannerContext context, Collection<org.jboss.jandex.ClassInfo> applications)	Scan for scanner extensions
default void	AnnotationScanner.processSecurityRequirementAnnotation(AnnotationScannerContext context, org.jboss.jandex.ClassInfo resourceClass, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation)	Get the security requirements on method and class and add them to the openapi model
default void	AnnotationScanner.processSecuritySchemeAnnotation(AnnotationScannerContext context, org.jboss.jandex.ClassInfo targetClass, org.eclipse.microprofile.openapi.models.OpenAPI openApi)	Process a certain class for security annotations.
default void	AnnotationScanner.processServerAnnotation(AnnotationScannerContext context, org.jboss.jandex.ClassInfo targetClass, org.eclipse.microprofile.openapi.models.OpenAPI openApi)	Process a certain class for server annotations.
default void	AnnotationScanner.processServerAnnotation(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation)	Process a certain method for server annotations.
default Set<String>	AnnotationScanner.processTags(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget target, org.eclipse.microprofile.openapi.models.OpenAPI openApi, boolean nullWhenMissing)	Processes any Tag or Tags annotations present on the annotation target and adds them to the OpenAPI model.
org.eclipse.microprofile.openapi.models.OpenAPI	AnnotationScanner.scan(AnnotationScannerContext annotationScannerContext, org.eclipse.microprofile.openapi.models.OpenAPI oai)
default void	AnnotationScanner.setJsonViewContext(AnnotationScannerContext context, org.jboss.jandex.Type[] views)
default void	AnnotationScanner.setRequestBodyConstraints(AnnotationScannerContext context, org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody, org.jboss.jandex.MethodInfo method, org.jboss.jandex.Type requestBodyType)

Constructors in io.smallrye.openapi.runtime.scanner.spi with parameters of type AnnotationScannerContext

Modifier	Constructor	Description
protected	AbstractParameterProcessor(AnnotationScannerContext scannerContext, String contextPath, Function<org.jboss.jandex.AnnotationInstance,org.eclipse.microprofile.openapi.models.parameters.Parameter> reader, List<AnnotationScannerExtension> extensions)

Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.util

Methods in io.smallrye.openapi.runtime.util with parameters of type AnnotationScannerContext

Modifier and Type	Method	Description
static boolean	TypeUtil.allowRegistration(AnnotationScannerContext context, org.jboss.jandex.Type classType)	Determines if a type is eligible for registration.
static List<org.jboss.jandex.FieldInfo>	JandexUtil.fields(AnnotationScannerContext context, org.jboss.jandex.ClassInfo currentClass)
static org.jboss.jandex.AnnotationInstance	TypeUtil.getSchemaAnnotation(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget annotationTarget)
static boolean	TypeUtil.isA(AnnotationScannerContext context, org.jboss.jandex.Type testSubject, org.jboss.jandex.Type testObject)	Test whether testSubject is an "instanceof" type testObject.
static boolean	TypeUtil.isAllOf(AnnotationScannerContext context, org.jboss.jandex.ClassInfo annotatedClass, org.jboss.jandex.Type type)
static boolean	JandexUtil.isArraySchema(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotation)	Returns true if the given @Schema annotation is an array schema.
static boolean	TypeUtil.isIncludedAllOf(AnnotationScannerContext context, org.jboss.jandex.ClassInfo annotatedClass, org.jboss.jandex.Type type)
static boolean	JandexUtil.isSimpleArraySchema(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotation)	Returns true if the given @Schema annotation is a simple array schema.
static boolean	TypeUtil.isTypeOverridden(AnnotationScannerContext context, org.jboss.jandex.Type classType, org.jboss.jandex.AnnotationInstance schemaAnnotation)	Check if the default schema type that applies to the provided classType differs from any value specified by the user via schemaAnnotation.
static void	TypeUtil.mapDeprecated(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget target, Supplier<Boolean> getDeprecated, Consumer<Boolean> setDeprecated)

Constructors in io.smallrye.openapi.runtime.util with parameters of type AnnotationScannerContext

Modifier	Constructor	Description
	Annotations(AnnotationScannerContext context)