ExportStream 1.5.0 - org.cert.netsa.io.ipfix.ExportStream

ExportStream supports writing IPFIX templates and records to a file.

The caller creates an ExportStream instance with an output channel and an associated Session. The caller may then add Templates or Records to the ExportStream, and the ExportStream writes the IPFIX data to the output file.

Since the Session is part of the ExportStream's constructor, all IPFIX Messages in the stream use the same observation domain.

By default, each exported IPFIX Message uses the current time as its timestamp. Set the makeTimestamp variable to change this behavior.

By default, an ExportStream adds an options record to describe each Information Element that is not part of the standard information model, and ExportStream ignores any such options records in the input stream. Set the describeElements variable to false to change this behavor, and use elementDescriptionTID to view or set the template ID used by these records.

By default, an ExportStream adds an options record to describe each Template it exports, and ExportStream ignores any such options records in the input stream. Set the describeTemplates variable to false to change this behavor, and use templateDescriptionTID to view or set the template ID used by these records.

NOTE: When copying data from an IPFIX input stream, ExportStream may change the order in which templates and records appear---specifically, templates that appear after a record in the input may be written before that record. ExportStream is aware of the Meta-Data Options templates and records that describe Information Elements and Templates, and, when ExportStream is not creating and exporting those items itself, those templates and records are copied from the input and written to the output in the required order. The user may call flush() to ensure some items appear in the output before others. The authors of this package may need to consider providing some way for the users to know when to call flush(), such as adding a callback methods to be invoked when a new IpfixSet is read.

Linear Supertypes

AnyRef, Any

Known Subclasses

ExportStreamTemplatesFirst

Instance Constructors

new ExportStream(out: WritableByteChannel, session: Session)

out
Where to write the IPFIX data.
session
The session to use.

Attributes
protected

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(reader: MessageReader): ExportStream

Add all records from a MesageReader to this ExportStream
def add(record: Record): ExportStream

Adds record to the output stream.
Adds record to the output stream. Prior to adding record, adds any Templates used by record that have not been seen before.
If record appears to contain either information element meta-data or template meta-data, then the record is ignored if the Export Stream is exporting that meta-data itself (see the describeElements and describeTemplates variables).
def add(template: Template): ExportStream

Adds template to the output stream unless the template has already been seen by this stream.
Adds template to the output stream unless the template has already been seen by this stream.
If template appears to be a template for describing either information element meta-data or template meta-data, then the template is ignored if the Export Stream is exporting that meta-data itself (see the describeElements and describeTemplates variables).
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(): Unit

Flushes and closes the output stream.
def dataWrittenCallback: Option[DataWrittenCallback]

Gets the current callback invoked when bytes are written to the outputStream as an Option.
Gets the current callback invoked when bytes are written to the outputStream as an Option.

Since
1.3.1
def dataWrittenCallback_=(callback: DataWrittenCallback): Unit

Sets a callback to be invoked when bytes are written to the outputStream.
Sets a callback to be invoked when bytes are written to the outputStream.

Since
1.3.1
var describeElements: Boolean

Whether to export option records that describe private enterprise information elements.
Whether to export option records that describe private enterprise information elements.
If this is true, ExportStream generates these records itself and any such records given to the add method are ignored. The records are generated as-needed and may appear anywhere in the output.
If this is false, input records that describe private enterprise elements are written to the output without ExportStream examining their content. This may result in duplicate descriptions in the output.
In either case, ExportStream attempts to use the same template ID for the element metadata template as seen in the incoming data.
var describeTemplates: Boolean

Whether to export option records that include the name and description of each template.
Whether to export option records that include the name and description of each template.
If this is true, ExportStream generates these records itself and any such records given to the add method are ignored. The records are generated as-needed and may appear anywhere in the output.
If this is false, input records that describe templates are written to the output without ExportStream examining their content. This may result in duplicate descriptions in the output.
In either case, ExportStream attempts to use the same template ID for the template metadata template as seen in the incoming data.
def elementDescriptionTID: Option[Int]

Returns the template ID for the options template used by records that describe private enterprise information elements.
Returns the template ID for the options template used by records that describe private enterprise information elements. Returns scala.None if no ID has been assigned.
def elementDescriptionTID_=(tid: Int): Unit

Sets the template ID for the options template used by records that describe private enterprise information elements and exports the template to ensure the template ID is reserved.
Sets the template ID for the options template used by records that describe private enterprise information elements and exports the template to ensure the template ID is reserved.

Exceptions thrown
IllegalTemplateRecordException when tid is illegal or is already in use by the session
RuntimeException when tid cannot be used for the template because the template already exists
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flush(): ExportStream

Flushes any data currently sitting in memory.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
var knownTmpl: Set[Template]

The set of templates that have been exported
var makeTimestamp: MessageTimestamp

Callback to generate a timestamp
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def outputStream: WritableByteChannel

Returns the file channel to which the data is being written
def recordCount: Int

Returns the number of data records added to the stream.
val session: Session

The session to use.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def templateCount: Int

Returns the number of templates added to the stream.
def templateDescriptionTID: Option[Int]

Returns the template ID for the options template used by records that describe templates.
Returns the template ID for the options template used by records that describe templates. Returns scala.None if no ID has been assigned.
def templateDescriptionTID_=(tid: Int): Unit

Sets the template ID for the options template used by records that describe templates and exports the template to ensure the template ID is reserved.
Sets the template ID for the options template used by records that describe templates and exports the template to ensure the template ID is reserved.

Exceptions thrown
IllegalTemplateRecordException when tid is illegal or is already in use by the session
RuntimeException when tid cannot be used for the template because the template already exists
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

ExportStream

Related Docs: object ExportStream | package ipfix

class ExportStream extends AnyRef

Instance Constructors

new ExportStream(out: WritableByteChannel, session: Session)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def add(reader: MessageReader): ExportStream

def add(record: Record): ExportStream

def add(template: Template): ExportStream

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close(): Unit

def dataWrittenCallback: Option[DataWrittenCallback]

def dataWrittenCallback_=(callback: DataWrittenCallback): Unit

var describeElements: Boolean

var describeTemplates: Boolean

def elementDescriptionTID: Option[Int]

def elementDescriptionTID_=(tid: Int): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def flush(): ExportStream

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

var knownTmpl: Set[Template]

var makeTimestamp: MessageTimestamp

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def outputStream: WritableByteChannel

def recordCount: Int

val session: Session

final def synchronized[T0](arg0: ⇒ T0): T0

def templateCount: Int

def templateDescriptionTID: Option[Int]

def templateDescriptionTID_=(tid: Int): Unit

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped