org.cruxframework.crux.scanner

Class Scanners

java.lang.Object

org.cruxframework.crux.scanner.Scanners

public final class Scanners
extends Object

Author:

Thiago da Rosa de Bustamante

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Scanners.ScannerCallback Callback called when matches are found by scanner
static interface	Scanners.ScannerRegistrations

Field Summary

Fields

Modifier and Type	Field and Description
protected static Set<String>	allowedPackages
protected static String[]	DEFAULT_IGNORED_PACKAGES
protected static String[]	DEFAULT_REQUIRED_LIBS
protected static String[]	DEFAULT_REQUIRED_PACKAGES
protected static Set<String>	ignoredPackages
protected static Set<String>	requiredPackages

Method Summary

Methods

Modifier and Type	Method and Description
static void	addAllowedPackage(String allowedPackage)
static void	addIgnoredPackage(String ignoredPackage)
static void	addRequiredPackage(String requiredPackage)
static String[]	getAllowedPackages()
static String[]	getIgnoredPackages()
static String[]	getRequiredPackages()
static boolean	ignoreScan(URL baseURL, String intf)
static boolean	isScannerRegistered(Class<? extends AbstractScanner> scannerClass) Check if the given scanner is registered as a Crux scanner
static void	registerScanner(AbstractScanner scanner) Register a new scanner on Crux scanning engine.
static void	registerScanners(Scanners.ScannerRegistrations registrations) This method must be called before any scanning attempt
static void	resetScanner(Class<? extends AbstractScanner> scannerClass) Reset a specific scanner result.
static void	resetScanners() Reset all scanner results.
static void	scan() Scan the project and returns the result associated to the given scanner
static List<URL>	search(URL baseLocation, Filter filter)
static void	setAllowedPackages(String[] allowedPackages)
static void	setIgnoredPackages(String[] ignoredPackages)
static void	setRequiredPackages(String[] requiredPackages)
static void	setSearchURLs(URL... urls) Define the URLs that will be searched during scanning process.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_IGNORED_PACKAGES

protected static final String[] DEFAULT_IGNORED_PACKAGES

DEFAULT_REQUIRED_PACKAGES

protected static final String[] DEFAULT_REQUIRED_PACKAGES

DEFAULT_REQUIRED_LIBS

protected static final String[] DEFAULT_REQUIRED_LIBS

ignoredPackages

protected static Set<String> ignoredPackages

allowedPackages

protected static Set<String> allowedPackages

requiredPackages

protected static Set<String> requiredPackages

Method Detail

registerScanners

public static void registerScanners(Scanners.ScannerRegistrations registrations)

This method must be called before any scanning attempt

Parameters:

registrations -

setSearchURLs

public static void setSearchURLs(URL... urls)

Define the URLs that will be searched during scanning process.

Parameters:

urls -

registerScanner

public static void registerScanner(AbstractScanner scanner)

Register a new scanner on Crux scanning engine. All registered scanners are called during the scanning cycle.

Parameters:

scanner -

isScannerRegistered

public static boolean isScannerRegistered(Class<? extends AbstractScanner> scannerClass)

Check if the given scanner is registered as a Crux scanner

Parameters:

scannerClass -

Returns:

getIgnoredPackages

public static String[] getIgnoredPackages()

Returns:

setIgnoredPackages

public static void setIgnoredPackages(String[] ignoredPackages)

Parameters:

ignoredPackages -

addIgnoredPackage

public static void addIgnoredPackage(String ignoredPackage)

Parameters:

ignoredPackage -

getAllowedPackages

public static String[] getAllowedPackages()

Returns:

setAllowedPackages

public static void setAllowedPackages(String[] allowedPackages)

Parameters:

ignoredPackages -

addAllowedPackage

public static void addAllowedPackage(String allowedPackage)

Parameters:

ignoredPackage -

getRequiredPackages

public static String[] getRequiredPackages()

Returns:

setRequiredPackages

public static void setRequiredPackages(String[] requiredPackages)

Parameters:

ignoredPackages -

addRequiredPackage

public static void addRequiredPackage(String requiredPackage)

Parameters:

ignoredPackage -

ignoreScan

public static boolean ignoreScan(URL baseURL,
                 String intf)

Parameters:

intf -

Returns:

resetScanners

public static void resetScanners()

Reset all scanner results.

Parameters:

scannerClass -

resetScanner

public static void resetScanner(Class<? extends AbstractScanner> scannerClass)

Reset a specific scanner result. Used to support hot deployment

Parameters:

scannerClass -

scan

public static void scan()

Scan the project and returns the result associated to the given scanner

Parameters:

scannerClass -

search

public static List<URL> search(URL baseLocation,
               Filter filter)
                        throws IOException

Throws:

IOException