fish.payara.microprofile.openapi.activation

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 and Description
static String[]	OPENAPI_YAML_FILE_PATHS

Constructor Summary

Constructors

Constructor and Description
OpenApiSniffer()

Method Summary

Modifier and Type	Method and 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 sniffer
boolean	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

Methods inherited from class java.lang.Object

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

Field Detail

OPENAPI_YAML_FILE_PATHS

public static final String[] OPENAPI_YAML_FILE_PATHS

Constructor Detail

OpenApiSniffer

public OpenApiSniffer()

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 interface Sniffer

Overrides:

handles in class MicroProfileSniffer

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 class MicroProfileSniffer

getModuleType

public String getModuleType()

Description copied from interface: Sniffer

Returns the container type associated with this sniffer

Returns:

the container type