com.gurock.smartinspect

Class LogHeader

java.lang.Object

com.gurock.smartinspect.Packet

com.gurock.smartinspect.LogHeader

public class LogHeader
extends Packet

Represents the Log Header packet type which is used for storing and transferring log metadata.

The LogHeader class is used to store and transfer log metadata. After the PipeProtocol or TcpProtocol has established a connection, a Log Header packet with the metadata of the current logging context is created and written. Log Header packets are used by the SmartInspect Router application for its filter and trigger functionality.

This class is not guaranteed to be threadsafe. However, instances of this class will normally only be used in the context of a single thread.

Field Summary

Fields inherited from class com.gurock.smartinspect.Packet

PACKET_HEADER

Constructor Summary

Constructors

Constructor and Description
LogHeader()

Method Summary

Modifier and Type	Method and Description
String	getAppName() Returns the application name of this Log Header.
String	getContent() Returns the entire content of this Log Header packet.
String	getHostName() Returns the hostname of this Log Header.
PacketType	getPacketType() Overridden.
int	getSize() Overridden.
void	setAppName(String appName) Sets the application name of this Log Header.
void	setHostName(String hostName) Sets the hostname of this Log Header.

Methods inherited from class com.gurock.smartinspect.Packet

getBytes, getLevel, getStringSize, getThreadId, isThreadSafe, lock, setBytes, setLevel, setThreadSafe, unlock

Methods inherited from class java.lang.Object

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

Constructor Detail

LogHeader

public LogHeader()

Method Detail

getSize

public int getSize()

Overridden. Returns the total occupied memory size of this Log Header packet. The total occupied memory size of this Log Header is the size of memory occupied by all strings and any internal data structures of this Log Header.

Specified by:

getSize in class Packet

Returns:

The total occupied memory size of this Log Header

getPacketType

public PacketType getPacketType()

Overridden. Returns PacketType.LogHeader.

Specified by:

getPacketType in class Packet

Returns:

Just PacketType.LogHeader. For a complete list of available packet types, please have a look at the documentation of the PacketType type

getContent

public String getContent()

Returns the entire content of this Log Header packet. The content of a Log Header packet is a key-value (syntax: key=value) list of the properties of this Log Header packet (currently only the getAppName and the getHostName strings). Key-value pairs are separated by carriage return and newline characters.

Returns:

The entire content of this Log Header packet

getHostName

public String getHostName()

Returns the hostname of this Log Header. The hostname of a Log Header is usually set to the name of the machine this Log Entry is sent from. This method can return null if this Log Header does not contain a hostname.

Returns:

The hostname of the Log Header or null if the hostname has not been set

setHostName

public void setHostName(String hostName)

Sets the hostname of this Log Header.

Parameters:

hostName - The new hostname of this Log Header. Can be null

getAppName

public String getAppName()

Returns the application name of this Log Header.

The application name of a Log Header is usually set to the name of the application this Log Header is created in. This method can return null if this Log Header does not contain an application name.

Returns:

The application name of the Log Header or null if the application name has not been set

setAppName

public void setAppName(String appName)

Sets the application name of this Log Header.

Parameters:

appName - The new application name of this Log Header. Can be null