Module org.elasticsearch.server

Package org.elasticsearch.common

Class UUIDs

java.lang.Object

org.elasticsearch.common.UUIDs

public class UUIDs
extends Object

Utility class for generating various types of UUIDs.

Field Summary

Fields

Modifier and Type	Field	Description
static final Supplier<byte[]>	DEFAULT_MAC_ADDRESS_SUPPLIER
static final Supplier<Integer>	DEFAULT_SEQUENCE_ID_SUPPLIER
static final Supplier<Long>	DEFAULT_TIMESTAMP_SUPPLIER
static final int	RANDOM_BASED_UUID_STRING_LENGTH	The length of a UUID string generated by randomBase64UUID(java.util.Random) and randomBase64UUIDSecureString().
static final int	TIME_BASED_UUID_STRING_LENGTH	The length of a UUID string generated by base64UUID().

Constructor Summary

Constructors

Constructor	Description
UUIDs()

Method Summary

Modifier and Type	Method	Description
static String	base64TimeBasedKOrderedUUIDWithHash(OptionalInt hash)
static String	base64UUID()	Generates a time-based UUID (similar to Flake IDs), which is preferred when generating an ID to be indexed into a Lucene index as primary key.
static String	randomBase64UUID()	Returns a Base64 encoded string representing a RFC4122 version 4 UUID, using a private SecureRandom instance.
static String	randomBase64UUID(Random random)	Returns a Base64 encoded string representing a RFC4122 version 4 UUID, using the provided Random instance.
static SecureString	randomBase64UUIDSecureString()	Returns a Base64 encoded SecureString representing a RFC4122 version 4 UUID, using a private SecureRandom instance.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TIMESTAMP_SUPPLIER

public static final Supplier<Long> DEFAULT_TIMESTAMP_SUPPLIER

DEFAULT_SEQUENCE_ID_SUPPLIER

public static final Supplier<Integer> DEFAULT_SEQUENCE_ID_SUPPLIER

DEFAULT_MAC_ADDRESS_SUPPLIER

public static final Supplier<byte[]> DEFAULT_MAC_ADDRESS_SUPPLIER

TIME_BASED_UUID_STRING_LENGTH

public static final int TIME_BASED_UUID_STRING_LENGTH

The length of a UUID string generated by base64UUID().

See Also:

• Constant Field Values

RANDOM_BASED_UUID_STRING_LENGTH

public static final int RANDOM_BASED_UUID_STRING_LENGTH

The length of a UUID string generated by randomBase64UUID(java.util.Random) and randomBase64UUIDSecureString().

See Also:

• Constant Field Values

Constructor Details

UUIDs

public UUIDs()

Method Details

base64UUID

public static String base64UUID()

Generates a time-based UUID (similar to Flake IDs), which is preferred when generating an ID to be indexed into a Lucene index as primary key. The id is opaque and the implementation is free to change at any time! The resulting string has length TIME_BASED_UUID_STRING_LENGTH.

base64TimeBasedKOrderedUUIDWithHash

public static String base64TimeBasedKOrderedUUIDWithHash(OptionalInt hash)

randomBase64UUID

public static String randomBase64UUID(Random random)

Returns a Base64 encoded string representing a RFC4122 version 4 UUID, using the provided Random instance. The resulting string has length RANDOM_BASED_UUID_STRING_LENGTH.

randomBase64UUID

public static String randomBase64UUID()

Returns a Base64 encoded string representing a RFC4122 version 4 UUID, using a private SecureRandom instance. The resulting string has length RANDOM_BASED_UUID_STRING_LENGTH.

randomBase64UUIDSecureString

public static SecureString randomBase64UUIDSecureString()

Returns a Base64 encoded SecureString representing a RFC4122 version 4 UUID, using a private SecureRandom instance. The resulting string has length RANDOM_BASED_UUID_STRING_LENGTH.