Packages

  • package root

    This is documentation for Mothra, a collection of Scala and Spark library functions for working with Internet-related data.

    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-data library, provides types for working with various kinds of information:

    org.cert.netsa.io.ipfix

    The netsa-io-ipfix library 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-silk library.

    org.cert.netsa.util

    The "junk drawer" of netsa-util so far provides only two features: First, a method for equipping Scala 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-datasources library contains both IPFIX and SiLK functionality, while mothra-datasources-ipfix and mothra-datasources-silk contain 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-functions library.

    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package cert
    Definition Classes
    org
  • package netsa
    Definition Classes
    cert
  • package io
    Definition Classes
    netsa
  • package silk

    SiLK file formats, data types, and methods to read them, including support for reading them from Spark.

    SiLK file formats, data types, and methods to read them, including support for reading them from Spark.

    RWRec is the type of SiLK flow records.

    You can use RWRecReader to read SiLK files from Scala, including compressed files if Hadoop native libraries are available. For example:

    import org.cert.netsa.io.silk.RWRecReader
import java.io.FileInputStream

val inputFile = new FileInputStream("path/to/silk/rw/file")

for ( rec <- RWRecReader.ofInputStream(inputFile) ) {
  println(rec.sIP)
}
    Definition Classes
    io
    See also

    org.cert.netsa.mothra.datasources.silk.flow for working with SiLK data in Spark using the Mothra SiLK datasource.

  • package config
    Definition Classes
    silk
  • package io
    Definition Classes
    silk
  • BagDataType
  • BagReader
  • BagResult
  • BagWriter
  • CompressionMethod
  • FileFormat
  • FlowType
  • Header
  • HeaderEntry
  • IPSetReader
  • IPSetWriter
  • PrefixMapProtocolPortPair
  • PrefixMapReader
  • PrefixMapResult
  • RWRec
  • RWRecReader
  • RWRecWriter
  • Sensor
  • SilkConfig
  • SilkDataFormatException
  • SilkVersion
  • TCPState

object RWRecWriter

The RWRecWriter companion object provides support for creating an RWRecWriter.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RWRecWriter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def forOutputStream(s: OutputStream, compressionMethod: CompressionMethod = CompressionMethod.NONE, order: ByteOrder = ByteOrder.nativeOrder()): RWRecWriter

    Creates and returns a writer that writes RWRecs as a binary SiLK RWRec stream to the output stream s using the default file format and version.

    Creates and returns a writer that writes RWRecs as a binary SiLK RWRec stream to the output stream s using the default file format and version. The default format preserves as much information as possible, but note that this may limit compatibility with older versions of SiLK. For finer-grained control over the output format, consider using forOutputStreamFormat or forOutputStreamPrecision.

    If compressionMethod is provided, compresses output using that method, otherwise output is not compressed.

    If order is provided, writes data in the specified byte order, otherwise uses native order.

  10. def forOutputStreamFormat(s: OutputStream, fileFormat: FileFormat, recordVersion: Short, compressionMethod: CompressionMethod = CompressionMethod.NONE, order: ByteOrder = ByteOrder.nativeOrder()): RWRecWriter

    Creates and returns a writer that writes RWRecs as a binary SiLK RWRec stream to the output stream s using the requested file format and record version, if available.

    Creates and returns a writer that writes RWRecs as a binary SiLK RWRec stream to the output stream s using the requested file format and record version, if available. @throws SilkDataFormatException if the format is not supported.

    If compressionMethod is provided, compresses output using that method, otherwise output is not compressed.

    If order is provided, writes data in the specified byte order, otherwise uses native order.

  11. def forOutputStreamPrecision(s: OutputStream, timePrecision: ChronoUnit, compressionMethod: CompressionMethod = CompressionMethod.NONE, order: ByteOrder = ByteOrder.nativeOrder()): RWRecWriter

    Creates and returns a writer that writes RWRecs as a binary SiLK RWRec stream to the output stream s using the default file format and record version for the requested time precision.

    Creates and returns a writer that writes RWRecs as a binary SiLK RWRec stream to the output stream s using the default file format and record version for the requested time precision.

    If compressionMethod is provided, compresses output using that method, otherwise output is not compressed.

    If order is provided, writes data in the specified byte order, otherwise uses native order.

  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def toOutputStream(s: OutputStream, compressionMethod: CompressionMethod = CompressionMethod.NONE): RWRecWriter
    Annotations
    @deprecated
    Deprecated

    (Since version netsa-io-silk 1.7.0) please use RWRecWriter.forOutputStream family of methods instead for control over output format

Inherited from AnyRef

Inherited from Any

Ungrouped