mark.core

Class DetectionAgentProfile

java.lang.Object

mark.core.DetectionAgentProfile

public class DetectionAgentProfile
extends Object

Author:

Thibault Debatty

Field Summary

Fields

Modifier and Type	Field and Description
String	class_name The class of the detection agent to trigger.
String	label The label attached to the evidence produced by this detection agent.
HashMap<String,String>	parameters The parameters that will be provided to the detector.
String	trigger_label The label that will trigger this detection agent.

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).
boolean	match(String label) Test if the provided label should trigger this detection agent.

Methods inherited from class java.lang.Object

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

Field Detail

label

public String label

The label attached to the evidence produced by this detection agent. Ex: evidence.http.frequency.1week or aggregation

trigger_label

public String trigger_label

The label that will trigger this detection agent. Ex: http frequency could be triggered by data.http and aggregation could be triggered by evidence.

class_name

public String class_name

The class of the detection agent to trigger.

parameters

public HashMap<String,String> parameters

The parameters that will be provided to the detector.

Constructor Detail

DetectionAgentProfile

public DetectionAgentProfile()

Method Detail

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

match

public final boolean match(String label)

Test if the provided label should trigger this detection agent. return trigger_label.startsWith(label)

Parameters:

label -

Returns: