ds.funnel.traffic.formatter

Class HumanReadableTGLogFormatter

java.lang.Object

java.util.logging.Formatter

ds.funnel.traffic.formatter.BasicTGLogFormatter

ds.funnel.traffic.formatter.HumanReadableTGLogFormatter

Direct Known Subclasses:

ConsoleTGLogFormatter

public class HumanReadableTGLogFormatter
extends BasicTGLogFormatter

A HumanReadableTGFormatter 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 column will be blank. Output from this formatter will consist of columns for the absolute time and size in bytes (in that order) of packets sent, plus a header including the date and time on which logging began. This formatter extends the BasicTGLogFormatter and just adds a header to the file. The formatted log records themselves are exactly the same as in BasicTGLogFormatter.

Author:

Kira Lindburg

Constructor Summary

Constructors

Constructor and Description
HumanReadableTGLogFormatter()

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.
java.lang.String	getHead(java.util.logging.Handler h)

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

HumanReadableTGLogFormatter

public HumanReadableTGLogFormatter()

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 BasicTGLogFormatter

Returns:

the formatted log record. The returned string includes the absolute time the packet was sent and the size of the packet (if a parameter was provided to the log record).

getHead

public java.lang.String getHead(java.util.logging.Handler h)

Overrides:

getHead in class java.util.logging.Formatter