Package io.smallrye.openapi.jaxrs

Class JaxRsParameterProcessor

java.lang.Object

io.smallrye.openapi.runtime.scanner.spi.AbstractParameterProcessor

io.smallrye.openapi.jaxrs.JaxRsParameterProcessor

public class JaxRsParameterProcessor
extends AbstractParameterProcessor

Note, javax.ws.rs.PathParam PathParam targets of javax.ws.rs.core.PathSegment PathSegment are not currently supported.

Author:

Michael Edgar <michael@xlate.io>

Nested Class Summary

Nested classes/interfaces inherited from class io.smallrye.openapi.runtime.scanner.spi.AbstractParameterProcessor

AbstractParameterProcessor.ParameterContext, AbstractParameterProcessor.ParameterContextKey

Field Summary

Fields inherited from class io.smallrye.openapi.runtime.scanner.spi.AbstractParameterProcessor

APPLICATION_FORM_URLENCODED, beanValidationScanner, contextPath, extensions, formMediaType, formParams, index, matrixParams, params, readerFunction, scannerContext

Method Summary

Modifier and Type	Method	Description
protected void	addEncoding(Map<String,org.eclipse.microprofile.openapi.models.media.Encoding> encodings, String paramName, org.jboss.jandex.AnnotationTarget paramTarget)
protected Set<org.jboss.jandex.DotName>	getDefaultAnnotationNames()
protected String	getDefaultAnnotationProperty()
protected String	getDefaultFormMediaType()
protected FrameworkParameter	getMatrixParameter()
protected Pattern	getTemplateParameterPattern()
protected AbstractParameterProcessor.ParameterContext	getUnannotatedPathParameter(org.jboss.jandex.MethodInfo resourceMethod, String name)
protected boolean	isParameter(org.jboss.jandex.DotName annotationName)
protected boolean	isResourceMethod(org.jboss.jandex.MethodInfo method)
protected boolean	isSubResourceLocator(org.jboss.jandex.MethodInfo method)
protected String	pathOf(org.jboss.jandex.AnnotationTarget target)
static ResourceParameters	process(AnnotationScannerContext context, String contextPath, org.jboss.jandex.ClassInfo resourceClass, org.jboss.jandex.MethodInfo resourceMethod, Function<org.jboss.jandex.AnnotationInstance,org.eclipse.microprofile.openapi.models.parameters.Parameter> reader, List<AnnotationScannerExtension> extensions)	Process parameter annotations for the given class and method.This method operates in two phases.
protected void	processPathParameters(org.jboss.jandex.ClassInfo resourceClass, org.jboss.jandex.MethodInfo resourceMethod, ResourceParameters parameters)
protected void	readAnnotatedType(org.jboss.jandex.AnnotationInstance annotation, org.jboss.jandex.AnnotationInstance beanParamAnnotation, boolean overriddenParametersOnly)

Methods inherited from class io.smallrye.openapi.runtime.scanner.spi.AbstractParameterProcessor

fullPathOf, generatePath, getDefaultValue, getFormBodyContent, getParameters, getType, hasParameters, isIgnoredParameter, isReadableParameterAnnotation, lastPathSegmentOf, paramName, primitiveToObject, process, processFinalize, processOperationParameters, readAnnotatedType, readFrameworkParameter, readParameter, readParameterAnnotation, readParameterAnnotation, readParameters, readParametersInherited, reset, resolveType, setMediaType, setSchemaProperties, styleOf

Methods inherited from class java.lang.Object

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

Method Detail

process

public static ResourceParameters process(AnnotationScannerContext context,
                                         String contextPath,
                                         org.jboss.jandex.ClassInfo resourceClass,
                                         org.jboss.jandex.MethodInfo resourceMethod,
                                         Function<org.jboss.jandex.AnnotationInstance,org.eclipse.microprofile.openapi.models.parameters.Parameter> reader,
                                         List<AnnotationScannerExtension> extensions)

Process parameter annotations for the given class and method.This method operates in two phases. First, class-level parameters are processed and saved in the ResourceParameters. Second, method-level parameters are processed. Form parameters are only applicable to the method-level in this component.

Parameters:

context - the AnnotationScannerContext

contextPath - context path for the resource class and method

resourceClass - the class info

resourceMethod - the JAX-RS resource method, annotated with one of the JAX-RS HTTP annotations

reader - callback method for a function producing Parameter from a Parameter

extensions - scanner extensions

Returns:

scanned parameters and modified path contained in a ResourceParameters object

processPathParameters

protected void processPathParameters(org.jboss.jandex.ClassInfo resourceClass,
                                     org.jboss.jandex.MethodInfo resourceMethod,
                                     ResourceParameters parameters)

Overrides:

processPathParameters in class AbstractParameterProcessor

getTemplateParameterPattern

protected Pattern getTemplateParameterPattern()

Specified by:

getTemplateParameterPattern in class AbstractParameterProcessor

getMatrixParameter

protected FrameworkParameter getMatrixParameter()

Specified by:

getMatrixParameter in class AbstractParameterProcessor

getUnannotatedPathParameter

protected AbstractParameterProcessor.ParameterContext getUnannotatedPathParameter(org.jboss.jandex.MethodInfo resourceMethod,
                                                                                  String name)

Overrides:

getUnannotatedPathParameter in class AbstractParameterProcessor

getDefaultFormMediaType

protected String getDefaultFormMediaType()

Overrides:

getDefaultFormMediaType in class AbstractParameterProcessor

addEncoding

protected void addEncoding(Map<String,org.eclipse.microprofile.openapi.models.media.Encoding> encodings,
                           String paramName,
                           org.jboss.jandex.AnnotationTarget paramTarget)

Overrides:

addEncoding in class AbstractParameterProcessor

readAnnotatedType

protected void readAnnotatedType(org.jboss.jandex.AnnotationInstance annotation,
                                 org.jboss.jandex.AnnotationInstance beanParamAnnotation,
                                 boolean overriddenParametersOnly)

Specified by:

readAnnotatedType in class AbstractParameterProcessor

getDefaultAnnotationNames

protected Set<org.jboss.jandex.DotName> getDefaultAnnotationNames()

Overrides:

getDefaultAnnotationNames in class AbstractParameterProcessor

getDefaultAnnotationProperty

protected String getDefaultAnnotationProperty()

Overrides:

getDefaultAnnotationProperty in class AbstractParameterProcessor

pathOf

protected String pathOf(org.jboss.jandex.AnnotationTarget target)

Specified by:

pathOf in class AbstractParameterProcessor

isSubResourceLocator

protected boolean isSubResourceLocator(org.jboss.jandex.MethodInfo method)

Specified by:

isSubResourceLocator in class AbstractParameterProcessor

isResourceMethod

protected boolean isResourceMethod(org.jboss.jandex.MethodInfo method)

Specified by:

isResourceMethod in class AbstractParameterProcessor

isParameter

protected boolean isParameter(org.jboss.jandex.DotName annotationName)

Specified by:

isParameter in class AbstractParameterProcessor