Package io.quarkus.smallrye.openapi.deployment

Class SmallRyeOpenApiProcessor

java.lang.Object

io.quarkus.smallrye.openapi.deployment.SmallRyeOpenApiProcessor

public class SmallRyeOpenApiProcessor
extends Object

The main OpenAPI Processor. This will scan for JAX-RS, Spring and Vert.x Annotations, and, if any, add supplied schemas. The result is added to the deployable unit to be loaded at runtime.

Constructor Summary

Constructors

Constructor	Description
SmallRyeOpenApiProcessor()

Method Summary

Modifier and Type	Method	Description
(package private) void	addAutoFilters(BuildProducer<AddToOpenAPIDefinitionBuildItem> addToOpenAPIDefinitionProducer, List<SecurityInformationBuildItem> securityInformationBuildItems, OpenApiFilteredIndexViewBuildItem apiFilteredIndexViewBuildItem, SmallRyeOpenApiConfig config, LaunchModeBuildItem launchModeBuildItem, io.quarkus.vertx.http.runtime.management.ManagementInterfaceBuildTimeConfig managementInterfaceBuildTimeConfig)
(package private) void	additionalBean(BuildProducer<AdditionalBeanBuildItem> additionalBeanProducer)
(package private) void	addMethodImplementationClassNames(org.jboss.jandex.MethodInfo method, org.jboss.jandex.Type[] params, Collection<org.jboss.jandex.ClassInfo> classes, Map<String,ClassAndMethod> classNames)
(package private) static boolean	autoSecurityRuntimeEnabled(AutoSecurityFilter autoSecurityFilter, Supplier<Boolean> autoRolesAllowedFilterSource)
void	build(BuildProducer<FeatureBuildItem> feature, BuildProducer<GeneratedResourceBuildItem> resourceBuildItemBuildProducer, BuildProducer<NativeImageResourceBuildItem> nativeImageResources, BuildProducer<OpenApiDocumentBuildItem> openApiDocumentProducer, OpenApiFilteredIndexViewBuildItem openApiFilteredIndexViewBuildItem, Capabilities capabilities, List<AddToOpenAPIDefinitionBuildItem> openAPIBuildItems, HttpRootPathBuildItem httpRootPathBuildItem, SmallRyeOpenApiConfig smallRyeOpenApiConfig, OutputTargetBuildItem outputTargetBuildItem, List<IgnoreStaticDocumentBuildItem> ignoreStaticDocumentBuildItems)
(package private) void	configFiles(BuildProducer<HotDeploymentWatchedFileBuildItem> watchedFiles, SmallRyeOpenApiConfig openApiConfig, LaunchModeBuildItem launchMode, OutputTargetBuildItem outputTargetBuildItem)
(package private) void	contributeClassesToIndex(BuildProducer<AdditionalIndexedClassesBuildItem> additionalIndexedClasses)
static String	createUniqueMethodReference(org.jboss.jandex.ClassInfo classInfo, org.jboss.jandex.MethodInfo methodInfo)
(package private) void	handler(LaunchModeBuildItem launch, BuildProducer<NotFoundPageDisplayableEndpointBuildItem> displayableEndpoints, BuildProducer<io.quarkus.vertx.http.deployment.spi.RouteBuildItem> routes, BuildProducer<SystemPropertyBuildItem> systemProperties, OpenApiRecorder recorder, NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem, OpenApiRuntimeConfig openApiRuntimeConfig, ShutdownContextBuildItem shutdownContext, SmallRyeOpenApiConfig openApiConfig, List<FilterBuildItem> filterBuildItems, io.quarkus.vertx.http.runtime.management.ManagementInterfaceBuildTimeConfig managementInterfaceBuildTimeConfig)
(package private) LogCleanupFilterBuildItem	logCleanup()
(package private) void	registerAnnotatedUserDefinedRuntimeFilters(BuildProducer<SyntheticBeanBuildItem> syntheticBeans, BuildProducer<ReflectiveClassBuildItem> reflectiveClass, OpenApiFilteredIndexViewBuildItem apiFilteredIndexViewBuildItem, OpenApiRecorder recorder)
(package private) void	registerAutoSecurityFilter(BuildProducer<SyntheticBeanBuildItem> syntheticBeans, SmallRyeOpenApiConfig openApiConfig, OpenApiFilteredIndexViewBuildItem apiFilteredIndexViewBuildItem, List<SecurityInformationBuildItem> securityInformationBuildItems, OpenApiRecorder recorder)
List<AllowedJaxRsAnnotationPrefixBuildItem>	registerJaxRsSupportedAnnotation()
(package private) void	registerNativeImageResources(BuildProducer<ServiceProviderBuildItem> serviceProvider)
void	registerOpenApiSchemaClassesForReflection(BuildProducer<ReflectiveClassBuildItem> reflectiveClass, BuildProducer<ReflectiveHierarchyBuildItem> reflectiveHierarchy, OpenApiFilteredIndexViewBuildItem openApiFilteredIndexViewBuildItem, Capabilities capabilities)
(package private) OpenApiFilteredIndexViewBuildItem	smallryeOpenApiIndex(CombinedIndexBuildItem combinedIndexBuildItem, BeanArchiveIndexBuildItem beanArchiveIndexBuildItem, BuildExclusionsBuildItem buildExclusionsBuildItem)
(package private) io.smallrye.openapi.api.OpenApiDocument	toOpenApiDocument(io.smallrye.openapi.api.SmallRyeOpenAPI finalOpenAPI)	We need to use the deprecated OpenApiDocument as long as OpenApiDocumentBuildItem needs to be produced.

Methods inherited from class java.lang.Object

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

Constructor Details

SmallRyeOpenApiProcessor

public SmallRyeOpenApiProcessor()

Method Details

contributeClassesToIndex

void contributeClassesToIndex(BuildProducer<AdditionalIndexedClassesBuildItem> additionalIndexedClasses)

registerNativeImageResources

void registerNativeImageResources(BuildProducer<ServiceProviderBuildItem> serviceProvider)

configFiles

void configFiles(BuildProducer<HotDeploymentWatchedFileBuildItem> watchedFiles,
 SmallRyeOpenApiConfig openApiConfig,
 LaunchModeBuildItem launchMode,
 OutputTargetBuildItem outputTargetBuildItem)

registerAutoSecurityFilter

void registerAutoSecurityFilter(BuildProducer<SyntheticBeanBuildItem> syntheticBeans,
 SmallRyeOpenApiConfig openApiConfig,
 OpenApiFilteredIndexViewBuildItem apiFilteredIndexViewBuildItem,
 List<SecurityInformationBuildItem> securityInformationBuildItems,
 OpenApiRecorder recorder)

autoSecurityRuntimeEnabled

static boolean autoSecurityRuntimeEnabled(AutoSecurityFilter autoSecurityFilter,
 Supplier<Boolean> autoRolesAllowedFilterSource)

registerAnnotatedUserDefinedRuntimeFilters

void registerAnnotatedUserDefinedRuntimeFilters(BuildProducer<SyntheticBeanBuildItem> syntheticBeans,
 BuildProducer<ReflectiveClassBuildItem> reflectiveClass,
 OpenApiFilteredIndexViewBuildItem apiFilteredIndexViewBuildItem,
 OpenApiRecorder recorder)

handler

void handler(LaunchModeBuildItem launch,
 BuildProducer<NotFoundPageDisplayableEndpointBuildItem> displayableEndpoints,
 BuildProducer<io.quarkus.vertx.http.deployment.spi.RouteBuildItem> routes,
 BuildProducer<SystemPropertyBuildItem> systemProperties,
 OpenApiRecorder recorder,
 NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem,
 OpenApiRuntimeConfig openApiRuntimeConfig,
 ShutdownContextBuildItem shutdownContext,
 SmallRyeOpenApiConfig openApiConfig,
 List<FilterBuildItem> filterBuildItems,
 io.quarkus.vertx.http.runtime.management.ManagementInterfaceBuildTimeConfig managementInterfaceBuildTimeConfig)

additionalBean

void additionalBean(BuildProducer<AdditionalBeanBuildItem> additionalBeanProducer)

smallryeOpenApiIndex

OpenApiFilteredIndexViewBuildItem smallryeOpenApiIndex(CombinedIndexBuildItem combinedIndexBuildItem,
 BeanArchiveIndexBuildItem beanArchiveIndexBuildItem,
 BuildExclusionsBuildItem buildExclusionsBuildItem)

addAutoFilters

void addAutoFilters(BuildProducer<AddToOpenAPIDefinitionBuildItem> addToOpenAPIDefinitionProducer,
 List<SecurityInformationBuildItem> securityInformationBuildItems,
 OpenApiFilteredIndexViewBuildItem apiFilteredIndexViewBuildItem,
 SmallRyeOpenApiConfig config,
 LaunchModeBuildItem launchModeBuildItem,
 io.quarkus.vertx.http.runtime.management.ManagementInterfaceBuildTimeConfig managementInterfaceBuildTimeConfig)

addMethodImplementationClassNames

void addMethodImplementationClassNames(org.jboss.jandex.MethodInfo method,
 org.jboss.jandex.Type[] params,
 Collection<org.jboss.jandex.ClassInfo> classes,
 Map<String,ClassAndMethod> classNames)

createUniqueMethodReference

public static String createUniqueMethodReference(org.jboss.jandex.ClassInfo classInfo,
 org.jboss.jandex.MethodInfo methodInfo)

registerJaxRsSupportedAnnotation

public List<AllowedJaxRsAnnotationPrefixBuildItem> registerJaxRsSupportedAnnotation()

registerOpenApiSchemaClassesForReflection

public void registerOpenApiSchemaClassesForReflection(BuildProducer<ReflectiveClassBuildItem> reflectiveClass,
 BuildProducer<ReflectiveHierarchyBuildItem> reflectiveHierarchy,
 OpenApiFilteredIndexViewBuildItem openApiFilteredIndexViewBuildItem,
 Capabilities capabilities)

build

public void build(BuildProducer<FeatureBuildItem> feature,
 BuildProducer<GeneratedResourceBuildItem> resourceBuildItemBuildProducer,
 BuildProducer<NativeImageResourceBuildItem> nativeImageResources,
 BuildProducer<OpenApiDocumentBuildItem> openApiDocumentProducer,
 OpenApiFilteredIndexViewBuildItem openApiFilteredIndexViewBuildItem,
 Capabilities capabilities,
 List<AddToOpenAPIDefinitionBuildItem> openAPIBuildItems,
 HttpRootPathBuildItem httpRootPathBuildItem,
 SmallRyeOpenApiConfig smallRyeOpenApiConfig,
 OutputTargetBuildItem outputTargetBuildItem,
 List<IgnoreStaticDocumentBuildItem> ignoreStaticDocumentBuildItems)

toOpenApiDocument

io.smallrye.openapi.api.OpenApiDocument toOpenApiDocument(io.smallrye.openapi.api.SmallRyeOpenAPI finalOpenAPI)

We need to use the deprecated OpenApiDocument as long as OpenApiDocumentBuildItem needs to be produced.

logCleanup

LogCleanupFilterBuildItem logCleanup()