fish.payara.microprofile.openapi.impl.processor

Class ApplicationProcessor

java.lang.Object

fish.payara.microprofile.openapi.impl.processor.ApplicationProcessor

All Implemented Interfaces:

OASProcessor, ApiVisitor

public class ApplicationProcessor
extends Object
implements OASProcessor, ApiVisitor

A processor to parse the application for annotations, to add to the OpenAPI model.

Nested Class Summary

Nested classes/interfaces inherited from interface fish.payara.microprofile.openapi.api.visitor.ApiVisitor

ApiVisitor.VisitorFunction<A extends Annotation,E extends AnnotatedElement>

Constructor Summary

Constructors

Constructor and Description
ApplicationProcessor(Set<Class<?>> appClasses)

Method Summary

Modifier and Type	Method and Description
org.eclipse.microprofile.openapi.models.OpenAPI	process(org.eclipse.microprofile.openapi.models.OpenAPI api, OpenApiConfiguration config) Processes a model.
void	visitAPIResponse(org.eclipse.microprofile.openapi.annotations.responses.APIResponse apiResponse, AnnotatedElement element, ApiContext context)
void	visitAPIResponses(org.eclipse.microprofile.openapi.annotations.responses.APIResponses apiResponses, AnnotatedElement element, ApiContext context)
void	visitCallback(org.eclipse.microprofile.openapi.annotations.callbacks.Callback callback, AnnotatedElement element, ApiContext context)
void	visitCallbacks(org.eclipse.microprofile.openapi.annotations.callbacks.Callbacks callbacks, AnnotatedElement element, ApiContext context)
void	visitConsumes(javax.ws.rs.Consumes consumes, AnnotatedElement element, ApiContext context)
void	visitCookieParam(javax.ws.rs.CookieParam param, AnnotatedElement element, ApiContext context)
void	visitDELETE(javax.ws.rs.DELETE delete, Method element, ApiContext context)
void	visitExtension(org.eclipse.microprofile.openapi.annotations.extensions.Extension extension, AnnotatedElement element, ApiContext context)
void	visitExtensions(org.eclipse.microprofile.openapi.annotations.extensions.Extensions extensions, AnnotatedElement element, ApiContext context)
void	visitExternalDocumentation(org.eclipse.microprofile.openapi.annotations.ExternalDocumentation externalDocs, AnnotatedElement element, ApiContext context)
void	visitFormParam(javax.ws.rs.FormParam param, AnnotatedElement element, ApiContext context)
void	visitGET(javax.ws.rs.GET get, Method element, ApiContext context)
void	visitHEAD(javax.ws.rs.HEAD head, Method element, ApiContext context)
void	visitHeaderParam(javax.ws.rs.HeaderParam param, AnnotatedElement element, ApiContext context)
void	visitOpenAPI(org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition definition, AnnotatedElement element, ApiContext context)
void	visitOperation(org.eclipse.microprofile.openapi.annotations.Operation operation, AnnotatedElement element, ApiContext context)
void	visitOPTIONS(javax.ws.rs.OPTIONS options, Method element, ApiContext context)
void	visitParameter(org.eclipse.microprofile.openapi.annotations.parameters.Parameter parameter, AnnotatedElement element, ApiContext context)
void	visitParameters(org.eclipse.microprofile.openapi.annotations.parameters.Parameters parameters, AnnotatedElement element, ApiContext context)
void	visitPATCH(javax.ws.rs.PATCH patch, Method element, ApiContext context)
void	visitPathParam(javax.ws.rs.PathParam param, AnnotatedElement element, ApiContext context)
void	visitPOST(javax.ws.rs.POST post, Method element, ApiContext context)
void	visitProduces(javax.ws.rs.Produces produces, AnnotatedElement element, ApiContext context)
void	visitPUT(javax.ws.rs.PUT put, Method element, ApiContext context)
void	visitQueryParam(javax.ws.rs.QueryParam param, AnnotatedElement element, ApiContext context)
void	visitRequestBody(org.eclipse.microprofile.openapi.annotations.parameters.RequestBody requestBody, AnnotatedElement element, ApiContext context)
void	visitSchema(org.eclipse.microprofile.openapi.annotations.media.Schema schema, AnnotatedElement element, ApiContext context)
void	visitSecurityRequirement(org.eclipse.microprofile.openapi.annotations.security.SecurityRequirement securityRequirement, AnnotatedElement element, ApiContext context)
void	visitSecurityRequirements(org.eclipse.microprofile.openapi.annotations.security.SecurityRequirements securityRequirements, AnnotatedElement element, ApiContext context)
void	visitSecurityScheme(org.eclipse.microprofile.openapi.annotations.security.SecurityScheme securityScheme, AnnotatedElement element, ApiContext context)
void	visitSecuritySchemes(org.eclipse.microprofile.openapi.annotations.security.SecuritySchemes securitySchemes, AnnotatedElement element, ApiContext context)
void	visitServer(org.eclipse.microprofile.openapi.annotations.servers.Server server, AnnotatedElement element, ApiContext context)
void	visitServers(org.eclipse.microprofile.openapi.annotations.servers.Servers servers, AnnotatedElement element, ApiContext context)
void	visitTag(org.eclipse.microprofile.openapi.annotations.tags.Tag tag, AnnotatedElement element, ApiContext context)
void	visitTags(org.eclipse.microprofile.openapi.annotations.tags.Tags tags, AnnotatedElement element, ApiContext context)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationProcessor

public ApplicationProcessor(Set<Class<?>> appClasses)

Parameters:

appClassLoader - the class loader for the application.

Method Detail

process

public org.eclipse.microprofile.openapi.models.OpenAPI process(org.eclipse.microprofile.openapi.models.OpenAPI api,
                                                               OpenApiConfiguration config)

Description copied from interface: OASProcessor

Processes a model.

Specified by:

process in interface OASProcessor

Parameters:

api - the OpenAPI model to process.

config - the configuration to use.

Returns:

a processed model.

visitGET

public void visitGET(javax.ws.rs.GET get,
                     Method element,
                     ApiContext context)

Specified by:

visitGET in interface ApiVisitor

visitPOST

public void visitPOST(javax.ws.rs.POST post,
                      Method element,
                      ApiContext context)

Specified by:

visitPOST in interface ApiVisitor

visitPUT

public void visitPUT(javax.ws.rs.PUT put,
                     Method element,
                     ApiContext context)

Specified by:

visitPUT in interface ApiVisitor

visitDELETE

public void visitDELETE(javax.ws.rs.DELETE delete,
                        Method element,
                        ApiContext context)

Specified by:

visitDELETE in interface ApiVisitor

visitHEAD

public void visitHEAD(javax.ws.rs.HEAD head,
                      Method element,
                      ApiContext context)

Specified by:

visitHEAD in interface ApiVisitor

visitOPTIONS

public void visitOPTIONS(javax.ws.rs.OPTIONS options,
                         Method element,
                         ApiContext context)

Specified by:

visitOPTIONS in interface ApiVisitor

visitPATCH

public void visitPATCH(javax.ws.rs.PATCH patch,
                       Method element,
                       ApiContext context)

Specified by:

visitPATCH in interface ApiVisitor

visitProduces

public void visitProduces(javax.ws.rs.Produces produces,
                          AnnotatedElement element,
                          ApiContext context)

Specified by:

visitProduces in interface ApiVisitor

visitConsumes

public void visitConsumes(javax.ws.rs.Consumes consumes,
                          AnnotatedElement element,
                          ApiContext context)

Specified by:

visitConsumes in interface ApiVisitor

visitQueryParam

public void visitQueryParam(javax.ws.rs.QueryParam param,
                            AnnotatedElement element,
                            ApiContext context)

Specified by:

visitQueryParam in interface ApiVisitor

visitPathParam

public void visitPathParam(javax.ws.rs.PathParam param,
                           AnnotatedElement element,
                           ApiContext context)

Specified by:

visitPathParam in interface ApiVisitor

visitFormParam

public void visitFormParam(javax.ws.rs.FormParam param,
                           AnnotatedElement element,
                           ApiContext context)

Specified by:

visitFormParam in interface ApiVisitor

visitHeaderParam

public void visitHeaderParam(javax.ws.rs.HeaderParam param,
                             AnnotatedElement element,
                             ApiContext context)

Specified by:

visitHeaderParam in interface ApiVisitor

visitCookieParam

public void visitCookieParam(javax.ws.rs.CookieParam param,
                             AnnotatedElement element,
                             ApiContext context)

Specified by:

visitCookieParam in interface ApiVisitor

visitOpenAPI

public void visitOpenAPI(org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition definition,
                         AnnotatedElement element,
                         ApiContext context)

Specified by:

visitOpenAPI in interface ApiVisitor

visitSchema

public void visitSchema(org.eclipse.microprofile.openapi.annotations.media.Schema schema,
                        AnnotatedElement element,
                        ApiContext context)

Specified by:

visitSchema in interface ApiVisitor

visitExtension

public void visitExtension(org.eclipse.microprofile.openapi.annotations.extensions.Extension extension,
                           AnnotatedElement element,
                           ApiContext context)

Specified by:

visitExtension in interface ApiVisitor

visitExtensions

public void visitExtensions(org.eclipse.microprofile.openapi.annotations.extensions.Extensions extensions,
                            AnnotatedElement element,
                            ApiContext context)

Specified by:

visitExtensions in interface ApiVisitor

visitOperation

public void visitOperation(org.eclipse.microprofile.openapi.annotations.Operation operation,
                           AnnotatedElement element,
                           ApiContext context)

Specified by:

visitOperation in interface ApiVisitor

visitCallback

public void visitCallback(org.eclipse.microprofile.openapi.annotations.callbacks.Callback callback,
                          AnnotatedElement element,
                          ApiContext context)

Specified by:

visitCallback in interface ApiVisitor

visitCallbacks

public void visitCallbacks(org.eclipse.microprofile.openapi.annotations.callbacks.Callbacks callbacks,
                           AnnotatedElement element,
                           ApiContext context)

Specified by:

visitCallbacks in interface ApiVisitor

visitRequestBody

public void visitRequestBody(org.eclipse.microprofile.openapi.annotations.parameters.RequestBody requestBody,
                             AnnotatedElement element,
                             ApiContext context)

Specified by:

visitRequestBody in interface ApiVisitor

visitAPIResponse

public void visitAPIResponse(org.eclipse.microprofile.openapi.annotations.responses.APIResponse apiResponse,
                             AnnotatedElement element,
                             ApiContext context)

Specified by:

visitAPIResponse in interface ApiVisitor

visitAPIResponses

public void visitAPIResponses(org.eclipse.microprofile.openapi.annotations.responses.APIResponses apiResponses,
                              AnnotatedElement element,
                              ApiContext context)

Specified by:

visitAPIResponses in interface ApiVisitor

visitParameters

public void visitParameters(org.eclipse.microprofile.openapi.annotations.parameters.Parameters parameters,
                            AnnotatedElement element,
                            ApiContext context)

Specified by:

visitParameters in interface ApiVisitor

visitParameter

public void visitParameter(org.eclipse.microprofile.openapi.annotations.parameters.Parameter parameter,
                           AnnotatedElement element,
                           ApiContext context)

Specified by:

visitParameter in interface ApiVisitor

visitExternalDocumentation

public void visitExternalDocumentation(org.eclipse.microprofile.openapi.annotations.ExternalDocumentation externalDocs,
                                       AnnotatedElement element,
                                       ApiContext context)

Specified by:

visitExternalDocumentation in interface ApiVisitor

visitServer

public void visitServer(org.eclipse.microprofile.openapi.annotations.servers.Server server,
                        AnnotatedElement element,
                        ApiContext context)

Specified by:

visitServer in interface ApiVisitor

visitServers

public void visitServers(org.eclipse.microprofile.openapi.annotations.servers.Servers servers,
                         AnnotatedElement element,
                         ApiContext context)

Specified by:

visitServers in interface ApiVisitor

visitTag

public void visitTag(org.eclipse.microprofile.openapi.annotations.tags.Tag tag,
                     AnnotatedElement element,
                     ApiContext context)

Specified by:

visitTag in interface ApiVisitor

visitTags

public void visitTags(org.eclipse.microprofile.openapi.annotations.tags.Tags tags,
                      AnnotatedElement element,
                      ApiContext context)

Specified by:

visitTags in interface ApiVisitor

visitSecurityScheme

public void visitSecurityScheme(org.eclipse.microprofile.openapi.annotations.security.SecurityScheme securityScheme,
                                AnnotatedElement element,
                                ApiContext context)

Specified by:

visitSecurityScheme in interface ApiVisitor

visitSecuritySchemes

public void visitSecuritySchemes(org.eclipse.microprofile.openapi.annotations.security.SecuritySchemes securitySchemes,
                                 AnnotatedElement element,
                                 ApiContext context)

Specified by:

visitSecuritySchemes in interface ApiVisitor

visitSecurityRequirement

public void visitSecurityRequirement(org.eclipse.microprofile.openapi.annotations.security.SecurityRequirement securityRequirement,
                                     AnnotatedElement element,
                                     ApiContext context)

Specified by:

visitSecurityRequirement in interface ApiVisitor

visitSecurityRequirements

public void visitSecurityRequirements(org.eclipse.microprofile.openapi.annotations.security.SecurityRequirements securityRequirements,
                                      AnnotatedElement element,
                                      ApiContext context)

Specified by:

visitSecurityRequirements in interface ApiVisitor