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 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-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 FileFormat extends ByteEnum[FileFormat]

Linear Supertypes
ByteEnum[FileFormat], ValueEnum[Byte, FileFormat], AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. FileFormat
  2. ByteEnum
  3. ValueEnum
  4. AnyRef
  5. 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. def apply(v: Byte): FileFormat

    Converts a byte value to a file format.

    Converts a byte value to a file format.

    returns

    The file format represented by this value.

    Exceptions thrown

    SilkDataFormatException if the byte represents no known file format.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final macro def findValues: IndexedSeq[FileFormat]
    Attributes
    protected
    Definition Classes
    ByteEnum
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. def unpacker(fileFormat: FileFormat, recordVersion: Short): Option[Unpacker]

    Optionally returns the unpacker for a given file format and record version, if such an unpacker exists.

    Optionally returns the unpacker for a given file format and record version, if such an unpacker exists.

    returns

    Some(packer) if an appropriate unpacker exists, None otherwise.

  20. lazy val values: IndexedSeq[FileFormat]

    Collection of all known valid SiLK file formats.

    Collection of all known valid SiLK file formats.

    Definition Classes
    FileFormat → ValueEnum
  21. final lazy val valuesToEntriesMap: Map[Byte, FileFormat]
    Definition Classes
    ValueEnum
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. def withValue(i: Byte): FileFormat
    Definition Classes
    ValueEnum
    Annotations
    @SuppressWarnings()
  26. def withValueEither(i: Byte): Either[NoSuchMember[Byte, ValueEnumEntry[Byte]], FileFormat]
    Definition Classes
    ValueEnum
  27. def withValueOpt(i: Byte): Option[FileFormat]
    Definition Classes
    ValueEnum
  28. case object FT_ADDRESSES extends FileFormat with Product with Serializable

  29. case object FT_BLOOM extends FileFormat with Product with Serializable

  30. case object FT_EXPERIMENT1 extends FileFormat with Product with Serializable

  31. case object FT_EXPERIMENT2 extends FileFormat with Product with Serializable

  32. case object FT_FLOWCAP extends FileFormat with Product with Serializable

  33. case object FT_GRAPH extends FileFormat with Product with Serializable

  34. case object FT_IPFIX extends FileFormat with Product with Serializable

  35. case object FT_IPSET extends FileFormat with Product with Serializable

  36. case object FT_NIDSMAP extends FileFormat with Product with Serializable

  37. case object FT_PDUFLOWCAP extends FileFormat with Product with Serializable

  38. case object FT_PORTMAP extends FileFormat with Product with Serializable

  39. case object FT_PREFIXMAP extends FileFormat with Product with Serializable

  40. case object FT_RESERVED_09 extends FileFormat with Product with Serializable

  41. case object FT_RESERVED_0F extends FileFormat with Product with Serializable

  42. case object FT_RESERVED_17 extends FileFormat with Product with Serializable

  43. case object FT_RWACL extends FileFormat with Product with Serializable

  44. case object FT_RWAUGMENTED extends FileFormat with Product with Serializable

  45. case object FT_RWAUGROUTING extends FileFormat with Product with Serializable

  46. case object FT_RWAUGSNMPOUT extends FileFormat with Product with Serializable

  47. case object FT_RWAUGWEB extends FileFormat with Product with Serializable

  48. case object FT_RWBAG extends FileFormat with Product with Serializable

  49. case object FT_RWCOUNT extends FileFormat with Product with Serializable

  50. case object FT_RWDAILY extends FileFormat with Product with Serializable

  51. case object FT_RWFILTER extends FileFormat with Product with Serializable

  52. case object FT_RWGENERIC extends FileFormat with Product with Serializable

  53. case object FT_RWIPV6 extends FileFormat with Product with Serializable

  54. case object FT_RWIPV6ROUTING extends FileFormat with Product with Serializable

  55. case object FT_RWNOTROUTED extends FileFormat with Product with Serializable

  56. case object FT_RWPRINTSTATS extends FileFormat with Product with Serializable

  57. case object FT_RWROUTED extends FileFormat with Product with Serializable

  58. case object FT_RWSCAN extends FileFormat with Product with Serializable

  59. case object FT_RWSPLIT extends FileFormat with Product with Serializable

  60. case object FT_RWWWW extends FileFormat with Product with Serializable

  61. case object FT_SERVICEMAP extends FileFormat with Product with Serializable

  62. case object FT_SHUFFLE extends FileFormat with Product with Serializable

  63. case object FT_TAGTREE extends FileFormat with Product with Serializable

  64. case object FT_TCPDUMP extends FileFormat with Product with Serializable

  65. case object FT_TEMPFILE extends FileFormat with Product with Serializable

Inherited from ByteEnum[FileFormat]

Inherited from ValueEnum[Byte, FileFormat]

Inherited from AnyRef

Inherited from Any

Members

Values

Ungrouped