com.netflix.astyanax.util.TimeUUIDUtils Maven / Gradle / Ivy
/*******************************************************************************
* Copyright 2011 Netflix
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
******************************************************************************/
package com.netflix.astyanax.util;
import java.nio.ByteBuffer;
import java.util.UUID;
import com.eaio.uuid.UUIDGen;
import com.netflix.astyanax.Clock;
import com.netflix.astyanax.clock.MicrosecondsSyncClock;
/**
* Utilitary class to generate TimeUUID (type 1)
*
* @author Patricio Echague ([email protected])
*
*/
public final class TimeUUIDUtils {
static final long NUM_100NS_INTERVALS_SINCE_UUID_EPOCH = 0x01b21dd213814000L;
static final Clock microsClock = new MicrosecondsSyncClock();
/**
* Gets a new and unique time uuid in milliseconds. It is useful to use in a
* TimeUUIDType sorted column family.
*
* @return the time uuid
*/
public static java.util.UUID getUniqueTimeUUIDinMillis() {
return new java.util.UUID(UUIDGen.newTime(), UUIDGen.getClockSeqAndNode());
}
public static java.util.UUID getUniqueTimeUUIDinMicros() {
return new java.util.UUID(createTimeFromMicros(microsClock.getCurrentTime()), UUIDGen.getClockSeqAndNode());
}
/**
* Gets a new time uuid using {@link ClockResolution#createClock()} as a
* time generator. It is useful to use in a TimeUUIDType sorted column
* family.
*
* @param clock
* a ClockResolution
* @return the time uuid
*/
public static java.util.UUID getTimeUUID(Clock clock) {
return getTimeUUID(clock.getCurrentTime());
}
/**
* Gets a new time uuid based on time.
* NOTE: this algorithm does not resolve duplicates. To avoid duplicates use
* {@link getTimeUUID(ClockResolution clock)} with an implementaion that provides unique timestamp resolution, like
* {@link MicrosecondsSyncClockResolution}
* It is useful to use in a TimeUUIDType sorted column family.
*
* @param clock
* a ClockResolution
* @return the time uuid
*/
public static java.util.UUID getTimeUUID(long time) {
return new java.util.UUID(createTime(time), UUIDGen.getClockSeqAndNode());
}
public static java.util.UUID getMicrosTimeUUID(long time) {
return new java.util.UUID(createTimeFromMicros(time), UUIDGen.getClockSeqAndNode());
}
private static long createTime(long currentTime) {
long time;
// UTC time
long timeToUse = (currentTime * 10000) + NUM_100NS_INTERVALS_SINCE_UUID_EPOCH;
// time low
time = timeToUse << 32;
// time mid
time |= (timeToUse & 0xFFFF00000000L) >> 16;
// time hi and version
time |= 0x1000 | ((timeToUse >> 48) & 0x0FFF); // version 1
return time;
}
private static long createTimeFromMicros(long currentTime) {
long time;
// UTC time
long timeToUse = (currentTime * 10) + NUM_100NS_INTERVALS_SINCE_UUID_EPOCH;
// time low
time = timeToUse << 32;
// time mid
time |= (timeToUse & 0xFFFF00000000L) >> 16;
// time hi and version
time |= 0x1000 | ((timeToUse >> 48) & 0x0FFF); // version 1
return time;
}
/**
* Returns an instance of uuid. Useful for when you read out of cassandra
* you are getting a byte[] that needs to be converted into a TimeUUID.
*
* @param uuid
* the uuid
* @return the java.util.uuid
*/
public static java.util.UUID toUUID(byte[] uuid) {
return uuid(uuid, 0);
}
/**
* Retrieves the time as long based on the byte[] representation of a UUID.
*
* @param uuid
* byte[] uuid representation
* @return a long representing the time
*/
public static long getTimeFromUUID(byte[] uuid) {
return getTimeFromUUID(TimeUUIDUtils.toUUID(uuid));
}
public static long getTimeFromUUID(UUID uuid) {
return (uuid.timestamp() - NUM_100NS_INTERVALS_SINCE_UUID_EPOCH) / 10000;
}
public static long getMicrosTimeFromUUID(UUID uuid) {
return (uuid.timestamp() - NUM_100NS_INTERVALS_SINCE_UUID_EPOCH) / 10;
}
/**
* As byte array. This method is often used in conjunction with @link
* {@link #getTimeUUID()}
*
* @param uuid
* the uuid
*
* @return the byte[]
*/
public static byte[] asByteArray(java.util.UUID uuid) {
long msb = uuid.getMostSignificantBits();
long lsb = uuid.getLeastSignificantBits();
byte[] buffer = new byte[16];
for (int i = 0; i < 8; i++) {
buffer[i] = (byte) (msb >>> 8 * (7 - i));
}
for (int i = 8; i < 16; i++) {
buffer[i] = (byte) (lsb >>> 8 * (7 - i));
}
return buffer;
}
/**
* Coverts a java.util.UUID into a ByteBuffer.
*
* @param uuid
* a java.util.UUID
* @return a ByteBuffer representaion of the param UUID
*/
public static ByteBuffer asByteBuffer(java.util.UUID uuid) {
if (uuid == null) {
return null;
}
return ByteBuffer.wrap(asByteArray(uuid));
}
public static UUID uuid(byte[] uuid, int offset) {
ByteBuffer bb = ByteBuffer.wrap(uuid, offset, 16);
return new UUID(bb.getLong(), bb.getLong());
}
/**
* Converts a ByteBuffer containing a UUID into a java.util.UUID
*
* @param bb
* a ByteBuffer containing a UUID
* @return a java.util.UUID
*/
public static UUID uuid(ByteBuffer bb) {
bb = bb.slice();
return new UUID(bb.getLong(), bb.getLong());
}
}