Package kieker.common.record.flow.trace

Class ApplicationTraceMetadata

java.lang.Object

kieker.common.record.AbstractMonitoringRecord

kieker.common.record.flow.trace.TraceMetadata

kieker.common.record.flow.trace.ApplicationTraceMetadata

All Implemented Interfaces:

Serializable, Comparable<IMonitoringRecord>, IFlowRecord, IMonitoringRecord

public class ApplicationTraceMetadata
extends TraceMetadata

Since:

1.14

Author:

Christian Zirkelbach API compatibility: Kieker 1.15.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_NAME	default constants.
static final String	NO_APPLICATION_NAME	user-defined constants.
static final int	SIZE	Descriptive definition of the serialization size of the record.
static final Class<?>[]	TYPES
static final String[]	VALUE_NAMES	property name array.

Fields inherited from class kieker.common.record.flow.trace.TraceMetadata

HOSTNAME, NEXT_ORDER_ID, NO_HOSTNAME, NO_PARENT_ORDER_INDEX, NO_PARENT_TRACEID, NO_SESSION_ID, PARENT_ORDER_ID, PARENT_TRACE_ID, SESSION_ID, THREAD_ID, TRACE_ID

Fields inherited from class kieker.common.record.AbstractMonitoringRecord

TYPE_SIZE_BOOLEAN, TYPE_SIZE_BYTE, TYPE_SIZE_CHARACTER, TYPE_SIZE_DOUBLE, TYPE_SIZE_FLOAT, TYPE_SIZE_INT, TYPE_SIZE_LONG, TYPE_SIZE_SHORT, TYPE_SIZE_STRING

Constructor Summary

Constructors

Constructor	Description
ApplicationTraceMetadata(long traceId, long threadId, String sessionId, String hostname, long parentTraceId, int parentOrderId, String applicationName)	Creates a new instance of this class using the given parameters.
ApplicationTraceMetadata(IValueDeserializer deserializer)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Performs a null-check, a this-check, and a class-check.
final String	getApplicationName()
int	getSize()	This method should deliver the size of a binary representation of this record.
String[]	getValueNames()	This method delivers an array containing the value names of the record.
Class<?>[]	getValueTypes()	This method delivers an array with the classes of the single values for the record.
int	hashCode()
void	serialize(IValueSerializer serializer)	This method serializes this record using the given serializer.
String	toString()	Creates a string representation of this record. This method should not be used for serialization purposes since this is not the purpose of Object's toString method.

Methods inherited from class kieker.common.record.flow.trace.TraceMetadata

getHostname, getNextOrderId, getParentOrderId, getParentTraceId, getSessionId, getThreadId, getTraceId, setTraceId

Methods inherited from class kieker.common.record.AbstractMonitoringRecord

checkArray, classForName, compareTo, createFromDeserializer, fromStringArrayToTypedArray2, getLoggingTimestamp, isNotEqual, isNotEqual, setLoggingTimestamp, typesForClass

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface kieker.common.record.IMonitoringRecord

getLoggingTimestamp, setLoggingTimestamp

Field Details

SIZE

public static final int SIZE

Descriptive definition of the serialization size of the record.

See Also:

• Constant Field Values

TYPES

public static final Class<?>[] TYPES

NO_APPLICATION_NAME

public static final String NO_APPLICATION_NAME

user-defined constants.

See Also:

• Constant Field Values

VALUE_NAMES

public static final String[] VALUE_NAMES

property name array.

APPLICATION_NAME

public static final String APPLICATION_NAME

default constants.

See Also:

• Constant Field Values

Constructor Details

ApplicationTraceMetadata

public ApplicationTraceMetadata(long traceId,
 long threadId,
 String sessionId,
 String hostname,
 long parentTraceId,
 int parentOrderId,
 String applicationName)

Creates a new instance of this class using the given parameters.

Parameters:

traceId - traceId

threadId - threadId

sessionId - sessionId

hostname - hostname

parentTraceId - parentTraceId

parentOrderId - parentOrderId

applicationName - applicationName

ApplicationTraceMetadata

public ApplicationTraceMetadata(IValueDeserializer deserializer)
                         throws RecordInstantiationException

Parameters:

deserializer - The deserializer to use

Throws:

RecordInstantiationException - when the record could not be deserialized

Method Details

serialize

public void serialize(IValueSerializer serializer)
               throws BufferOverflowException

This method serializes this record using the given serializer.

Specified by:

serialize in interface IMonitoringRecord

Overrides:

serialize in class TraceMetadata

Parameters:

serializer - The serializer to serialize the record with. *

Throws:

BufferOverflowException - If the underlying buffer has insufficient capacity to store this record

getValueTypes

public Class<?>[] getValueTypes()

This method delivers an array with the classes of the single values for the record.

Specified by:

getValueTypes in interface IMonitoringRecord

Overrides:

getValueTypes in class TraceMetadata

Returns:

The types of the values. This returned array should be treated readonly.

getValueNames

public String[] getValueNames()

This method delivers an array containing the value names of the record.

Specified by:

getValueNames in interface IMonitoringRecord

Overrides:

getValueNames in class TraceMetadata

Returns:

The types of the values. This returned array should be treated readonly.

getSize

public int getSize()

This method should deliver the size of a binary representation of this record.

Specified by:

getSize in interface IMonitoringRecord

Overrides:

getSize in class TraceMetadata

Returns:

The size.

equals

public boolean equals(Object obj)

Performs a null-check, a this-check, and a class-check. Moreover, it checks each attribute for equality.

Overrides:

equals in class TraceMetadata

hashCode

public int hashCode()

Overrides:

hashCode in class TraceMetadata

getApplicationName

public final String getApplicationName()

toString

public String toString()

Creates a string representation of this record.

This method should not be used for serialization purposes since this is not the purpose of Object's toString method.

Specified by:

toString in interface IMonitoringRecord

Overrides:

toString in class TraceMetadata

Returns:

A (human readable) string of this record.