Uses of Class
io.smallrye.openapi.runtime.scanner.spi.AnnotationScannerContext
Packages that use AnnotationScannerContext
Package
Description
-
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.io
Methods in io.smallrye.openapi.runtime.io that return AnnotationScannerContextMethods in io.smallrye.openapi.runtime.io with parameters of type AnnotationScannerContextModifier and TypeMethodDescriptionstatic IOContext<?, ?, ?, ?, ?> IOContext.forScanning(AnnotationScannerContext context) voidIOContext.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 AnnotationScannerContextModifier and TypeMethodDescriptionstatic org.eclipse.microprofile.openapi.models.media.SchemaSchemaFactory.enumToSchema(AnnotationScannerContext context, org.jboss.jandex.Type enumType) Convert a Jandex enum class type to aSchemamodel.static org.eclipse.microprofile.openapi.models.media.SchemaSchemaFactory.includeTypeSchema(AnnotationScannerContext context, org.eclipse.microprofile.openapi.models.media.Schema schema, org.jboss.jandex.Type type) static org.eclipse.microprofile.openapi.models.media.SchemaSchemaFactory.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.SchemaSchemaFactory.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@Schemaon the provided class.static org.eclipse.microprofile.openapi.models.media.SchemaSchemaFactory.readSchema(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance schemaAnnotation) Reads a Schema annotation into a model.static org.eclipse.microprofile.openapi.models.media.SchemaSchemaFactory.readSchema(AnnotationScannerContext context, org.jboss.jandex.AnnotationValue value) Reads a Schema annotation into a model.static org.eclipse.microprofile.openapi.models.media.SchemaSchemaFactory.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.SchemaSchemaFactory.typeToSchema(AnnotationScannerContext context, org.jboss.jandex.Type type) Converts a Jandex type to aSchemamodel.static org.eclipse.microprofile.openapi.models.media.SchemaSchemaFactory.typeToSchema(AnnotationScannerContext context, org.jboss.jandex.Type type, org.jboss.jandex.AnnotationInstance schemaAnnotation) Converts a Jandex type to aSchemamodel. -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.scanner
Methods in io.smallrye.openapi.runtime.scanner with parameters of type AnnotationScannerContextModifier and TypeMethodDescriptionstatic List<AnnotationScannerExtension> AnnotationScannerExtension.defaultExtension(AnnotationScannerContext scannerContext) Deprecated.static org.eclipse.microprofile.openapi.models.media.SchemaOpenApiDataObjectScanner.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 AnnotationScannerContextModifierConstructorDescriptionOpenApiAnnotationScanner(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 AnnotationScannerContextModifier and TypeMethodDescriptionstatic voidBeanValidationScanner.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 booleanIgnoreResolver.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.EnumProcessor.enumConstants(AnnotationScannerContext context, org.jboss.jandex.Type enumType) static TypeResolverTypeResolver.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.SchemaAnnotationTargetProcessor.process(AnnotationScannerContext context, DataObjectDeque objectStack, TypeResolver typeResolver, DataObjectDeque.PathEntry parentPathEntry) static org.eclipse.microprofile.openapi.models.media.SchemaAnnotationTargetProcessor.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 AnnotationScannerContextModifierConstructorDescriptionIgnoreResolver(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 -
Uses of AnnotationScannerContext in io.smallrye.openapi.runtime.scanner.spi
Fields in io.smallrye.openapi.runtime.scanner.spi declared as AnnotationScannerContextModifier and TypeFieldDescriptionprotected AnnotationScannerContextAbstractAnnotationScanner.contextprotected final AnnotationScannerContextAbstractParameterProcessor.scannerContextMethods in io.smallrye.openapi.runtime.scanner.spi with parameters of type AnnotationScannerContextModifier and TypeMethodDescriptiondefault voidAnnotationScanner.clearJsonViewContext(AnnotationScannerContext context) default voidAnnotationScanner.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.TypeAnnotationScanner.getKotlinContinuationArgument(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method) default org.jboss.jandex.TypeAnnotationScanner.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 indexdefault booleanAnnotationScanner.isEmptySecurityRequirements(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget target) Determines whether the target is annotated with an empty@SecurityRequirementsor@SecurityRequirementsSetsannotation.default booleanAnnotationScanner.isPathParameter(AnnotationScannerContext context, String name, ResourceParameters params) default booleanAnnotationScanner.isScannerInternalResponse(org.jboss.jandex.Type returnType, AnnotationScannerContext context, org.jboss.jandex.MethodInfo method) default org.eclipse.microprofile.openapi.models.media.SchemaAnnotationScanner.kotlinContinuationToSchema(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method) default voidAnnotationScanner.processCallback(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation) Process a callback annotationdefault org.eclipse.microprofile.openapi.models.OpenAPIAnnotationScanner.processDefinitionAnnotation(AnnotationScannerContext context, org.jboss.jandex.ClassInfo targetClass) Process a certain class for OpenApiDefinition annotations.default voidAnnotationScanner.processExtensions(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation) Process the Extensions annotationsdefault voidAnnotationScanner.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 operationsdefault voidAnnotationScanner.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.RequestBodyAnnotationScanner.processRequestBody(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, ResourceParameters params) Process the request bodydefault voidAnnotationScanner.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 voidAnnotationScanner.processScannerExtensions(AnnotationScannerContext context, Collection<org.jboss.jandex.ClassInfo> applications) Scan for scanner extensionsdefault voidAnnotationScanner.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 modeldefault voidAnnotationScanner.processSecuritySchemeAnnotation(AnnotationScannerContext context, org.jboss.jandex.ClassInfo targetClass, org.eclipse.microprofile.openapi.models.OpenAPI openApi) Process a certain class for security annotations.default voidAnnotationScanner.processServerAnnotation(AnnotationScannerContext context, org.jboss.jandex.ClassInfo targetClass, org.eclipse.microprofile.openapi.models.OpenAPI openApi) Process a certain class for server annotations.default voidAnnotationScanner.processServerAnnotation(AnnotationScannerContext context, org.jboss.jandex.MethodInfo method, org.eclipse.microprofile.openapi.models.Operation operation) Process a certain method for server annotations.AnnotationScanner.processTags(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget target, org.eclipse.microprofile.openapi.models.OpenAPI openApi, boolean nullWhenMissing) Processes anyTagorTagsannotations present on the annotation target and adds them to the OpenAPI model.org.eclipse.microprofile.openapi.models.OpenAPIAnnotationScanner.scan(AnnotationScannerContext annotationScannerContext, org.eclipse.microprofile.openapi.models.OpenAPI oai) default voidAnnotationScanner.setJsonViewContext(AnnotationScannerContext context, org.jboss.jandex.Type[] views) default voidAnnotationScanner.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 AnnotationScannerContextModifierConstructorDescriptionprotectedAbstractParameterProcessor(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 AnnotationScannerContextModifier and TypeMethodDescriptionstatic booleanTypeUtil.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.AnnotationInstanceTypeUtil.getSchemaAnnotation(AnnotationScannerContext context, org.jboss.jandex.AnnotationTarget annotationTarget) static booleanTypeUtil.isA(AnnotationScannerContext context, org.jboss.jandex.Type testSubject, org.jboss.jandex.Type testObject) Test whether testSubject is an "instanceof" type testObject.static booleanTypeUtil.isAllOf(AnnotationScannerContext context, org.jboss.jandex.ClassInfo annotatedClass, org.jboss.jandex.Type type) static booleanJandexUtil.isArraySchema(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotation) Returns true if the given@Schemaannotation is an array schema.static booleanTypeUtil.isIncludedAllOf(AnnotationScannerContext context, org.jboss.jandex.ClassInfo annotatedClass, org.jboss.jandex.Type type) static booleanJandexUtil.isSimpleArraySchema(AnnotationScannerContext context, org.jboss.jandex.AnnotationInstance annotation) Returns true if the given @Schema annotation is a simple array schema.static booleanTypeUtil.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 voidTypeUtil.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