org.glassfish.appclient.server.connector

Class AppClientSniffer

java.lang.Object

org.glassfish.internal.deployment.GenericSniffer

org.glassfish.appclient.server.connector.AppClientSniffer

All Implemented Interfaces:

Sniffer

@Service(name="AppClient")
 @Singleton
public class AppClientSniffer
extends GenericSniffer

Field Summary

Fields inherited from class org.glassfish.internal.deployment.GenericSniffer

habitat, modulesRegistry

Constructor Summary

Constructors

Constructor and Description
AppClientSniffer()
AppClientSniffer(String containerName, String appStigma, String urlPattern)

Method Summary

Modifier and Type	Method and Description
String[]	getContainersNames() Returns the list of Containers that this Sniffer enables.
protected List<String>	getDeploymentConfigurationPaths() Returns the descriptor paths that might exist in an appclient app.
String[]	getIncompatibleSnifferTypes()
boolean	handles(ReadableArchive location) Returns true if the passed file or directory is recognized by this instance.
boolean	isJavaEE()
boolean	isUserVisible()
boolean	supportsArchiveType(ArchiveType archiveType) This API is used to help determine if the sniffer should recognize the current archive.

Methods inherited from class org.glassfish.internal.deployment.GenericSniffer

equals, getAnnotationNames, getAnnotationTypes, getContainerModuleNames, getDeploymentConfigurations, getModuleType, getURLPatterns, handles, hashCode, setup, tearDown

Methods inherited from class java.lang.Object

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

Constructor Detail

AppClientSniffer

public AppClientSniffer()

AppClientSniffer

public AppClientSniffer(String containerName,
                        String appStigma,
                        String urlPattern)

Method Detail

getContainersNames

public String[] getContainersNames()

Description copied from interface: Sniffer

Returns the list of Containers that this Sniffer enables. The runtime will look up each container implementing using the names provided in the habitat.

Returns:

list of container names known to the habitat for this sniffer

handles

public boolean handles(ReadableArchive location)

Returns true if the passed file or directory is recognized by this instance.

Specified by:

handles in interface Sniffer

Overrides:

handles in class GenericSniffer

Parameters:

location - the file or directory to explore

Returns:

true if this sniffer handles this application type

isUserVisible

public boolean isUserVisible()

Specified by:

isUserVisible in interface Sniffer

Overrides:

isUserVisible in class GenericSniffer

Returns:

whether this sniffer should be visible to user

isJavaEE

public boolean isJavaEE()

Specified by:

isJavaEE in interface Sniffer

Overrides:

isJavaEE in class GenericSniffer

Returns:

whether this sniffer represents a Java EE container type

getIncompatibleSnifferTypes

public String[] getIncompatibleSnifferTypes()

Specified by:

getIncompatibleSnifferTypes in interface Sniffer

Overrides:

getIncompatibleSnifferTypes in class GenericSniffer

Returns:

the set of the sniffers that should not co-exist for the same module. For example, ejb and connector 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

supportsArchiveType

public boolean supportsArchiveType(ArchiveType archiveType)

This API is used to help determine if the sniffer should recognize the current archive. If the sniffer does not support the archive type associated with the current deployment, the sniffer should not recognize the archive.

Parameters:

archiveType - the archive type to check

Returns:

whether the sniffer supports the archive type

getDeploymentConfigurationPaths

protected List<String> getDeploymentConfigurationPaths()

Returns the descriptor paths that might exist in an appclient app.

Overrides:

getDeploymentConfigurationPaths in class GenericSniffer

Returns:

list of the deployment descriptor paths