Package com.github.kristofa.brave

Class IdConversion

java.lang.Object

com.github.kristofa.brave.IdConversion

public class IdConversion
extends java.lang.Object

Contains conversion utilities for converting trace and span ids from long to string and vice versa.

The string representation is used when transferring trace context from client to server as http headers.

This implementation is expected to be compatible with Zipkin. This is important in case you mix brave services with zipkin / finagle services.

The only difference between the zipkin implementation and this implementation is that zipkin prepends '0' characters in case String does not contain 16 characters. For example instead of generating String "0" for long id 0 it generates "0000000000000000". But zipkin will properly convert String representations in case they are not prepended with 0's.

Author:

kristof

Constructor Summary

Constructors

Constructor	Description
IdConversion()

Method Summary

Modifier and Type	Method	Description
static long	convertToLong(java.lang.String lowerHex)	Parses a 1 to 32 character lower-hex string with no prefix into an unsigned long, tossing any bits higher than 64.
static long	convertToLong(java.lang.String lowerHex, int index)	Parses a 16 character lower-hex string with no prefix into an unsigned long, starting at the specified index.
static java.lang.String	convertToString(long id)	Converts long trace or span id to String.
static long	lenientConvertToLong(java.lang.String lowerHex, int index, int endIndex)	Like convertToLong(String, int), but returns zero on invalid input

Methods inherited from class java.lang.Object

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

Constructor Detail

IdConversion

public IdConversion()

Method Detail

convertToString

public static java.lang.String convertToString(long id)

Converts long trace or span id to String.

Parameters:

id - trace, span or parent span id.

Returns:

String representation.

convertToLong

public static long convertToLong(java.lang.String lowerHex)

Parses a 1 to 32 character lower-hex string with no prefix into an unsigned long, tossing any bits higher than 64.

convertToLong

public static long convertToLong(java.lang.String lowerHex,
                                 int index)

Parses a 16 character lower-hex string with no prefix into an unsigned long, starting at the specified index.

lenientConvertToLong

public static long lenientConvertToLong(java.lang.String lowerHex,
                                        int index,
                                        int endIndex)

Like convertToLong(String, int), but returns zero on invalid input