com.amazonaws.services.kinesis.leases.impl.HashKeyRangeForLease Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of amazon-kinesis-client Show documentation

The Amazon Kinesis Client Library for Java enables Java developers to easily consume and process data from Amazon Kinesis.

There is a newer version: 1.15.2

Show newest version

/*
 * Copyright 2019 Amazon.com, Inc. or its affiliates.
 * 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.amazonaws.services.kinesis.leases.impl;

import com.amazonaws.services.kinesis.model.HashKeyRange;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import lombok.NonNull;
import lombok.Value;
import lombok.experimental.Accessors;
import org.apache.commons.lang3.Validate;

import java.math.BigInteger;

@Value
@Accessors(fluent = true)
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY)
/**
 * Lease POJO to hold the starting hashkey range and ending hashkey range of kinesis shards.
 */
public class HashKeyRangeForLease {

    private final BigInteger startingHashKey;
    private final BigInteger endingHashKey;

    /**
     * Serialize the startingHashKey for persisting in external storage
     *
     * @return Serialized startingHashKey
     */
    public String serializedStartingHashKey() {
        return startingHashKey.toString();
    }

    /**
     * Serialize the endingHashKey for persisting in external storage
     *
     * @return Serialized endingHashKey
     */
    public String serializedEndingHashKey() {
        return endingHashKey.toString();
    }

    /**
     * Deserialize from serialized hashKeyRange string from external storage.
     *
     * @param startingHashKeyStr
     * @param endingHashKeyStr
     * @return HashKeyRangeForLease
     */
    public static HashKeyRangeForLease deserialize(@NonNull String startingHashKeyStr, @NonNull String endingHashKeyStr) {
        final BigInteger startingHashKey = new BigInteger(startingHashKeyStr);
        final BigInteger endingHashKey = new BigInteger(endingHashKeyStr);
        Validate.isTrue(startingHashKey.compareTo(endingHashKey) < 0,
                "StartingHashKey %s must be less than EndingHashKey %s ", startingHashKeyStr, endingHashKeyStr);
        return new HashKeyRangeForLease(startingHashKey, endingHashKey);
    }

    /**
     * Construct HashKeyRangeForLease from Kinesis HashKeyRange
     *
     * @param hashKeyRange
     * @return HashKeyRangeForLease
     */
    public static HashKeyRangeForLease fromHashKeyRange(HashKeyRange hashKeyRange) {
        return deserialize(hashKeyRange.getStartingHashKey(), hashKeyRange.getEndingHashKey());
    }
}