at.jku.fim.rubanetra.protocol.activity

Class AbstractActivity

java.lang.Object

java.util.EventObject

at.jku.fim.rubanetra.protocol.activity.AbstractActivity

All Implemented Interfaces:

CsvRecordOutputWriter, Activity, Serializable

Direct Known Subclasses:

AbstractReplaceableActivity

public abstract class AbstractActivity
extends EventObject
implements Activity, CsvRecordOutputWriter

A template for a non-replaceable Activity. It defines an "addFrameNumbers" property that will be used to link two activities regarding the addition of frame numbers during the reasoning process. Additionally an activity extension method is provided, see extendActivity(Activity). If a replaceable activity is required, refer to AbstractReplaceableActivity.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_ADD_FRAME_NUMBERS
static String	PROPERTY_NEW_END_INSTANT
static String	PROPERTY_NEW_START_INSTANT

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
AbstractActivity(Object source) Constructs a prototypical Activity event.

Method Summary

Modifier and Type	Method and Description
protected void	addOptionalField(OptionalField field) Convenience method to add an optional field to the collection of all optional fields.
void	addPropertyChangeListener(PropertyChangeListener l) Adds a property change listener for all properties of this activity.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener l) Adds a property change listener for one exactly defined property of this activity.
void	extendActivity(Activity act) Extends this activity by act.
String	getActivityType() Defines the type of the activity - this value should be unique in the sense that it should be possible to identify the class of the object by using this String exclusively among all activities.
Collection<Long>	getCompoundFrameNumbers() This method returns a sorted collection of all frame numbers in consecutive order and greater than zero, that define this activity.
String	getDescription()
String	getDestinationAddressAsString() An address that can be interpreted as the destination address for this activity.
java.time.Instant	getEndInstant() Returns a fixed point in time that fixates the end of this activity's time-line, i.e.
Date	getEndTimestamp() This method should only be used within Drools rule-files and serve as timestamp indicator.
Collection<OptionalField>	getOptionalFields() This method returns a collection of attribute/value pairs that have to be included in the final output of all output processors including the CVS encoder and the JSON encoder.
String	getSourceAddressAsString() An address that can be interpreted as the source address for this activity.
java.time.Instant	getStartInstant() Returns a fixed point in time that fixates the start of this activity's time-line, i.e.
Date	getStartTimestamp() This method should only be used within Drools rule-files and serve as timestamp indicator.
boolean	isExcludedFromOutput() This method's return value indicates whether or not this activity will be included in the final output.
void	removePropertyChangeListener(PropertyChangeListener l) Removes the specified listener.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener l) The specified listener will no longer receive notifications for propertyName.
void	removeReplacedActivity(ReplaceableActivity act)
void	setDescription(String description)
void	setDestinationAddress(String destinationAddress)
void	setEndInstant(java.time.Instant endInstant)
void	setExcludedFromOutput(boolean isExcludedFromOutput) Setter for Activity.isExcludedFromOutput().
void	setSourceAddress(String sourceAddress)
void	setStartInstant(java.time.Instant startInstant)
String	toString()
void	writeCsvRecord(org.apache.commons.csv.CSVPrinter csvPrinter) Writes a single record to the provided csvPrinter.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_ADD_FRAME_NUMBERS

public static final String PROPERTY_ADD_FRAME_NUMBERS

See Also:

Constant Field Values

PROPERTY_NEW_START_INSTANT

public static final String PROPERTY_NEW_START_INSTANT

See Also:

Constant Field Values

PROPERTY_NEW_END_INSTANT

public static final String PROPERTY_NEW_END_INSTANT

See Also:

Constant Field Values

Constructor Detail

AbstractActivity

public AbstractActivity(Object source)

Constructs a prototypical Activity event.

Parameters:

source - The object on which the Event initially occurred.

Throws:

IllegalArgumentException - if source is null.

Method Detail

getActivityType

public String getActivityType()

Description copied from interface: Activity

Defines the type of the activity - this value should be unique in the sense that it should be possible to identify the class of the object by using this String exclusively among all activities. This value will be used by a python json parser to setup the equivalent of the Java class/activity structure.

Specified by:

getActivityType in interface Activity

Returns:

a unique identifier of the implemented activity

getStartTimestamp

public Date getStartTimestamp()

Description copied from interface: Activity

This method should only be used within Drools rule-files and serve as timestamp indicator. This is currently required due to the general incompatibility of Instant caused by the Drools engine pseudo-clock implementation.

Specified by:

getStartTimestamp in interface Activity

Returns:

a timestamp in MILLISECOND precision (backed by an Instant), representing the starting point in time for this Activity. Please note that this method returns an object which may not be persistent, i.e. the start timestamp object may be overwritten by implementations.

See Also:

Activity.getStartInstant(), setStartInstant(java.time.Instant), setStartInstant(java.time.Instant)

getStartInstant

public java.time.Instant getStartInstant()

Description copied from interface: Activity

Returns a fixed point in time that fixates the start of this activity's time-line, i.e. it returns a point in time that fulfills any one of the following conditions:

• if the activity is defined as an event that occurs at exactly one time without a duration/interval then the returned value corresponds to exactly that time and Activity.getEndInstant() must return the same reference
• if the activity spans over a period of time or includes multiple intervals, then the returned value corresponds to the point in time that lies furthest in the past and starts the first interval of the activity

Calling this method multiple times may return different instants, due to the reasoning process that may find a prior starting point in time. Therefore the returned object should generally not be used as an identifier for the activity.

Specified by:

getStartInstant in interface Activity

Returns:

the point in time that lies furthest in the past and indicates the start of the activity

setStartInstant

public void setStartInstant(java.time.Instant startInstant)

getEndTimestamp

public Date getEndTimestamp()

Description copied from interface: Activity

This method should only be used within Drools rule-files and serve as timestamp indicator. This is currently required due to the general incompatibility of Instant caused by the Drools engine pseudo-clock implementation.

Specified by:

getEndTimestamp in interface Activity

Returns:

a timestamp in MILLISECOND precision (backed by an Instant), representing the ending point in time for this Activity. Please note that this method returns an object which may not be persistent, i.e. the end timestamp object may be overwritten by implementations.

See Also:

Activity.getEndInstant(), setEndInstant(java.time.Instant), setEndInstant(java.time.Instant)

getEndInstant

public java.time.Instant getEndInstant()

Description copied from interface: Activity

Returns a fixed point in time that fixates the end of this activity's time-line, i.e. it returns a point in time that fulfills any one of the following conditions:

• if the activity is defined as an event that occurs at exactly one time without a duration/interval then the returned value corresponds to exactly that time and Activity.getStartInstant() must return the same reference
• if the activity spans over a period of time or includes multiple intervals, then the returned value corresponds to the point in time that lies closest to the current time and ends the last interval of the activity

Calling this method multiple times may return different instants, due to the reasoning process that may find a later starting point in time. Therefore the returned object should generally not be used as an identifier for the activity.

Specified by:

getEndInstant in interface Activity

Returns:

the point in time that lies closest to the current time indicates the end of the activity

setEndInstant

public void setEndInstant(java.time.Instant endInstant)

getSourceAddressAsString

public String getSourceAddressAsString()

Description copied from interface: Activity

An address that can be interpreted as the source address for this activity. Usually this address should correspond to a human readable value. Because different protocols may be defining different address formats and types, the returned value is highly dependant on the actual implementation and may be empty or null if no source address exists at all.

Specified by:

getSourceAddressAsString in interface Activity

Returns:

a human-readable protocol-dependant source address or null if no such address exists for this activity

getDestinationAddressAsString

public String getDestinationAddressAsString()

Description copied from interface: Activity

An address that can be interpreted as the destination address for this activity. Usually this address should correspond to a human readable value. Because different protocols may be defining different address formats and types, the returned value is highly dependant on the actual implementation and may be empty or null if no destination address exists at all.

Specified by:

getDestinationAddressAsString in interface Activity

Returns:

a human-readable protocol-dependant destination address or null if no such address exists for this activity

getDescription

public String getDescription()

Specified by:

getDescription in interface Activity

Returns:

an arbitrary String that describes this activity, may be null or empty

setDescription

public void setDescription(String description)

extendActivity

public void extendActivity(Activity act)

Extends this activity by act. The following actions are performed:

• all frame numbers from act are copied into this set of frame numbers
• if act is chronologically before this activity, the start Instant of this activity is overwritten
• if act is chronologically after this activity, the end Instant of this activity is overwritten
• if act is chronologically during this activity, no instants are modified
• an ADD_FRAME_NUMBER property listener is registered in act, in order to receive all future updates to the frame number set
• a NEW_START_INSTANT property listener is registered in act, in order to receive all future updates to the start instant
• a NEW_END_INSTANT property listener is registered in act, in order to receive all future updates to the end instant

Unintended consequences may be encountered in the following scenario: act1.extendActivity(act2); act2.extendActivity(act1);

Parameters:

act - the activity to be merged with this activity

addOptionalField

protected void addOptionalField(OptionalField field)

Convenience method to add an optional field to the collection of all optional fields.

Parameters:

field - the optional field to add, may not be null

getCompoundFrameNumbers

public Collection<Long> getCompoundFrameNumbers()

Description copied from interface: Activity

This method returns a sorted collection of all frame numbers in consecutive order and greater than zero, that define this activity. It serves as basis for a manual review of the packets that were used during the reasoning process, i.e. a future use case could consist of using these numbers to extract all frames corresponding to a single activity individually from a potentially large PCAP file.

Specified by:

getCompoundFrameNumbers in interface Activity

Returns:

a sorted collection of all frame numbers in consecutive order and greater than zero, that define this activity

getOptionalFields

public Collection<OptionalField> getOptionalFields()

Description copied from interface: Activity

This method returns a collection of attribute/value pairs that have to be included in the final output of all output processors including the CVS encoder and the JSON encoder. This serves as an opportunity to include information that would usually not be available due to the fixed nature of CVS columns specification.

Specified by:

getOptionalFields in interface Activity

Returns:

a collection of attribute/value pairs that have to be included in the final output of all output processors including the CVS encoder and the JSON encoder.

setSourceAddress

public void setSourceAddress(String sourceAddress)

setDestinationAddress

public void setDestinationAddress(String destinationAddress)

removeReplacedActivity

public void removeReplacedActivity(ReplaceableActivity act)

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Description copied from interface: Activity

Adds a property change listener for all properties of this activity.

Specified by:

addPropertyChangeListener in interface Activity

Parameters:

l - the listener to add

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener l)

Description copied from interface: Activity

Adds a property change listener for one exactly defined property of this activity.

Specified by:

addPropertyChangeListener in interface Activity

Parameters:

propertyName - the name of property to receive notifications for

l - the listener to add

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Description copied from interface: Activity

Removes the specified listener.

Specified by:

removePropertyChangeListener in interface Activity

Parameters:

l - the listener to remove

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener l)

Description copied from interface: Activity

The specified listener will no longer receive notifications for propertyName.

Specified by:

removePropertyChangeListener in interface Activity

Parameters:

propertyName - the name of property to stop receiving notifications for

l - the listener to remove

isExcludedFromOutput

public boolean isExcludedFromOutput()

Description copied from interface: Activity

This method's return value indicates whether or not this activity will be included in the final output. If this method returns false, the activity will be included in the final output.

Specified by:

isExcludedFromOutput in interface Activity

Returns:

true, iff this activity should be excluded from the final output

setExcludedFromOutput

public void setExcludedFromOutput(boolean isExcludedFromOutput)

Description copied from interface: Activity

Setter for Activity.isExcludedFromOutput().

Specified by:

setExcludedFromOutput in interface Activity

Parameters:

isExcludedFromOutput - whether or not to exclude this activity from the final output

writeCsvRecord

public void writeCsvRecord(org.apache.commons.csv.CSVPrinter csvPrinter)
                    throws IOException

Writes a single record to the provided csvPrinter. This record currently contains the following fields:

 activityType, startInstant, endInstant, sourceAddress, destinationAddress, description, frameNumbers, optionalFields
 

Specified by:

writeCsvRecord in interface CsvRecordOutputWriter

Parameters:

csvPrinter - An initialized csvPrinter, shared among all activities

Throws:

IOException - If the csvPrinter reaches an invalid state

toString

public String toString()

Overrides:

toString in class EventObject