com.cososys.sensitivityio.sds.wrapper

Class LocalScanner

java.lang.Object

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

com.cososys.sensitivityio.sds.wrapper.LocalScanner

public final class LocalScanner
extends LocalScannerBase

Wrapper class for Scanner. This class handles simple scanning of files, string and buffers.

Field Summary

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

settingsLoader

Constructor Summary

Constructors

Constructor and Description
LocalScanner(android.content.Context context) Constructor.

Method Summary

Modifier and Type	Method and Description
void	cancelScanner() Cancels the scanner and the scan in progress.
void	destroy() Destroys the scanner.
void	loadSettings(java.io.File settingsFile) Loads the settings from a file.
void	loadSettings(java.lang.String settings) Loads the settings from a string.
java.util.List<Threat>	scanBuffer(byte[] buffer, boolean stopAtFirstThreat, java.lang.String fileName) Executes a buffer scan.
void	scanBuffer(byte[] buffer, ThreatHandler threatHandler, java.lang.String fileName) Executes a buffer scan with a custom ThreatHandler.
java.util.List<Threat>	scanFile(java.io.File file, boolean stopAtFirstThreat) Executes a file scan.
void	scanFile(java.io.File file, ThreatHandler threatHandler) Executes a file scan with a custom ThreatHandler.
java.util.List<Threat>	scanString(java.lang.String string, boolean stopAtFirstThreat) Executes a string scan.
void	scanString(java.lang.String string, ThreatHandler threatHandler) Executes a string scan with a custom ThreatHandler.

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

checkScanBufferExceptions, checkScanBufferExceptions, checkScanFileExceptions, checkScanFileExceptions, checkScanStringExceptions, checkScanStringExceptions, checkWriteStoragePermission, isLicenseLoaded, isSettingsLoaded, loadLicense, loadLicense

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalScanner

public LocalScanner(android.content.Context context)
             throws NoPermissionException

Constructor. Before initializing a LocalScanner, make sure android.permission.WRITE_EXTERNAL_STORAGE is granted.

Parameters:

context - The context.

Throws:

NoPermissionException - If android.permission.WRITE_EXTERNAL_STORAGE is not granted.

Method Detail

scanFile

public java.util.List<Threat> scanFile(java.io.File file,
                                       boolean stopAtFirstThreat)
                                throws InvalidLicenseException,
                                       LicenseExpiredException,
                                       LicenseException,
                                       SettingsException,
                                       NoPermissionException,
                                       java.io.IOException,
                                       UnsupportedMimeTypeException,
                                       java.lang.Exception

Executes a file scan.

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.

Returns:

A list of Threat.

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.

NoPermissionException - If android.permission.WRITE_EXTERNAL_STORAGE is not granted.

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)
              throws InvalidLicenseException,
                     LicenseExpiredException,
                     LicenseException,
                     SettingsException,
                     NoPermissionException,
                     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.

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.

NoPermissionException - If android.permission.WRITE_EXTERNAL_STORAGE is not granted.

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 java.util.List<Threat> scanString(java.lang.String string,
                                         boolean stopAtFirstThreat)
                                  throws InvalidLicenseException,
                                         LicenseExpiredException,
                                         LicenseException,
                                         SettingsException,
                                         NoPermissionException,
                                         java.lang.Exception

Executes a string scan.

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.

Returns:

A list of Threat.

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.

NoPermissionException - If android.permission.WRITE_EXTERNAL_STORAGE is not granted.

java.lang.Exception - Generic exception.

scanString

public void scanString(java.lang.String string,
                       ThreatHandler threatHandler)
                throws InvalidLicenseException,
                       LicenseExpiredException,
                       LicenseException,
                       SettingsException,
                       NoPermissionException,
                       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.

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.

NoPermissionException - If android.permission.WRITE_EXTERNAL_STORAGE is not granted.

java.lang.Exception - Generic exception.

scanBuffer

public java.util.List<Threat> scanBuffer(byte[] buffer,
                                         boolean stopAtFirstThreat,
                                         java.lang.String fileName)
                                  throws InvalidLicenseException,
                                         LicenseExpiredException,
                                         LicenseException,
                                         SettingsException,
                                         NoPermissionException,
                                         java.lang.Exception

Executes a buffer scan.

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.

Returns:

A list of Threat.

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.

NoPermissionException - If android.permission.WRITE_EXTERNAL_STORAGE is not granted.

java.lang.Exception - Generic exception.

scanBuffer

public void scanBuffer(byte[] buffer,
                       ThreatHandler threatHandler,
                       java.lang.String fileName)
                throws InvalidLicenseException,
                       LicenseExpiredException,
                       LicenseException,
                       SettingsException,
                       NoPermissionException,
                       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.

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.

NoPermissionException - If android.permission.WRITE_EXTERNAL_STORAGE is not granted.

java.lang.Exception - Generic exception.

loadSettings

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

Loads the settings from a file.

Overrides:

loadSettings in class LocalScannerBase

Parameters:

settingsFile - The file containing the settings.

Throws:

SettingsException - If there was an error loading the settings.

NoPermissionException - If android.permission.WRITE_EXTERNAL_STORAGE is not granted.

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,
                         NoPermissionException,
                         java.lang.Exception

Loads the settings from a string.

Overrides:

loadSettings in class LocalScannerBase

Parameters:

settings - The string containing the settings.

Throws:

SettingsException - If there was an error loading the settings.

NoPermissionException - If android.permission.WRITE_EXTERNAL_STORAGE is not granted.

java.lang.Exception - Generic exception.

cancelScanner

public void cancelScanner()

Cancels the scanner and the scan in progress. After canceling the scanner, the LocalScanner cannot be used again.

destroy

public void destroy()

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