kieker.common.record.flow.trace

Class TraceMetadata

java.lang.Object

kieker.common.record.AbstractMonitoringRecord

kieker.common.record.flow.trace.TraceMetadata

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IMonitoringRecord>, IFlowRecord, IMonitoringRecord, IMonitoringRecord.BinaryFactory, IMonitoringRecord.Factory

public class TraceMetadata
extends AbstractMonitoringRecord
implements IMonitoringRecord.Factory, IMonitoringRecord.BinaryFactory, IFlowRecord

Since:

1.5

Author:

Jan Waller API compatibility: Kieker 1.13.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface kieker.common.record.IMonitoringRecord

IMonitoringRecord.BinaryFactory, IMonitoringRecord.Factory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HOSTNAME
static int	NEXT_ORDER_ID
static java.lang.String	NO_HOSTNAME
static int	NO_PARENT_ORDER_INDEX
static long	NO_PARENT_TRACEID user-defined constants.
static java.lang.String	NO_SESSION_ID
static int	PARENT_ORDER_ID
static long	PARENT_TRACE_ID
static java.lang.String	SESSION_ID
static int	SIZE Descriptive definition of the serialization size of the record.
static long	THREAD_ID
static long	TRACE_ID default constants.
static java.lang.Class<?>[]	TYPES

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

Modifier	Constructor and Description
	TraceMetadata(IValueDeserializer deserializer)
	TraceMetadata(long traceId, long threadId, java.lang.String sessionId, java.lang.String hostname, long parentTraceId, int parentOrderId) Creates a new instance of this class using the given parameters.
	TraceMetadata(java.lang.Object[] values) Deprecated. since 1.13. Use TraceMetadata(IValueDeserializer) instead.
protected	TraceMetadata(java.lang.Object[] values, java.lang.Class<?>[] valueTypes) Deprecated. since 1.13. Use TraceMetadata(IValueDeserializer) instead.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Performs a null-check, a this-check, and a class-check.
java.lang.String	getHostname()
int	getNextOrderId()
int	getParentOrderId()
long	getParentTraceId()
java.lang.String	getSessionId()
int	getSize() This method should deliver the size of a binary representation of this record.
long	getThreadId()
long	getTraceId()
java.lang.String[]	getValueNames() This method delivers an array containing the value names of the record.
java.lang.Class<?>[]	getValueTypes() This method delivers an array with the classes of the single values for the record.
void	initFromArray(java.lang.Object[] values) Deprecated. This record uses the IMonitoringRecord.Factory mechanism. Hence, this method is not implemented.
void	registerStrings(IRegistry<java.lang.String> stringRegistry) Registers the string attributes of the record at the given stringRegistry.
void	serialize(IValueSerializer serializer) This method serializes this record using the given serializer.
void	setTraceId(long traceId)
java.lang.Object[]	toArray() Deprecated. since 1.13. Use serialize(IValueSerializer) with an array serializer instead.

Methods inherited from class kieker.common.record.AbstractMonitoringRecord

checkArray, classForName, compareTo, createFromArray, createFromArray, createFromDeserializer, createFromStringArray, fromStringArrayToTypedArray, getLoggingTimestamp, hashCode, isNotEqual, isNotEqual, setLoggingTimestamp, toString, typesForClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface kieker.common.record.IMonitoringRecord

getLoggingTimestamp, setLoggingTimestamp, toString

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

SIZE

public static final int SIZE

Descriptive definition of the serialization size of the record.

See Also:

Constant Field Values

TYPES

public static final java.lang.Class<?>[] TYPES

NO_PARENT_TRACEID

public static final long NO_PARENT_TRACEID

user-defined constants.

See Also:

Constant Field Values

NO_PARENT_ORDER_INDEX

public static final int NO_PARENT_ORDER_INDEX

See Also:

Constant Field Values

NO_SESSION_ID

public static final java.lang.String NO_SESSION_ID

See Also:

Constant Field Values

NO_HOSTNAME

public static final java.lang.String NO_HOSTNAME

See Also:

Constant Field Values

TRACE_ID

public static final long TRACE_ID

default constants.

See Also:

Constant Field Values

THREAD_ID

public static final long THREAD_ID

See Also:

Constant Field Values

SESSION_ID

public static final java.lang.String SESSION_ID

See Also:

Constant Field Values

HOSTNAME

public static final java.lang.String HOSTNAME

See Also:

Constant Field Values

PARENT_TRACE_ID

public static final long PARENT_TRACE_ID

See Also:

Constant Field Values

PARENT_ORDER_ID

public static final int PARENT_ORDER_ID

See Also:

Constant Field Values

NEXT_ORDER_ID

public static final int NEXT_ORDER_ID

See Also:

Constant Field Values

Constructor Detail

TraceMetadata

public TraceMetadata(long traceId,
             long threadId,
             java.lang.String sessionId,
             java.lang.String hostname,
             long parentTraceId,
             int parentOrderId)

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

Parameters:

traceId - traceId

threadId - threadId

sessionId - sessionId

hostname - hostname

parentTraceId - parentTraceId

parentOrderId - parentOrderId

TraceMetadata

@Deprecated
public TraceMetadata(java.lang.Object[] values)

Deprecated. since 1.13. Use TraceMetadata(IValueDeserializer) instead.

This constructor converts the given array into a record. It is recommended to use the array which is the result of a call to toArray().

Parameters:

values - The values for the record.

TraceMetadata

@Deprecated
protected TraceMetadata(java.lang.Object[] values,
                        java.lang.Class<?>[] valueTypes)

Deprecated. since 1.13. Use TraceMetadata(IValueDeserializer) instead.

This constructor uses the given array to initialize the fields of this record.

Parameters:

values - The values for the record.

valueTypes - The types of the elements in the first array.

TraceMetadata

public TraceMetadata(IValueDeserializer deserializer)

Parameters:

deserializer - The deserializer to use

Method Detail

toArray

@Deprecated
public java.lang.Object[] toArray()

Deprecated. since 1.13. Use serialize(IValueSerializer) with an array serializer instead.

This method should deliver an array containing the content of the record. It should be possible to convert this array later into a record again.

Specified by:

toArray in interface IMonitoringRecord

Returns:

An array with the values of the record.

registerStrings

public void registerStrings(IRegistry<java.lang.String> stringRegistry)

Registers the string attributes of the record at the given stringRegistry.

Specified by:

registerStrings in interface IMonitoringRecord

serialize

public void serialize(IValueSerializer serializer)
               throws java.nio.BufferOverflowException

This method serializes this record using the given serializer.

Specified by:

serialize in interface IMonitoringRecord

Parameters:

serializer - The serializer to serialize the record with. *

Throws:

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

getValueTypes

public java.lang.Class<?>[] getValueTypes()

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

Specified by:

getValueTypes in interface IMonitoringRecord

Returns:

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

See Also:

IMonitoringRecord.toArray()

getValueNames

public java.lang.String[] getValueNames()

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

Specified by:

getValueNames in interface IMonitoringRecord

Returns:

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

See Also:

IMonitoringRecord.toArray()

getSize

public int getSize()

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

Specified by:

getSize in interface IMonitoringRecord

Returns:

The size.

initFromArray

@Deprecated
public void initFromArray(java.lang.Object[] values)

Deprecated. This record uses the IMonitoringRecord.Factory mechanism. Hence, this method is not implemented.

This method should initialize the record based on the given values. The array should be one of those resulting from a call to IMonitoringRecord.toArray().

Specified by:

initFromArray in interface IMonitoringRecord

Parameters:

values - The values for the record.

equals

public boolean equals(java.lang.Object obj)

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

Overrides:

equals in class AbstractMonitoringRecord

getTraceId

public final long getTraceId()

setTraceId

public final void setTraceId(long traceId)

getThreadId

public final long getThreadId()

getSessionId

public final java.lang.String getSessionId()

getHostname

public final java.lang.String getHostname()

getParentTraceId

public final long getParentTraceId()

getParentOrderId

public final int getParentOrderId()

getNextOrderId

public final int getNextOrderId()