com.cososys.sensitivityio.sds.wrapper

Class MultithreadedScanner

java.lang.Object

com.cososys.sensitivityio.sds.wrapper.base.LocalScannerBase

com.cososys.sensitivityio.sds.wrapper.MultithreadedScanner

public final class MultithreadedScanner
extends LocalScannerBase

Wrapper class for ScannerExecutor. This class handles the scanning of files, strings and buffers on multiple threads.

Constructor Summary

Constructors

Constructor and Description
MultithreadedScanner() Constructor.
MultithreadedScanner(MultithreadedScanListener listener) Constructor.

Method Summary

Modifier and Type	Method and Description
void	cancelAndDestroy() Cancels the scanner and all scans in progress.
void	destroy() Destroys the scanner.
int	getActiveThreadCount() Retrieves the number of threads that are currently running.
int	getMaxThreadCount() Retrieves the maximum number of threads that the scanner can use.
int	getThreadExpiryTimeout() Retrieves the expiry timeout of a thread.
void	loadSettings(java.io.File settingsFile) Loads the settings from a file.
void	loadSettings(java.lang.String settings) Loads the settings from a string.
void	scanBuffer(byte[] buffer, boolean stopAtFirstThreat, java.lang.String fileName, int priority) Executes a buffer scan.
void	scanBuffer(byte[] buffer, ThreatHandler threatHandler, java.lang.String fileName, int priority) Executes a buffer scan with a custom ThreatHandler.
void	scanFile(java.io.File file, boolean stopAtFirstThreat, int priority) Executes a file scan.
void	scanFile(java.io.File file, ThreatHandler threatHandler, int priority) Executes a file scan with a custom ThreatHandler.
void	scanString(java.lang.String string, boolean stopAtFirstThreat, int priority) Executes a string scan.
void	scanString(java.lang.String string, ThreatHandler threatHandler, int priority) Executes a string scan with a custom ThreatHandler.
void	setMaxThreadCount(int maxThreads) Sets the maximum number of threads that the scanner can use.
void	setThreadExpiryTimeout(int millis) Sets the expiry timeout of a thread.
void	waitForFinished() Blocks the current thread until the scanner finishes all scans.

Methods inherited from class com.cososys.sensitivityio.sds.wrapper.base.LocalScannerBase

isLicenseLoaded, isSettingsLoaded, loadLicense, loadLicense

Methods inherited from class java.lang.Object

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

Constructor Detail

MultithreadedScanner

public MultithreadedScanner()

Constructor. Use this if you want to receive results on a ThreatHandler

MultithreadedScanner

public MultithreadedScanner(MultithreadedScanListener listener)

Constructor. Use this if you want to receive results on a MultithreadedScanListener.

Parameters:

listener - The MultithreadedScanListener which receives the results.

Method Detail

scanFile

public void scanFile(java.io.File file,
                     boolean stopAtFirstThreat,
                     int priority)
              throws InvalidLicenseException,
                     LicenseExpiredException,
                     LicenseException,
                     SettingsException,
                     java.io.IOException,
                     UnsupportedMimeTypeException,
                     java.lang.Exception

Executes a file scan. The result will be received on the MultithreadedScanListener passed in the constructor.

Parameters:

file - The file to be scanned.

stopAtFirstThreat - If true, it will stop after the first threat is found. If false, it will scan the whole file.

priority - The priority of the file in the queue. Files with high priority will be scanned before the files with low priority.

Throws:

InvalidLicenseException - If the license is invalid.

LicenseExpiredException - If the license is expired.

LicenseException - If the license is not loaded.

SettingsException - If the settings are invalid or not loaded.

java.io.IOException - If there was an error reading the file.

UnsupportedMimeTypeException - If this type of file cannot be scanned.

java.lang.Exception - Generic exception.

scanFile

public void scanFile(java.io.File file,
                     ThreatHandler threatHandler,
                     int priority)
              throws InvalidLicenseException,
                     LicenseExpiredException,
                     LicenseException,
                     SettingsException,
                     java.io.IOException,
                     UnsupportedMimeTypeException,
                     java.lang.Exception

Executes a file scan with a custom ThreatHandler.

Parameters:

file - The file to be scanned.

threatHandler - The custom handler that returns and handles the threat.

priority - The priority of the file in the queue. Files with high priority will be scanned before the files with low priority.

Throws:

InvalidLicenseException - If the license is invalid.

LicenseExpiredException - If the license is expired.

LicenseException - If the license is not loaded.

SettingsException - If the settings are invalid or not loaded.

java.io.IOException - If there was an error reading the file.

UnsupportedMimeTypeException - If this type of file cannot be scanned.

java.lang.Exception - Generic exception.

scanString

public void scanString(java.lang.String string,
                       boolean stopAtFirstThreat,
                       int priority)
                throws InvalidLicenseException,
                       LicenseExpiredException,
                       LicenseException,
                       SettingsException,
                       java.lang.Exception

Executes a string scan. The result will be received on the MultithreadedScanListener passed in the constructor.

Parameters:

string - The string to be scanned.

stopAtFirstThreat - If true, it will stop after the first threat is found. If false, it will scan the whole string.

priority - The priority of the string in the queue. Strings with high priority will be scanned before the strings with low priority.

Throws:

InvalidLicenseException - If the license is invalid.

LicenseExpiredException - If the license is expired.

LicenseException - If the license is not loaded.

SettingsException - If the settings are invalid or not loaded.

java.lang.Exception - Generic exception.

scanString

public void scanString(java.lang.String string,
                       ThreatHandler threatHandler,
                       int priority)
                throws InvalidLicenseException,
                       LicenseExpiredException,
                       LicenseException,
                       SettingsException,
                       java.lang.Exception

Executes a string scan with a custom ThreatHandler.

Parameters:

string - The string to be scanned.

threatHandler - The custom handler that returns and handles the threat.

priority - The priority of the string in the queue. Strings with high priority will be scanned before the strings with low priority.

Throws:

InvalidLicenseException - If the license is invalid.

LicenseExpiredException - If the license is expired.

LicenseException - If the license is not loaded.

SettingsException - If the settings are invalid or not loaded.

java.lang.Exception - Generic exception.

scanBuffer

public void scanBuffer(byte[] buffer,
                       boolean stopAtFirstThreat,
                       java.lang.String fileName,
                       int priority)
                throws InvalidLicenseException,
                       LicenseExpiredException,
                       LicenseException,
                       SettingsException,
                       java.lang.Exception

Executes a buffer scan. The result will be received on the MultithreadedScanListener passed in the constructor.

Parameters:

buffer - The buffer to be scanned.

stopAtFirstThreat - If true, it will stop after the first threat is found. If false, it will scan the whole buffer.

fileName - If you scan the buffer from a file, specify the file name.

priority - The priority of the buffer in the queue. Buffers with high priority will be scanned before the buffers with low priority.

Throws:

InvalidLicenseException - If the license is invalid.

LicenseExpiredException - If the license is expired.

LicenseException - If the license is not loaded.

SettingsException - If the settings are invalid or not loaded.

java.lang.Exception - Generic exception.

scanBuffer

public void scanBuffer(byte[] buffer,
                       ThreatHandler threatHandler,
                       java.lang.String fileName,
                       int priority)
                throws InvalidLicenseException,
                       LicenseExpiredException,
                       LicenseException,
                       SettingsException,
                       java.lang.Exception

Executes a buffer scan with a custom ThreatHandler.

Parameters:

buffer - The buffer to be scanned.

threatHandler - The custom handler that returns and handles the threat.

fileName - If you scan the buffer from a file, specify the file name.

priority - The priority of the buffer in the queue. Buffers with high priority will be scanned before the buffers with low priority.

Throws:

InvalidLicenseException - If the license is invalid.

LicenseExpiredException - If the license is expired.

LicenseException - If the license is not loaded.

SettingsException - If the settings are invalid or not loaded.

java.lang.Exception - Generic exception.

loadSettings

public void loadSettings(java.io.File settingsFile)
                  throws SettingsException,
                         java.io.IOException,
                         java.lang.Exception

Loads the settings from a file.

Parameters:

settingsFile - The file containing the settings.

Throws:

SettingsException - If there was an error loading the settings.

java.io.IOException - If there was an error reading the file.

java.lang.Exception - Generic exception.

loadSettings

public void loadSettings(java.lang.String settings)
                  throws SettingsException,
                         java.lang.Exception

Loads the settings from a string.

Parameters:

settings - The string containing the settings.

Throws:

SettingsException - If there was an error loading the settings.

java.lang.Exception - Generic exception.

setMaxThreadCount

public void setMaxThreadCount(int maxThreads)

Sets the maximum number of threads that the scanner can use.

Parameters:

maxThreads - The maximum number of threads.

getMaxThreadCount

public int getMaxThreadCount()

Retrieves the maximum number of threads that the scanner can use. The default value is the number of cores the processor has.

Returns:

The maximum number of threads.

setThreadExpiryTimeout

public void setThreadExpiryTimeout(int millis)

Sets the expiry timeout of a thread. If a thread remains inactive for millis milliseconds, it will expire.

Parameters:

millis - The expiry timeout of a thread in milliseconds.

getThreadExpiryTimeout

public int getThreadExpiryTimeout()

Retrieves the expiry timeout of a thread. The default values is 30000 (30 seconds).

Returns:

The expiry timeout of a thread in milliseconds.

getActiveThreadCount

public int getActiveThreadCount()

Retrieves the number of threads that are currently running. The value will be less than or equal to the maximum number of threads.

Returns:

The number of active threads.

waitForFinished

public void waitForFinished()

Blocks the current thread until the scanner finishes all scans.

cancelAndDestroy

public void cancelAndDestroy()

Cancels the scanner and all scans in progress. After canceling the scanner, the MultithreadedScanner will be destroyed and cannot be used again. This automatically destroys the scanner, so destroy() method is not needed to be called.

destroy

public void destroy()

Destroys the scanner. You should call this when not using the scanner anymore to avoid memory leaks.