final class StreamSession extends Session
There are two types of Sessions: StreamSession and DatagramSession.
A StreamSession implements Template instantiation and Template withdrawal handling as dictated by sections 8 and 8.1 of RFC 7011. In particular, Session.TemplateInterferenceException is thrown when different templates use the same template id.
A StreamSession is created by a SessionGroup with the
streamSemantics parameter set to true.
- Exceptions thrown
Session.TemplateInterferenceExceptionwhen different templates use the same template id.
- Alphabetic
- By Inheritance
- StreamSession
- Session
- StrictLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new StreamSession(group: SessionGroup, id: Int)
- group
The session group that owns the session.
- id
The observation domain ID.
- Exceptions thrown
Session.TemplateInterferenceExceptionwhen different templates use the same template id.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def add(t: Template, tid: Int): Option[Template]
Adds a Template to this Session using
tidas the templateId and replacing the Template that previously used that ID, if any.Adds a Template to this Session using
tidas the templateId and replacing the Template that previously used that ID, if any. If a Template is replaced, it is returned.To add
templateonly if it is not already present, usegetOrAdd.If
template.sizeis 0, withdraws and returns the Template whose ID istid. The Template if not withdrawn if this is a DatagramSession.- Definition Classes
- StreamSession → Session
- Exceptions thrown
Session.TemplateInterferenceExceptionwhen a template is replaced that may not be replaced, by policy.java.lang.RuntimeExceptionwhen the Template's session is not this session.
- def addTemplateMetadata(metadata: TemplateMetadata): Unit
Updates the metadata for a particular template in this Session.
Updates the metadata for a particular template in this Session. Ignores
metadataif its template ID is invalid.- Definition Classes
- Session
- final def apply(template: Template): Int
The ID used by
templatewithin this Session.The ID used by
templatewithin this Session.- Definition Classes
- Session
- Since
1.3.1
- Exceptions thrown
NoTemplateExceptionif the Session does not know about that Template.- See also
- final def apply(tid: Int): Template
The Template from the template library with this template ID.
The Template from the template library with this template ID.
- Definition Classes
- Session
- Since
1.3.1
- Exceptions thrown
NoTemplateExceptionif the Session does not have a Template with that ID.- See also
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- var expectedSequence: Long
The sequence number that is expected for the next message in this session.
The sequence number that is expected for the next message in this session.
It is value a value between 0 and 2^32-1, or -1 if no message has yet been observed in this session.
- Definition Classes
- Session
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def findUnusedId(): Option[Int]
Find a template ID not currently being used by this session.
Find a template ID not currently being used by this session. Returns None when the Session has no available IDs. (Not necessarily deterministic.)
- returns
a currently unused template ID
- Definition Classes
- Session
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def getId(template: Template): Option[Int]
Gets the ID for the Template within this session as an Option.
Gets the ID for the Template within this session as an Option.
- Definition Classes
- Session
- def getOrAdd(template: Template, tid: Option[Int] = None): Int
Returns the ID for
templatein this Session, addingtemplateto this Session if it does not exist.Returns the ID for
templatein this Session, addingtemplateto this Session if it does not exist.If
templatemust be added to the Session, an arbitrary ID is used whentidisNone. Iftidis notNone, that ID is used if possible; otherwise an arbitrary ID is used. Use theaddmethod iftemplatemust use a particular ID.Takes no action and returns 0 if
template.sizeis 0.- template
The Template to get or add
- tid
An optional ID for
templateif it does not exist in the Session- returns
The ID of
templatein this Session
- Definition Classes
- Session
- def getPersistentSession(): Session
Returns a read-only copy of this session that will not change.
Returns a read-only copy of this session that will not change.
- returns
the persistent session
- Definition Classes
- Session
- final def getTemplate(tid: Int): Option[Template]
Gets a Template from the template library based on the template ID as an Option.
Gets a Template from the template library based on the template ID as an Option.
- tid
the template ID
- returns
The template associated with the template ID, or
None
- Definition Classes
- Session
- def getTemplateMetadata(tid: Int): Option[TemplateMetadata]
Gets the metadata for the Template whose ID is
tidas an Option. - def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final var idGetTmpl: TrieMap[Int, Template]
Maps a templateId to a Template.
Maps a templateId to a Template. "protected" since ReadOnlySession needs access
- Attributes
- protected
- Definition Classes
- Session
- final val infoModel: InfoModel
- Definition Classes
- Session
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def iterator: Iterator[Template]
Returns an Iterator over the Templates in the Session.
Returns an Iterator over the Templates in the Session.
- Definition Classes
- Session
- val logger: Logger
- Attributes
- protected
- Definition Classes
- StrictLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def noteMessage(m: Message): Unit
Check for missing or out of sequence records.
Check for missing or out of sequence records. If found, invoke any SequenceCallback objects that have been registered and log a message. A log message is not written if no SequenceCallback objects have been registered.
- Definition Classes
- Session
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final val observationDomain: Int
- Definition Classes
- Session
- def register(callback: SequenceCallback): Unit
Registers a new sequence callback with this session.
Registers a new sequence callback with this session. A session can have any number of callbacks registered to it. Each registered callback will be called whenever a message arrives with an unexpected sequence number.
- callback
the sequence number callback
- Definition Classes
- Session
- def register(callback: Iterable[TemplateCallback]): Unit
Registers multiple templates callbacks with this session.
Registers multiple templates callbacks with this session.
- Definition Classes
- Session
- def register(callback: TemplateCallback): Unit
Registers a new template callback with this session.
Registers a new template callback with this session. A session can have any number of callbacks registered to it. Each registered callback will be called whenever a template is added or removed from the session template library.
- callback
the template callback
- Definition Classes
- Session
- def remove(template: Template): Option[Template]
Removes a template from this session.
Removes a template from this session.
- template
The template to remove
- returns
the template that was removed, or
Noneif none
- Definition Classes
- Session
- def remove(tid: Int): Option[Template]
Removes a template from this session.
Removes a template from this session.
- tid
the template ID of the template to remove
- returns
the template that was removed, or
Noneif none
- Definition Classes
- Session
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final var templateMetadata: TrieMap[Int, TemplateMetadata]
Maps a templateId to its metadata
Maps a templateId to its metadata
- Attributes
- protected
- Definition Classes
- Session
- final var tmplGetId: TrieMap[Template, Int]
Maps a Template to its templateId in this Session.
Maps a Template to its templateId in this Session.
- Attributes
- protected
- Definition Classes
- Session
- def toString(): String
- Definition Classes
- AnyRef → Any
- final val transport: AnyRef
- Definition Classes
- Session
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withdraw(t: Template, tid: Int): Option[Template]
Internal function that removes a template when a withdrawal template is received on the input stream.
Internal function that removes a template when a withdrawal template is received on the input stream. That is, when add() is called with a withdrawal template.
- Attributes
- protected
- Definition Classes
- Session
This is documentation for Mothra, a collection of Scala and Spark library functions for working with Internet-related data. Some modules contain APIs of general use to Scala programmers. Some modules make those tools more useful on Spark data-processing systems.
Please see the documentation for the individual packages for more details on their use.
Scala Packages
These packages are useful in Scala code without involving Spark:
org.cert.netsa.data
This package, which is collected as the
netsa-datalibrary, provides types for working with various kinds of information:org.cert.netsa.data.net- types for working with network dataorg.cert.netsa.data.time- types for working with time dataorg.cert.netsa.data.unsigned- types for working with unsigned integral valuesorg.cert.netsa.io.ipfix
The
netsa-io-ipfixlibrary provides tools for reading and writing IETF IPFIX data from various connections and files.org.cert.netsa.io.silk
To read and write CERT NetSA SiLK file formats and configuration files, use the
netsa-io-silklibrary.org.cert.netsa.util
The "junk drawer" of
netsa-utilso far provides only two features: First, a method for equipping Scala scala.collection.Iterators with exception handling. And second, a way to query the versions of NetSA libraries present in a JVM at runtime.Spark Packages
These packages require the use of Apache Spark:
org.cert.netsa.mothra.datasources
Spark datasources for CERT file types. This package contains utility features which add methods to Apache Spark DataFrameReader objects, allowing IPFIX and SiLK flows to be opened using simple
spark.read...calls.The
mothra-datasourceslibrary contains both IPFIX and SiLK functionality, whilemothra-datasources-ipfixandmothra-datasources-silkcontain only what's needed for the named datasource.org.cert.netsa.mothra.analysis
A grab-bag of analysis helper functions and example analyses.
org.cert.netsa.mothra.functions
This single Scala object provides Spark SQL functions for working with network data. It is the entirety of the
mothra-functionslibrary.