io.sphere.sdk.client

Interface CorrelationIdGenerator

All Superinterfaces:

Supplier<String>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface CorrelationIdGenerator
extends Supplier<String>

Generates correlation ids for each request. The format of the correlation id is defined as: <projectKey> / <UUID> (/ customId)*

Method Summary

Modifier and Type	Method and Description
String	get() Creates a new correlation id.
static CorrelationIdGenerator	of(String projectKey) Creates a new default correlation id generator for the given project key.

Method Detail

get

String get()

Creates a new correlation id.

Specified by:

get in interface Supplier<String>

Returns:

a new unique correlation id

See Also:

HttpHeaders.X_CORRELATION_ID

of

static CorrelationIdGenerator of(String projectKey)

Creates a new default correlation id generator for the given project key.

Parameters:

projectKey - the project key SphereApiConfig.getProjectKey()

Returns:

the default correlation id provider