Class OpenApiSniffer
- java.lang.Object
-
- fish.payara.microprofile.connector.MicroProfileSniffer
-
- fish.payara.microprofile.openapi.activation.OpenApiSniffer
-
- All Implemented Interfaces:
Sniffer
@Service @PerLookup public class OpenApiSniffer extends MicroProfileSniffer
-
-
Field Summary
Fields Modifier and Type Field Description static String[]
OPENAPI_YAML_FILE_PATHS
-
Constructor Summary
Constructors Constructor Description OpenApiSniffer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class<? extends Annotation>[]
getAnnotationTypes()
Returns the list of annotations types that this sniffer is interested in.protected Class<?>
getContainersClass()
String
getModuleType()
Returns the container type associated with this snifferboolean
handles(ReadableArchive archive)
Returns true if the passed file or directory is recognized by this sniffer.-
Methods inherited from class fish.payara.microprofile.connector.MicroProfileSniffer
getAnnotationNames, getContainersNames, getDeploymentConfigurations, getIncompatibleSnifferTypes, getURLPatterns, handles, isJavaEE, isUserVisible, setup, supportsArchiveType, tearDown
-
-
-
-
Field Detail
-
OPENAPI_YAML_FILE_PATHS
public static final String[] OPENAPI_YAML_FILE_PATHS
-
-
Method Detail
-
getAnnotationTypes
public Class<? extends Annotation>[] getAnnotationTypes()
Description copied from interface:Sniffer
Returns the list of annotations types that this sniffer is interested in. If an application bundle contains at least one class annotated with one of the returned annotations, the deployment process will not call the handles method but will invoke the containers deployers as if the handles method had been called and returned true.- Returns:
- list of annotations this sniffer is interested in or an empty array
-
handles
public boolean handles(ReadableArchive archive)
Description copied from interface:Sniffer
Returns true if the passed file or directory is recognized by this sniffer.- Specified by:
handles
in interfaceSniffer
- Overrides:
handles
in classMicroProfileSniffer
- Parameters:
archive
- the file or directory abstracted as an archive resources from the source archive.- Returns:
- true if the location is recognized by this sniffer
-
getContainersClass
protected Class<?> getContainersClass()
- Specified by:
getContainersClass
in classMicroProfileSniffer
-
-