io.smallrye.openapi.runtime.scanner

Class SchemaRegistry

java.lang.Object

io.smallrye.openapi.runtime.scanner.SchemaRegistry

public class SchemaRegistry
extends Object

A simple registry used to track schemas that have been generated and inserted into the #/components section of the

Author:

eric.wittmann@gmail.com

Method Summary

Modifier and Type	Method and Description
static org.eclipse.microprofile.openapi.models.media.Schema	checkRegistration(org.jboss.jandex.Type type, TypeResolver resolver, org.eclipse.microprofile.openapi.models.media.Schema schema) Check if the entityType is eligible for registration using the typeResolver.
static SchemaRegistry	currentInstance() Retrieve the SchemaRegistry previously created by newInstance for the current thread, or null if none has yet been created.
boolean	hasRef(org.jboss.jandex.Type instanceType)
boolean	hasSchema(org.jboss.jandex.Type instanceType)
static boolean	hasSchema(org.jboss.jandex.Type type, TypeResolver resolver) Convenience method to check if the current thread's SchemaRegistry contains a schema for the given type (which may require type resolution using resolver).
boolean	isTypeRegistrationSupported(org.jboss.jandex.Type type, org.eclipse.microprofile.openapi.models.media.Schema schema)
org.eclipse.microprofile.openapi.models.media.Schema	lookupRef(org.jboss.jandex.Type instanceType)
org.eclipse.microprofile.openapi.models.media.Schema	lookupSchema(org.jboss.jandex.Type instanceType)
static SchemaRegistry	newInstance(AnnotationScannerContext context) Create a new instance of a SchemaRegistry on this thread.
org.eclipse.microprofile.openapi.models.media.Schema	register(org.jboss.jandex.Type entityType, org.eclipse.microprofile.openapi.models.media.Schema schema) Register the provided Schema for the provided Type.
static org.eclipse.microprofile.openapi.models.media.Schema	registerReference(org.jboss.jandex.Type type, TypeResolver resolver, org.eclipse.microprofile.openapi.models.media.Schema schema) Attempt to register ONLY a reference to entityType using the typeResolver.
static void	remove()

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static SchemaRegistry newInstance(AnnotationScannerContext context)

Create a new instance of a SchemaRegistry on this thread. The registry returned by this method may also be obtained by subsequent calls to currentInstance(). Additional calls of this method will replace the registry in the current thread context with a new instance.

Parameters:

context - current scanner context

Returns:

the registry

currentInstance

public static SchemaRegistry currentInstance()

Retrieve the SchemaRegistry previously created by newInstance for the current thread, or null if none has yet been created.

Returns:

a SchemaRegistry instance or null

remove

public static void remove()

checkRegistration

public static org.eclipse.microprofile.openapi.models.media.Schema checkRegistration(org.jboss.jandex.Type type,
                                                                                     TypeResolver resolver,
                                                                                     org.eclipse.microprofile.openapi.models.media.Schema schema)

Check if the entityType is eligible for registration using the typeResolver. The eligible kinds of types are

• CLASS
• PARAMETERIZED_TYPE
• TYPE_VARIABLE
• WILDCARD_TYPE

If eligible, schema references are enabled by MP Config property mp.openapi.extensions.smallrye.schema-references.enable, and the resolved type is available in the registry's IndexView then the schema can be registered. Only if the type has not already been registered earlier will it be added.

Parameters:

type - the Type the Schema applies to

resolver - a TypeResolver that will be used to resolve parameterized and wildcard types

schema - Schema to add to the registry

Returns:

the same schema if not eligible for registration, or a reference to the schema registered for the given Type

registerReference

public static org.eclipse.microprofile.openapi.models.media.Schema registerReference(org.jboss.jandex.Type type,
                                                                                     TypeResolver resolver,
                                                                                     org.eclipse.microprofile.openapi.models.media.Schema schema)

Attempt to register ONLY a reference to entityType using the typeResolver. The eligible kinds of types are

• CLASS
• PARAMETERIZED_TYPE
• TYPE_VARIABLE
• WILDCARD_TYPE

If eligible, schema references are enabled by MP Config property mp.openapi.extensions.smallrye.schema-references.enable, and the resolved type is available in the registry's IndexView then the schema reference can be registered. Only if the type has not already been registered earlier will it be added.

Parameters:

type - the Type the Schema applies to

resolver - a TypeResolver that will be used to resolve parameterized and wildcard types

schema - Schema to add to the registry

Returns:

the same schema if not eligible for registration, or a reference to the schema registered for the given Type

hasSchema

public static boolean hasSchema(org.jboss.jandex.Type type,
                                TypeResolver resolver)

Convenience method to check if the current thread's SchemaRegistry contains a schema for the given type (which may require type resolution using resolver).

Parameters:

type - type to check for existence of schema

resolver - resolver for type parameter

Returns:

true when schema references are enabled and the type is present in the registry, otherwise false

register

public org.eclipse.microprofile.openapi.models.media.Schema register(org.jboss.jandex.Type entityType,
                                                                     org.eclipse.microprofile.openapi.models.media.Schema schema)

Register the provided Schema for the provided Type. If an existing schema has already been registered for the type, it will be replaced by the schema given in this method.

Parameters:

entityType - the type the Schema applies to

schema - Schema to add to the registry

Returns:

a reference to the newly registered Schema

lookupRef

public org.eclipse.microprofile.openapi.models.media.Schema lookupRef(org.jboss.jandex.Type instanceType)

hasRef

public boolean hasRef(org.jboss.jandex.Type instanceType)

lookupSchema

public org.eclipse.microprofile.openapi.models.media.Schema lookupSchema(org.jboss.jandex.Type instanceType)

hasSchema

public boolean hasSchema(org.jboss.jandex.Type instanceType)

isTypeRegistrationSupported

public boolean isTypeRegistrationSupported(org.jboss.jandex.Type type,
                                           org.eclipse.microprofile.openapi.models.media.Schema schema)