io.deephaven.proto.util.SharedTicketHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of deephaven-proto-backplane-grpc Show documentation

The Deephaven proto-backplane-grpc

There is a newer version: 0.36.1

Show newest version

//
// Copyright (c) 2016-2024 Deephaven Data Labs and Patent Pending
//
package io.deephaven.proto.util;

import org.apache.commons.codec.binary.Hex;

import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.List;

public class SharedTicketHelper {
    public static final char TICKET_PREFIX = 'h';
    public static final String FLIGHT_DESCRIPTOR_ROUTE = "shared";

    /**
     * Convenience method to create the flight descriptor path for the given shared identifier.
     *
     * @param sharedId the shared identifier
     * @return the path
     */
    public static List idToPath(byte[] sharedId) {
        return Arrays.asList(FLIGHT_DESCRIPTOR_ROUTE, Hex.encodeHexString(sharedId));
    }

    /**
     * Convenience method to create the flight ticket bytes for the given shared identifier.
     *
     * @param sharedId the shared identifier
     * @return the ticket bytes
     */
    public static byte[] idToBytes(byte[] sharedId) {
        final byte[] fullTicket = new byte[1 + sharedId.length];
        fullTicket[0] = (byte) TICKET_PREFIX;
        System.arraycopy(sharedId, 0, fullTicket, 1, sharedId.length);
        return fullTicket;
    }

    /**
     * Convenience method to decode the shared ticket bytes into a human-readable description.
     *
     * @param ticket the ticket bytes
     * @return the human-readable description
     */
    public static String toReadableString(final byte[] ticket) {
        if (ticket.length < 2 || ticket[0] != TICKET_PREFIX) {
            throw new IllegalArgumentException(String.format(
                    "Shared ticket does not conform to expected format; found '0x%s'", Hex.encodeHexString(ticket)));
        }
        return String.format("%s/0x%s", FLIGHT_DESCRIPTOR_ROUTE,
                Hex.encodeHexString(ByteBuffer.wrap(ticket, 1, ticket.length - 1)));
    }
}