be.cylab.mark.core

Class DetectionAgentProfile

java.lang.Object

be.cylab.mark.core.DetectionAgentProfile

public class DetectionAgentProfile
extends Object

Author:

Thibault Debatty

Constructor Summary

Constructors

Constructor and Description
DetectionAgentProfile()

Method Summary

Modifier and Type	Method and Description
DetectionAgentInterface	createInstance() Instantiate a detection agent for the provided subject.
static DetectionAgentProfile	fromFile(File file) Read a detection agent profile from a YAML file.
static DetectionAgentProfile	fromInputStream(InputStream input) Read a detection agent profile from an input stream (a resource file).
String	getClassName()
String	getLabel()
String	getParameter(String name)
String	getParameterOrDefault(String name, String default_value) Get the value of this parameter, of return default_value if not set.
HashMap<String,String>	getParameters()
String	getTriggerLabel()
void	setClassName(String class_name)
void	setLabel(String label)
void	setParameters(HashMap<String,String> parameters)
void	setTriggerLabel(String trigger_label)

Methods inherited from class java.lang.Object

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

Constructor Detail

DetectionAgentProfile

public DetectionAgentProfile()

Method Detail

getLabel

public final String getLabel()

Returns:

setLabel

public final void setLabel(String label)

Parameters:

label -

getTriggerLabel

public final String getTriggerLabel()

Returns:

setTriggerLabel

public final void setTriggerLabel(String trigger_label)

Parameters:

trigger_label -

getClassName

public final String getClassName()

Returns:

setClassName

public final void setClassName(String class_name)

Parameters:

class_name -

setParameters

public final void setParameters(HashMap<String,String> parameters)

Parameters:

parameters -

getParameters

public final HashMap<String,String> getParameters()

Returns:

getParameter

public final String getParameter(String name)

Parameters:

name -

Returns:

getParameterOrDefault

public final String getParameterOrDefault(String name,
                                          String default_value)

Get the value of this parameter, of return default_value if not set.

Parameters:

name -

default_value -

Returns:

fromFile

public static final DetectionAgentProfile fromFile(File file)
                                            throws FileNotFoundException

Read a detection agent profile from a YAML file.

Parameters:

file -

Returns:

Throws:

FileNotFoundException - if the file does not exist

fromInputStream

public static final DetectionAgentProfile fromInputStream(InputStream input)

Read a detection agent profile from an input stream (a resource file).

Parameters:

input -

Returns:

createInstance

public final DetectionAgentInterface createInstance()
                                             throws InvalidProfileException

Instantiate a detection agent for the provided subject.

Returns:

Throws:

InvalidProfileException - if the profile is incorrect (generally due to an invalid class name).