com.cososys.sensitivityio.sds.wrapper.base

Class LocalScannerBase

java.lang.Object

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

Direct Known Subclasses:

LocalScanner, MultithreadedScanner

public class LocalScannerBase
extends java.lang.Object

Base class for local scanning.

Field Summary

Fields

Modifier and Type	Field and Description
protected ScannerSettingsLoader	settingsLoader

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalScannerBase(android.content.Context context) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	checkScanBufferExceptions(byte[] buffer) Checks for exceptions before scanning a buffer.
protected void	checkScanBufferExceptions(byte[] buffer, ThreatHandler threatHandler) Checks for exceptions before scanning a buffer.
protected void	checkScanFileExceptions(java.io.File file) Checks for exceptions before scanning a file.
protected void	checkScanFileExceptions(java.io.File file, ThreatHandler threatHandler) Checks for exceptions before scanning a file.
protected void	checkScanStringExceptions(java.lang.String string) Checks for exceptions before scanning a string.
protected void	checkScanStringExceptions(java.lang.String string, ThreatHandler threatHandler) Checks for exceptions before scanning a string.
protected void	checkWriteStoragePermission() Checks if android.permission.WRITE_EXTERNAL_STORAGE is granted before scanning a file.
boolean	isLicenseLoaded() Checks if the license is loaded.
boolean	isSettingsLoaded() Checks if the settings are loaded.
void	loadLicense(java.io.File licenseFile) Loads the license from a file.
void	loadLicense(java.lang.String license) Loads the license from a string.
protected void	loadSettings(java.io.File settingsFile) Loads the settings from a file.
protected void	loadSettings(java.lang.String settings) Loads the settings from a string.

Methods inherited from class java.lang.Object

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

Field Detail

settingsLoader

protected ScannerSettingsLoader settingsLoader

Constructor Detail

LocalScannerBase

protected LocalScannerBase(android.content.Context context)

Constructor.

Parameters:

context - The Context.

Method Detail

loadLicense

public void loadLicense(java.io.File licenseFile)
                 throws InvalidLicenseException,
                        java.io.IOException,
                        java.lang.Exception

Loads the license from a file.

Parameters:

licenseFile - The file containing the license.

Throws:

InvalidLicenseException - If the license is invalid.

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

java.lang.Exception - Generic exception.

loadLicense

public void loadLicense(java.lang.String license)
                 throws InvalidLicenseException,
                        java.lang.Exception

Loads the license from a string.

Parameters:

license - The string containing the license.

Throws:

InvalidLicenseException - If the license is invalid.

java.lang.Exception - Generic exception.

loadSettings

protected void loadSettings(java.io.File settingsFile)
                     throws SettingsException,
                            NoPermissionException,
                            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.

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

protected void loadSettings(java.lang.String settings)
                     throws SettingsException,
                            NoPermissionException,
                            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.

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

java.lang.Exception - Generic exception.

isLicenseLoaded

public boolean isLicenseLoaded()

Checks if the license is loaded.

Returns:

True if the license is loaded, else false.

isSettingsLoaded

public boolean isSettingsLoaded()

Checks if the settings are loaded.

Returns:

True if the settings are loaded, else false.

checkScanFileExceptions

protected void checkScanFileExceptions(java.io.File file)
                                throws LicenseException,
                                       SettingsException,
                                       NoPermissionException,
                                       java.io.IOException

Checks for exceptions before scanning a file.

Parameters:

file - The file to be scanned.

Throws:

LicenseException - If license is not loaded.

SettingsException - If settings are not loaded.

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

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

checkScanFileExceptions

protected void checkScanFileExceptions(java.io.File file,
                                       ThreatHandler threatHandler)
                                throws LicenseException,
                                       SettingsException,
                                       NoPermissionException,
                                       java.io.IOException

Checks for exceptions before scanning a file.

Parameters:

file - The file to be scanned.

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

Throws:

LicenseException - If license is not loaded.

SettingsException - If settings are not loaded.

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

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

checkScanStringExceptions

protected void checkScanStringExceptions(java.lang.String string)
                                  throws LicenseException,
                                         SettingsException,
                                         NoPermissionException

Checks for exceptions before scanning a string.

Parameters:

string - The string to be scanned.

Throws:

LicenseException - If license is not loaded.

SettingsException - If settings are not loaded.

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

checkScanStringExceptions

protected void checkScanStringExceptions(java.lang.String string,
                                         ThreatHandler threatHandler)
                                  throws LicenseException,
                                         SettingsException,
                                         NoPermissionException

Checks for exceptions before scanning a string.

Parameters:

string - The string to be scanned.

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

Throws:

LicenseException - If license is not loaded.

SettingsException - If settings are not loaded.

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

checkScanBufferExceptions

protected void checkScanBufferExceptions(byte[] buffer)
                                  throws LicenseException,
                                         SettingsException,
                                         NoPermissionException

Checks for exceptions before scanning a buffer.

Parameters:

buffer - The buffer to be scanned.

Throws:

LicenseException - If license is not loaded.

SettingsException - If settings are not loaded.

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

checkScanBufferExceptions

protected void checkScanBufferExceptions(byte[] buffer,
                                         ThreatHandler threatHandler)
                                  throws LicenseException,
                                         SettingsException,
                                         NoPermissionException

Checks for exceptions before scanning a buffer.

Parameters:

buffer - The buffer to be scanned.

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

Throws:

LicenseException - If license is not loaded.

SettingsException - If settings are not loaded.

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

checkWriteStoragePermission

protected void checkWriteStoragePermission()
                                    throws NoPermissionException

Checks if android.permission.WRITE_EXTERNAL_STORAGE is granted before scanning a file.

Throws:

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