configuration

Class ModuleConfiguration

java.lang.Object

configuration.ModuleConfiguration

Direct Known Subclasses:

ChecksumFileModuleConfig, DirectoryMonitorModuleConfig, GeneralExecutableModuleConfig, GeneralExecutableModuleConfig, LogGrepConfig, ProcessExtractionModulesConfiguration, RegexConfig, XmlQueryConfig

public class ModuleConfiguration
extends java.lang.Object

Configuration for an AbstractModule. The modules are distinguished by a hash value of their configurations. The configuration is serialized to JSON, when the tool is closed.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	enabled flags, if the module is currently used for extraction
java.lang.String	eventAddToProfile when this event is generated, the part is added to profile UUID
FileFilter	fileFilter includes or excludes file types
java.lang.String	moduleDisplayName Changeable module name, only used for displaying purposes
java.lang.String	moduleName Not-changeable module name
java.lang.String	moduleVersion Current version of the module
boolean	recordEvents records events at event file

Constructor Summary

Constructors

Constructor and Description
ModuleConfiguration() Deprecated.
ModuleConfiguration(java.lang.String moduleName, java.lang.String version) Constructor to be called by the associated AbstractModule.

Method Summary

Modifier and Type	Method and Description
ModuleConfiguration	addSupportedSystem(OperatingSystem.OsName os) The default is "system independent".
boolean	configurationIsValid() Override this method, if a customized module configuration needs validation!
java.util.HashSet<OperatingSystem.OsName>	getSupportedSystems() Set of OperatingSystems supported by the module

Methods inherited from class java.lang.Object

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

Field Detail

moduleName

public java.lang.String moduleName

Not-changeable module name

moduleDisplayName

public java.lang.String moduleDisplayName

Changeable module name, only used for displaying purposes

moduleVersion

public java.lang.String moduleVersion

Current version of the module

enabled

public boolean enabled

flags, if the module is currently used for extraction

recordEvents

public boolean recordEvents

records events at event file

fileFilter

public FileFilter fileFilter

includes or excludes file types

eventAddToProfile

public java.lang.String eventAddToProfile

when this event is generated, the part is added to profile UUID

Constructor Detail

ModuleConfiguration

@Deprecated
public ModuleConfiguration()

Deprecated.

Used for the serialization. Don't use this constructor for other purposes.

ModuleConfiguration

public ModuleConfiguration(java.lang.String moduleName,
                           java.lang.String version)

Constructor to be called by the associated AbstractModule.

Parameters:

moduleName - not-changeable module name

version - current version of the module

Method Detail

configurationIsValid

public boolean configurationIsValid()

Override this method, if a customized module configuration needs validation!

Returns:

flag if the configuration is valid

addSupportedSystem

public ModuleConfiguration addSupportedSystem(OperatingSystem.OsName os)

The default is "system independent". If a system is added to the list of supported systems, the default will be removed.

Parameters:

os -

Returns:

config

getSupportedSystems

public java.util.HashSet<OperatingSystem.OsName> getSupportedSystems()

Set of OperatingSystems supported by the module

Returns:

supported operating systems