public interface Activity extends Serializable
setExcludedFromOutput(boolean)
has been called on an object to object basis.
However, implementations of this interface cannot be replaced by other activities by simple means, therefore the use
of ReplaceableActivity
is recommended instead.
Furthermore, the values returned by the getter methods are the only values that will be included in the CVS output
while the Json parser will include all fields of all subclasses.
Generally it is advisable to establish a meaningful implementation of all defined methods, nevertheless a template
is provided by AbstractActivity
.Modifier and Type | Method and Description |
---|---|
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.
|
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 |
setExcludedFromOutput(boolean excludedFromOutput)
Setter for
isExcludedFromOutput() . |
String getActivityType()
java.time.Instant getStartInstant()
getEndInstant()
must return the same referencejava.time.Instant getEndInstant()
getStartInstant()
must return the same referenceString getSourceAddressAsString()
String getDestinationAddressAsString()
String getDescription()
boolean isExcludedFromOutput()
void setExcludedFromOutput(boolean excludedFromOutput)
isExcludedFromOutput()
.excludedFromOutput
- whether or not to exclude this activity from the final outputCollection<Long> getCompoundFrameNumbers()
Collection<OptionalField> getOptionalFields()
void addPropertyChangeListener(PropertyChangeListener l)
l
- the listener to addvoid addPropertyChangeListener(String propertyName, PropertyChangeListener l)
propertyName
- the name of property to receive notifications forl
- the listener to addvoid removePropertyChangeListener(PropertyChangeListener l)
l
- the listener to removevoid removePropertyChangeListener(String propertyName, PropertyChangeListener l)
propertyName
- the name of property to stop receiving notifications forl
- the listener to removeDate getStartTimestamp()
Instant
caused by the Drools engine pseudo-clock implementation.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.getStartInstant()
,
AbstractActivity.setStartInstant(java.time.Instant)
,
AbstractActivity.setStartInstant(java.time.Instant)
Date getEndTimestamp()
Instant
caused by the Drools engine pseudo-clock implementation.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.getEndInstant()
,
AbstractActivity.setEndInstant(java.time.Instant)
,
AbstractActivity.setEndInstant(java.time.Instant)
Copyright © 2013–2015 Institute of networks and security. All rights reserved.