io.smallrye.openapi.jaxrs

Class JaxRsAnnotationScanner

java.lang.Object

io.smallrye.openapi.jaxrs.JaxRsAnnotationScanner

All Implemented Interfaces:

AnnotationScanner

public class JaxRsAnnotationScanner
extends Object
implements AnnotationScanner

Scanner that scan Jax-Rs entry points. This is also the default, as it's part of the spec.

Author:

Eric Wittmann (eric.wittmann@gmail.com), Phillip Kruger (phillip.kruger@redhat.com)

Constructor Summary

Constructors

Constructor and Description
JaxRsAnnotationScanner()

Method Summary

Modifier and Type	Method and Description
boolean	containsScannerAnnotations(List<org.jboss.jandex.AnnotationInstance> instances, List<AnnotationScannerExtension> extensions)
String	getName()
String	getReasonPhrase(int statusCode)
boolean	isAsyncResponse(org.jboss.jandex.MethodInfo method)
boolean	isDeleteMethod(org.jboss.jandex.MethodInfo method)
boolean	isMultipartInput(org.jboss.jandex.Type inputType)
boolean	isMultipartOutput(org.jboss.jandex.Type returnType)
boolean	isPostMethod(org.jboss.jandex.MethodInfo method)
boolean	isScannerInternalResponse(org.jboss.jandex.Type returnType)
org.eclipse.microprofile.openapi.models.OpenAPI	scan(AnnotationScannerContext context, org.eclipse.microprofile.openapi.models.OpenAPI openApi)
void	setCurrentAppPath(String path)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.smallrye.openapi.runtime.scanner.spi.AnnotationScanner

addApiReponseFromAnnotation, addApiReponseSchemaFromAnnotation, createResponseFromRestMethod, generateResponse, getDefaultStatus, getRequestBodyParameterClassType, getResourceMethods, isVoidResponse, isWrapperType, processCallback, processDefinitionAnnotation, processExtensions, processJavaSecurity, processOperation, processOperationTags, processRequestBody, processResponse, processScannerExtensions, processSecurityRequirementAnnotation, processSecuritySchemeAnnotation, processServerAnnotation, processServerAnnotation, processTags, responseCodeExistInMethodAnnotations, setOperationOnPathItem, sortPaths, sortTags, unwrapType

Constructor Detail

JaxRsAnnotationScanner

public JaxRsAnnotationScanner()

Method Detail

getName

public String getName()

Specified by:

getName in interface AnnotationScanner

isAsyncResponse

public boolean isAsyncResponse(org.jboss.jandex.MethodInfo method)

Specified by:

isAsyncResponse in interface AnnotationScanner

isPostMethod

public boolean isPostMethod(org.jboss.jandex.MethodInfo method)

Specified by:

isPostMethod in interface AnnotationScanner

isDeleteMethod

public boolean isDeleteMethod(org.jboss.jandex.MethodInfo method)

Specified by:

isDeleteMethod in interface AnnotationScanner

isScannerInternalResponse

public boolean isScannerInternalResponse(org.jboss.jandex.Type returnType)

Specified by:

isScannerInternalResponse in interface AnnotationScanner

isMultipartOutput

public boolean isMultipartOutput(org.jboss.jandex.Type returnType)

Specified by:

isMultipartOutput in interface AnnotationScanner

isMultipartInput

public boolean isMultipartInput(org.jboss.jandex.Type inputType)

Specified by:

isMultipartInput in interface AnnotationScanner

getReasonPhrase

public String getReasonPhrase(int statusCode)

Specified by:

getReasonPhrase in interface AnnotationScanner

containsScannerAnnotations

public boolean containsScannerAnnotations(List<org.jboss.jandex.AnnotationInstance> instances,
                                          List<AnnotationScannerExtension> extensions)

Specified by:

containsScannerAnnotations in interface AnnotationScanner

scan

public org.eclipse.microprofile.openapi.models.OpenAPI scan(AnnotationScannerContext context,
                                                            org.eclipse.microprofile.openapi.models.OpenAPI openApi)

Specified by:

scan in interface AnnotationScanner

setCurrentAppPath

public void setCurrentAppPath(String path)

Specified by:

setCurrentAppPath in interface AnnotationScanner