fish.payara.microprofile.config.activation

Class ConfigSniffer

java.lang.Object

fish.payara.microprofile.connector.MicroProfileSniffer

fish.payara.microprofile.config.activation.ConfigSniffer

All Implemented Interfaces:

Sniffer

@Service
 @PerLookup
public class ConfigSniffer
extends MicroProfileSniffer

Constructor Summary

Constructors

Constructor and Description
ConfigSniffer()

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[]	getIncompatibleSnifferTypes()
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.
boolean	isUserVisible()

Methods inherited from class fish.payara.microprofile.connector.MicroProfileSniffer

getAnnotationNames, getContainersNames, getDeploymentConfigurations, getURLPatterns, handles, isJavaEE, setup, supportsArchiveType, tearDown

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigSniffer

public ConfigSniffer()

Method Detail

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

getIncompatibleSnifferTypes

public String[] getIncompatibleSnifferTypes()

Specified by:

getIncompatibleSnifferTypes in interface Sniffer

Overrides:

getIncompatibleSnifferTypes in class MicroProfileSniffer

Returns:

the set of the sniffers that should not co-exist for the same module. For example, ejb and appclient sniffers should not be returned in the sniffer list for a certain module. This method will be used to validate and filter the retrieved sniffer lists for a certain module

isUserVisible

public boolean isUserVisible()

Specified by:

isUserVisible in interface Sniffer

Overrides:

isUserVisible in class MicroProfileSniffer

Returns:

whether this sniffer should be visible to user

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

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