com.cososys.sensitivityio.sdc.wrapper

Class MultithreadedClassifier

java.lang.Object

com.cososys.sensitivityio.sdc.wrapper.base.LocalClassifierBase

com.cososys.sensitivityio.sdc.wrapper.MultithreadedClassifier

public final class MultithreadedClassifier
extends LocalClassifierBase

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

Constructor Summary

Constructors

Constructor and Description
MultithreadedClassifier(MultithreadedClassificationListener listener) Constructor.

Method Summary

Modifier and Type	Method and Description
void	cancelAndDestroy() Cancels the classifier and all classifications in progress.
void	classifyBuffer(byte[] buffer, java.lang.String fileName, int priority) Executes a buffer classification.
void	classifyFile(java.io.File file, int priority) Executes a file classification.
void	classifyString(java.lang.String string, int priority) Executes a string classification.
void	destroy() Destroys the classifier.
int	getActiveThreadCount() Retrieves the number of threads that are currently running.
java.util.List<ClassificationFuture>	getClassificationFutureList()
int	getMaxThreadCount() Retrieves the maximum number of threads that the classifier 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	setMaxThreadCount(int maxThreads) Sets the maximum number of threads that the classifier can use.
void	setThreadExpiryTimeout(int millis) Sets the expiry timeout of a thread.
void	waitForFinished() Blocks the current thread until the classifier finishes all classifications.

Methods inherited from class com.cososys.sensitivityio.sdc.wrapper.base.LocalClassifierBase

isLicenseLoaded, isSettingsLoaded, loadLicense, loadLicense

Methods inherited from class java.lang.Object

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

Constructor Detail

MultithreadedClassifier

public MultithreadedClassifier(MultithreadedClassificationListener listener)

Constructor.

Parameters:

listener - The MultithreadedClassificationListener which receives the results.

Method Detail

classifyFile

public void classifyFile(java.io.File file,
                         int priority)
                  throws InvalidArgumentException,
                         java.io.FileNotFoundException,
                         InvalidLicenseException,
                         LicenseExpiredException,
                         LicenseException,
                         SettingsException,
                         java.io.IOException,
                         UnsupportedMimeTypeException,
                         NoKnownDataException,
                         java.lang.Exception

Executes a file classification. The result will be received on the MultithreadedClassificationListener passed in the constructor.

Parameters:

file - The file to be classified.

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

Throws:

InvalidArgumentException - If file parameter is null.

java.io.FileNotFoundException - If the file does not exist.

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 classified.

NoKnownDataException - If this file cannot be classified.

java.lang.Exception - Generic exception.

classifyString

public void classifyString(java.lang.String string,
                           int priority)
                    throws InvalidArgumentException,
                           InvalidLicenseException,
                           LicenseExpiredException,
                           LicenseException,
                           SettingsException,
                           NoKnownDataException,
                           java.lang.Exception

Executes a string classification. The result will be received on the MultithreadedClassificationListener passed in the constructor.

Parameters:

string - The string to be classified.

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

Throws:

InvalidArgumentException - If string parameter is null or empty.

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.

NoKnownDataException - If this file cannot be classified.

java.lang.Exception - Generic exception.

classifyBuffer

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

Executes a buffer classification. The result will be received on the MultithreadedClassificationListener passed in the constructor.

Parameters:

buffer - The buffer to be classified.

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

priority - The priority of the buffer in the queue. Buffers with high priority will be classified 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.

NoKnownDataException - If this file cannot be classified.

java.lang.Exception - Generic exception.

loadSettings

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

Loads the settings from a file.

Parameters:

settingsFile - The file containing the settings.

Throws:

InvalidArgumentException - If settingsFile argument is null.

SettingsException - If there was an error loading the settings.

java.io.FileNotFoundException - If the settings file does not exist.

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

Loads the settings from a string.

Parameters:

settings - The string containing the settings.

Throws:

InvalidArgumentException - If settings argument is null or empty.

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 classifier can use.

Parameters:

maxThreads - The maximum number of threads.

getMaxThreadCount

public int getMaxThreadCount()

Retrieves the maximum number of threads that the classifier 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 classifier finishes all classifications.

cancelAndDestroy

public void cancelAndDestroy()

Cancels the classifier and all classifications in progress. After canceling the classifier, the MultithreadedClassifier will be destroyed and cannot be used again. This automatically destroys the classifier, so destroy() method is not needed to be called after this.

destroy

public void destroy()

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

getClassificationFutureList

public java.util.List<ClassificationFuture> getClassificationFutureList()