com.yahoo.vespa.hosted.controller.api.integration.dns.WeightedDirectTarget Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of controller-api Show documentation

There is a newer version: 8.253.3

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.api.integration.dns;

import com.yahoo.config.provision.zone.ZoneId;

import java.util.Objects;

/**
 * An implementation of {@link DirectTarget} where is requests are answered based on the weight assigned to the
 * record, as a proportion of the total weight for all records having the same DNS name.
 * 
 * The portion of received traffic is calculated as follows: (record weight / sum of the weights of all records).
 *
 * @author freva
 */
public final class WeightedDirectTarget extends DirectTarget {

    static final String TARGET_TYPE = "weighted";

    private final long weight;

    public WeightedDirectTarget(RecordData recordData,  ZoneId zone, long weight) {
        super(recordData, zone.value());
        this.weight = weight;
        if (weight < 0) throw new IllegalArgumentException("Weight cannot be negative");
    }

    /** The weight of this target */
    public long weight() {
        return weight;
    }

    @Override
    public RecordData pack() {
        return RecordData.from(String.join("/", TARGET_TYPE, recordData().asString(), id(), Long.toString(weight)));
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        if (!super.equals(o)) return false;
        WeightedDirectTarget that = (WeightedDirectTarget) o;
        return weight == that.weight;
    }

    @Override
    public int hashCode() {
        return Objects.hash(super.hashCode(), weight);
    }

    @Override
    public String toString() {
        return "weighted target for " + recordData() + "[id=" + id() + ",weight=" + weight + "]";
    }

    /** Unpack weighted alias from given record data */
    public static WeightedDirectTarget unpack(RecordData data) {
        var parts = data.asString().split("/");
        if (parts.length != 4) {
            throw new IllegalArgumentException("Expected data to be on format target-type/record-data/zone-id/weight, " +
                                               "but got " + data.asString());
        }
        if (!TARGET_TYPE.equals(parts[0])) {
            throw new IllegalArgumentException("Unexpected type '" + parts[0] + "'");
        }
        return new WeightedDirectTarget(RecordData.from(parts[1]), ZoneId.from(parts[2]), Long.parseLong(parts[3]));
    }

}