ds.funnel.traffic.formatter

Class ConsoleTGLogFormatter

java.lang.Object

java.util.logging.Formatter

ds.funnel.traffic.formatter.BasicTGLogFormatter

ds.funnel.traffic.formatter.HumanReadableTGLogFormatter

ds.funnel.traffic.formatter.ConsoleTGLogFormatter

public class ConsoleTGLogFormatter
extends HumanReadableTGLogFormatter

A ConsoleTGLogFormatter can be used to format LogRecords as a record of a packet transmission. The LogRecords in question should include the size, in bytes, of the packet as a parameter, if this information is desired in the log; if no parameter is included, the size will not be output. Output from this formatter will consist of the absolute time a packet was sent and packet size in bytes (if the packet size was provided) as a plaintext message.

Author:

Kira Lindburg

Constructor Summary

Constructors

Constructor and Description
ConsoleTGLogFormatter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(java.util.logging.LogRecord record) Formats the provided log record as a packet transmission.

Methods inherited from class ds.funnel.traffic.formatter.HumanReadableTGLogFormatter

getHead

Methods inherited from class java.util.logging.Formatter

formatMessage, getTail

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsoleTGLogFormatter

public ConsoleTGLogFormatter()

Method Detail

format

public java.lang.String format(java.util.logging.LogRecord record)

Formats the provided log record as a packet transmission. Assumes the provided log record does indeed represent a packet transmission and no attempt is made to verify. The first parameter for the LogRecord, if provided, should contain the size, in bytes, of the packet which was sent.

Overrides:

format in class HumanReadableTGLogFormatter

Returns:

the formatted log record. The returned String includes the absolute time this packet was sent and the size of the packet (if a parameter was provided to the log record). The values will be presented within a plaintext message.