Package com.sap.cds.services.utils

Class CorrelationIdUtils

java.lang.Object

com.sap.cds.services.utils.CorrelationIdUtils

public class CorrelationIdUtils
extends Object

Utility for retrieving or generating a correlation id.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CORRELATION_ID_FIELD
static final String	CORRELATION_ID_HEADER_KEY
static final String	CORRELATION_ID_HEADER_KEY_ALIAS
static final String	CORRELATION_ID_UNKNOWN

Method Summary

Modifier and Type	Method	Description
static void	clearMDC()	Removes the correlation id field from the MDC.
static String	getCorrelationId(ParameterInfo parameterInfo)	Returns the correlation id if already existing, or null if not.
static String	getFromMDC()	Gets a correlation id value from the MDC, if existing, or null otherwise.
static String	getOrGenerateCorrelationId(ParameterInfo parameterInfo)	Returns the correlation id if already existing, or generates a new one otherwise.
static boolean	mdcHasEntry()	Checks whether there's a correlation id entry in the MDC.
static void	putInMDC(String correlationId)	Puts the provided correlation id into the MDC under the key "correlation_id".

Methods inherited from class java.lang.Object

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

Field Details

CORRELATION_ID_HEADER_KEY

public static final String CORRELATION_ID_HEADER_KEY

See Also:

• Constant Field Values

CORRELATION_ID_HEADER_KEY_ALIAS

public static final String CORRELATION_ID_HEADER_KEY_ALIAS

See Also:

• Constant Field Values

CORRELATION_ID_FIELD

public static final String CORRELATION_ID_FIELD

See Also:

• Constant Field Values

CORRELATION_ID_UNKNOWN

public static final String CORRELATION_ID_UNKNOWN

See Also:

• Constant Field Values

Method Details

mdcHasEntry

public static boolean mdcHasEntry()

Checks whether there's a correlation id entry in the MDC.

Returns:

true, if there's an entry under the key "correlation_id"

putInMDC

public static void putInMDC(String correlationId)

Puts the provided correlation id into the MDC under the key "correlation_id".

Parameters:

correlationId - the correlation id

getFromMDC

public static String getFromMDC()

Gets a correlation id value from the MDC, if existing, or null otherwise.

Returns:

a correlation id

clearMDC

public static void clearMDC()

Removes the correlation id field from the MDC.

getOrGenerateCorrelationId

public static String getOrGenerateCorrelationId(ParameterInfo parameterInfo)

Returns the correlation id if already existing, or generates a new one otherwise.

Tries to retrieve an existing correlation id from a MDC field, or the parameter info headers, in that specific order.

Parameters:

parameterInfo - parameter info to fall back to if correlation id does not exist in MDC

Returns:

a correlation id

getCorrelationId

public static String getCorrelationId(ParameterInfo parameterInfo)

Returns the correlation id if already existing, or null if not.

Parameters:

parameterInfo - parameter info to fall back to if correlation id does not exist in MDC, nullable

Returns:

a correlation id