Package org.glassfish.web.sniffer
Class WarDetector
- java.lang.Object
-
- org.glassfish.web.sniffer.WarDetector
-
- All Implemented Interfaces:
ArchiveDetector
@Service(name="war") @Singleton public class WarDetector extends Object implements ArchiveDetector
Detects war type archives. It's rank can be set using system propertyWAR_DETECTOR_RANK_PROP
. Default rank isDEFAULT_WAR_DETECTOR_RANK
.- Author:
- [email protected]
-
-
Field Summary
Fields Modifier and Type Field Description static String
ARCHIVE_TYPE
static int
DEFAULT_WAR_DETECTOR_RANK
static String
WAR_DETECTOR_RANK_PROP
-
Constructor Summary
Constructors Constructor Description WarDetector()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ArchiveHandler
getArchiveHandler()
Return a ArchiveHandler that can handle the archive recognised by this ArchiveDetector.ArchiveType
getArchiveType()
Returns the type of the deployment unit or archive or module whichever way you want to call what's being depoyed.boolean
handles(ReadableArchive archive)
This method is used to detect the archive type.int
rank()
Since archive detection logic is typically executed at a very early stage of deployment, it is mainly heuristic.
-
-
-
Field Detail
-
WAR_DETECTOR_RANK_PROP
public static final String WAR_DETECTOR_RANK_PROP
- See Also:
- Constant Field Values
-
DEFAULT_WAR_DETECTOR_RANK
public static final int DEFAULT_WAR_DETECTOR_RANK
- See Also:
- Constant Field Values
-
ARCHIVE_TYPE
public static final String ARCHIVE_TYPE
- See Also:
- Constant Field Values
-
-
Method Detail
-
rank
public int rank()
Description copied from interface:ArchiveDetector
Since archive detection logic is typically executed at a very early stage of deployment, it is mainly heuristic. So some detectors can incorrectly recognize archives that they actually don't support. e.g., take a war file inside an ear file. and asssume that the war file contains some .jsp files. The archive detector responsible for handling the war file could be fooled into thinking the ear file is a war file since it contains jsp files, yet in reality, it only owns one of the sub archive bundled inside the composite ear file. To deal with such situations, each detector can specify a rank which can be used to order the detectors. Since detectors can come from separate authors, rank of a detector must be configurable in an installation. The order in which detectors are used during archive detection is based on the rank. Lower the integer value as returned by this method, earlier it is used during detection.- Specified by:
rank
in interfaceArchiveDetector
- Returns:
- the rank of this detector
-
handles
public boolean handles(ReadableArchive archive)
Description copied from interface:ArchiveDetector
This method is used to detect the archive type. If this detector can recognize the given archive, then it must return true.- Specified by:
handles
in interfaceArchiveDetector
- Returns:
-
getArchiveHandler
public ArchiveHandler getArchiveHandler()
Description copied from interface:ArchiveDetector
Return a ArchiveHandler that can handle the archive recognised by this ArchiveDetector.- Specified by:
getArchiveHandler
in interfaceArchiveDetector
- Returns:
-
getArchiveType
public ArchiveType getArchiveType()
Description copied from interface:ArchiveDetector
Returns the type of the deployment unit or archive or module whichever way you want to call what's being depoyed. Each archive handler is responsible for only one type of archive and the type of the archive is represented byArchiveType
.- Specified by:
getArchiveType
in interfaceArchiveDetector
- Returns:
- the type of the archive or deployment unit that can be detected by this detector
-
-