modules.configuration

Class GeneralExecutableModuleConfig

java.lang.Object

configuration.ModuleConfiguration

modules.configuration.GeneralExecutableModuleConfig

public class GeneralExecutableModuleConfig
extends ModuleConfiguration

Author:

fabio

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	BSDcommandNameOrPath
java.lang.String	commandNameOrPath The generic command name to natively execute; or it's full path.
java.lang.String	defaults
java.lang.String	helpOption Define here the commanline option to obtain the command help.
java.lang.String	LinuxcommandNameOrPath The Linux command name to natively execute; or it's full path.
java.lang.String	Linuxoptions
boolean	noHelp
java.lang.String	options
java.lang.String	OSXcommandNameOrPath The OS X command name to natively execute; or it's full path.
java.lang.String	OSXoptions
java.util.Map<java.lang.String,java.lang.String>	regEx TODO: (currently unimplemented) The regular expressions used to generate the outputs (name to identify result, expression)
int	timeout Timeout value for the process execution, after that timeout, the process will be killed.
int	waitBetweenCalls Value to wait between calls in hte iterative monitor
java.lang.String	WINcommandNameOrPath The Windows command name to natively execute; or it's full path.
java.lang.String	Winoptions
java.io.File	workingDirectory The absolute path for the current working directory for the command.

Fields inherited from class configuration.ModuleConfiguration

enabled, eventAddToProfile, fileFilter, moduleDisplayName, moduleName, moduleVersion, recordEvents

Constructor Summary

Constructors

Constructor and Description
GeneralExecutableModuleConfig()
GeneralExecutableModuleConfig(java.lang.String moduleName, java.lang.String version)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	currentOsOptions()

Methods inherited from class configuration.ModuleConfiguration

addSupportedSystem, configurationIsValid, getSupportedSystems

Methods inherited from class java.lang.Object

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

Field Detail

options

public java.lang.String options

defaults

public java.lang.String defaults

workingDirectory

public java.io.File workingDirectory

The absolute path for the current working directory for the command.

commandNameOrPath

public java.lang.String commandNameOrPath

The generic command name to natively execute; or it's full path. You can specify OS-specific commands in the proper configuration parameters.

OSXcommandNameOrPath

public java.lang.String OSXcommandNameOrPath

The OS X command name to natively execute; or it's full path.

LinuxcommandNameOrPath

public java.lang.String LinuxcommandNameOrPath

The Linux command name to natively execute; or it's full path.

WINcommandNameOrPath

public java.lang.String WINcommandNameOrPath

The Windows command name to natively execute; or it's full path.

BSDcommandNameOrPath

public java.lang.String BSDcommandNameOrPath

OSXoptions

public java.lang.String OSXoptions

Winoptions

public java.lang.String Winoptions

Linuxoptions

public java.lang.String Linuxoptions

noHelp

public boolean noHelp

regEx

public java.util.Map<java.lang.String,java.lang.String> regEx

TODO: (currently unimplemented) The regular expressions used to generate the outputs (name to identify result, expression)

timeout

public int timeout

Timeout value for the process execution, after that timeout, the process will be killed. Default value is 10000 (10 seconds); set to -1 to give no limit to the execution.

waitBetweenCalls

public int waitBetweenCalls

Value to wait between calls in hte iterative monitor

helpOption

public java.lang.String helpOption

Define here the commanline option to obtain the command help. Usually it's -h or --help. This will generate the default description for the module.

Constructor Detail

GeneralExecutableModuleConfig

public GeneralExecutableModuleConfig()

GeneralExecutableModuleConfig

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

Method Detail

currentOsOptions

protected java.lang.String currentOsOptions()