io.smallrye.openapi.runtime.scanner

Interface AnnotationScannerExtension

All Known Implementing Classes:

DefaultAnnotationScannerExtension

public interface AnnotationScannerExtension

Extension point for supporting extensions to JAX-RS. Implement this directly or extend DefaultAnnotationScannerExtension.

See Also:

DefaultAnnotationScannerExtension

Method Summary

Modifier and Type	Method and Description
JandexUtil.JaxRsParameterInfo	getMethodParameterJaxRsInfo(org.jboss.jandex.MethodInfo method, int idx) Deprecated.
boolean	isJaxRsAnnotationExtension(org.jboss.jandex.AnnotationInstance instance) Returns true if the given annotation is a jax-rs annotation extension, such as would be in the javax.ws.rs package.
org.eclipse.microprofile.openapi.models.parameters.Parameter.In	parameterIn(org.jboss.jandex.MethodParameterInfo paramInfo) Deprecated.
void	processJaxRsApplications(OpenApiAnnotationScanner scanner, Collection<org.jboss.jandex.ClassInfo> applications) Gives a chance to extensions to process the set of jax-rs application classes.
org.jboss.jandex.Type	resolveAsyncType(org.jboss.jandex.Type type) Unwraps an asynchronous type such as CompletionStage<X> into its resolved type X

Method Detail

parameterIn

@Deprecated
org.eclipse.microprofile.openapi.models.parameters.Parameter.In parameterIn(org.jboss.jandex.MethodParameterInfo paramInfo)

Deprecated.

Determines where an @Parameter can be found (examples include Query, Path, Header, Cookie, etc).

Parameters:

paramInfo -

Returns:

the parameter location, or null if unknown

getMethodParameterJaxRsInfo

@Deprecated
JandexUtil.JaxRsParameterInfo getMethodParameterJaxRsInfo(org.jboss.jandex.MethodInfo method,
                                                                      int idx)

Deprecated.

Returns jax-rs info about the parameter at the given index. If the index is invalid or does not refer to a jax-rs parameter then this should return null. Otherwise it will return a JandexUtil.JaxRsParameterInfo object with the name and type of the param.

Parameters:

method - MethodInfo

idx - index of parameter

Returns:

JaxRsParameterInfo or null if unknown.

resolveAsyncType

org.jboss.jandex.Type resolveAsyncType(org.jboss.jandex.Type type)

Unwraps an asynchronous type such as CompletionStage<X> into its resolved type X

Parameters:

type - the type to unwrap if it is a supported async type

Returns:

the resolved type or null if not supported

processJaxRsApplications

void processJaxRsApplications(OpenApiAnnotationScanner scanner,
                              Collection<org.jboss.jandex.ClassInfo> applications)

Gives a chance to extensions to process the set of jax-rs application classes.

Parameters:

scanner - the scanner used for application scanning

applications - the set of jax-rs application classes

isJaxRsAnnotationExtension

boolean isJaxRsAnnotationExtension(org.jboss.jandex.AnnotationInstance instance)

Returns true if the given annotation is a jax-rs annotation extension, such as would be in the javax.ws.rs package.

Parameters:

instance - the annotation to check

Returns:

true if the given annotation is a jax-rs annotation extension